1
0

httplib.h 844 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.66.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x004200"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. // How much of an unread request body the server skips to reuse the connection,
  113. // 0 for no limit
  114. #ifndef CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH
  115. #define CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH (256 * 1024) // 256KB
  116. #endif
  117. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  118. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  119. #endif
  120. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  121. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  124. // 1400 rather than a round number: a body that already fits in one 1500-byte
  125. // MTU gains nothing from being made smaller.
  126. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  127. #endif
  128. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  129. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  130. #endif
  131. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  132. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  133. #endif
  134. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  135. // recurses roughly once per matched character for quantified patterns such
  136. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  137. // a default ~8MB thread stack that has been observed to take on the order of
  138. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  139. // margin below that (well under the 8192-byte request URI limit) while still
  140. // fitting any realistic route segment; raise it if a route legitimately needs
  141. // longer paths. Regex routes are never applied to paths longer than this.
  142. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  143. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  144. #endif
  145. #ifndef CPPHTTPLIB_TCP_NODELAY
  146. #define CPPHTTPLIB_TCP_NODELAY false
  147. #endif
  148. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  149. #define CPPHTTPLIB_IPV6_V6ONLY false
  150. #endif
  151. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  152. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  153. #endif
  154. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  155. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  156. #endif
  157. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  158. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  159. #endif
  160. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  161. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  162. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  163. ? std::thread::hardware_concurrency() - 1 \
  164. : 0))
  165. #endif
  166. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  167. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  168. #endif
  169. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  170. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  171. #endif
  172. #ifndef CPPHTTPLIB_RECV_FLAGS
  173. #define CPPHTTPLIB_RECV_FLAGS 0
  174. #endif
  175. #ifndef CPPHTTPLIB_SEND_FLAGS
  176. #define CPPHTTPLIB_SEND_FLAGS 0
  177. #endif
  178. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  179. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  180. #endif
  181. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  182. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  183. #endif
  184. // These bound the parsing of every request, so 0 cannot lift them.
  185. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  186. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  187. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  188. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  189. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  190. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  191. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  192. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  193. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  194. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  195. #endif
  196. // One macro used to set the read timeout for both sides. They want different
  197. // defaults: a client's read timeout is the caller's own tool (it waits forever
  198. // until asked not to), while a server keeps a ceiling that reclaims a worker
  199. // from a peer that has gone quiet. The old name still works and sets both.
  200. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  201. #pragma message( \
  202. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  203. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  204. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  207. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  208. #endif
  209. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  210. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  211. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  212. #endif
  213. #endif
  214. // 0 waits forever. A read timeout is how a caller gets control back to send on
  215. // the same connection; it is not a liveness check (that is ping/pong). Only a
  216. // timeout set at runtime through set_read_timeout() is reported as
  217. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  218. // ws::Fail and closes the connection.
  219. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  220. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  221. #endif
  222. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  223. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  224. #endif
  225. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  226. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  227. #endif
  228. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  229. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  230. #endif
  231. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  232. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  233. #endif
  234. /*
  235. * Headers
  236. */
  237. #ifdef _WIN32
  238. #ifndef _CRT_SECURE_NO_WARNINGS
  239. #define _CRT_SECURE_NO_WARNINGS
  240. #endif //_CRT_SECURE_NO_WARNINGS
  241. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  242. #define _CRT_NONSTDC_NO_DEPRECATE
  243. #endif //_CRT_NONSTDC_NO_DEPRECATE
  244. #if defined(_MSC_VER)
  245. #if _MSC_VER < 1900
  246. #error Sorry, Visual Studio versions prior to 2015 are not supported
  247. #endif
  248. #pragma comment(lib, "ws2_32.lib")
  249. #ifndef _SSIZE_T_DEFINED
  250. using ssize_t = __int64;
  251. #define _SSIZE_T_DEFINED
  252. #endif
  253. #endif // _MSC_VER
  254. #ifndef S_ISREG
  255. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  256. #endif // S_ISREG
  257. #ifndef S_ISDIR
  258. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  259. #endif // S_ISDIR
  260. #ifndef NOMINMAX
  261. #define NOMINMAX
  262. #endif // NOMINMAX
  263. #include <io.h>
  264. #include <winsock2.h>
  265. #include <ws2tcpip.h>
  266. #if defined(__has_include)
  267. #if __has_include(<afunix.h>)
  268. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  269. #include <afunix.h>
  270. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  271. #endif
  272. #endif
  273. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  274. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  275. #endif
  276. using nfds_t = unsigned long;
  277. using socket_t = SOCKET;
  278. using socklen_t = int;
  279. #else // not _WIN32
  280. #include <arpa/inet.h>
  281. #if !defined(_AIX) && !defined(__MVS__)
  282. #include <ifaddrs.h>
  283. #endif
  284. #ifdef __MVS__
  285. #include <strings.h>
  286. #ifndef NI_MAXHOST
  287. #define NI_MAXHOST 1025
  288. #endif
  289. #endif
  290. #include <net/if.h>
  291. #include <netdb.h>
  292. #include <netinet/in.h>
  293. #ifdef __linux__
  294. #include <resolv.h>
  295. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  296. #endif
  297. #include <csignal>
  298. #include <netinet/tcp.h>
  299. #include <poll.h>
  300. #include <pthread.h>
  301. #include <sys/socket.h>
  302. #include <sys/un.h>
  303. #include <unistd.h>
  304. using socket_t = int;
  305. #ifndef INVALID_SOCKET
  306. #define INVALID_SOCKET (-1)
  307. #endif
  308. #endif //_WIN32
  309. #if defined(__APPLE__)
  310. #include <TargetConditionals.h>
  311. #endif
  312. #include <algorithm>
  313. #include <array>
  314. #include <atomic>
  315. #include <cassert>
  316. #include <chrono>
  317. #include <climits>
  318. #include <condition_variable>
  319. #include <cstdlib>
  320. #include <cstring>
  321. #include <errno.h>
  322. #include <exception>
  323. #include <fcntl.h>
  324. #include <fstream>
  325. #include <functional>
  326. #include <iomanip>
  327. #include <iostream>
  328. #include <iterator>
  329. #include <list>
  330. #include <map>
  331. #include <memory>
  332. #include <mutex>
  333. #include <random>
  334. #include <regex>
  335. #include <set>
  336. #include <sstream>
  337. #include <string>
  338. #include <sys/stat.h>
  339. #include <system_error>
  340. #include <thread>
  341. #include <type_traits>
  342. #include <unordered_map>
  343. #include <unordered_set>
  344. #include <utility>
  345. #include <vector>
  346. // On macOS with a TLS backend, enable Keychain root certificates by default
  347. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  348. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  349. // only; on those platforms the user must provide a CA bundle explicitly.
  350. #if defined(__APPLE__) && defined(__clang__) && \
  351. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  352. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  353. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  354. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  355. #if TARGET_OS_OSX
  356. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  357. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  358. #endif
  359. #endif
  360. #endif
  361. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  362. defined(__APPLE__) && !TARGET_OS_OSX
  363. #error \
  364. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  365. #endif
  366. // On Windows, enable Schannel certificate verification by default
  367. // unless the user explicitly opts out.
  368. #if defined(_WIN32) && \
  369. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  370. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  371. #endif
  372. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  373. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  374. #if TARGET_OS_MAC && defined(__clang__)
  375. #include <CFNetwork/CFHost.h>
  376. #include <CoreFoundation/CoreFoundation.h>
  377. #endif
  378. #endif
  379. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  380. #ifdef _WIN32
  381. #include <wincrypt.h>
  382. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  383. // used
  384. #undef X509_NAME
  385. #undef X509_CERT_PAIR
  386. #undef X509_EXTENSIONS
  387. #undef PKCS7_SIGNER_INFO
  388. #ifdef _MSC_VER
  389. #pragma comment(lib, "crypt32.lib")
  390. #endif
  391. #endif // _WIN32
  392. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  393. #if TARGET_OS_OSX
  394. #include <Security/Security.h>
  395. #endif
  396. #endif
  397. #include <openssl/err.h>
  398. #include <openssl/evp.h>
  399. #include <openssl/rand.h>
  400. #include <openssl/ssl.h>
  401. #include <openssl/x509v3.h>
  402. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  403. #include <openssl/applink.c>
  404. #endif
  405. #include <iostream>
  406. #include <sstream>
  407. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  408. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  409. #error Please use OpenSSL or a current version of BoringSSL
  410. #endif
  411. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  412. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  413. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  414. #endif
  415. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  416. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  417. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  418. // in with this first include group so the version gating below can use it.
  419. #include <mbedtls/error.h>
  420. #include <mbedtls/net_sockets.h>
  421. #include <mbedtls/oid.h>
  422. #include <mbedtls/pk.h>
  423. #include <mbedtls/ssl.h>
  424. #include <mbedtls/version.h>
  425. #include <mbedtls/x509_crt.h>
  426. #if MBEDTLS_VERSION_MAJOR >= 4
  427. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  428. #include <psa/crypto.h>
  429. #else
  430. #include <mbedtls/ctr_drbg.h>
  431. #include <mbedtls/entropy.h>
  432. #include <mbedtls/md5.h>
  433. #include <mbedtls/sha1.h>
  434. #include <mbedtls/sha256.h>
  435. #include <mbedtls/sha512.h>
  436. #endif
  437. #ifdef _WIN32
  438. #include <wincrypt.h>
  439. #ifdef _MSC_VER
  440. #pragma comment(lib, "crypt32.lib")
  441. #endif
  442. #endif // _WIN32
  443. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  444. #if TARGET_OS_OSX
  445. #include <Security/Security.h>
  446. #endif
  447. #endif
  448. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  449. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  450. #if MBEDTLS_VERSION_MAJOR >= 4
  451. #define CPPHTTPLIB_MBEDTLS_V4
  452. #endif
  453. #if MBEDTLS_VERSION_MAJOR >= 3
  454. #define CPPHTTPLIB_MBEDTLS_V3
  455. #endif
  456. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  457. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  458. #include <wolfssl/options.h>
  459. #include <wolfssl/openssl/x509v3.h>
  460. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  461. #ifndef WOLFSSL_GEN_EMAIL
  462. #define WOLFSSL_GEN_EMAIL 1
  463. #endif
  464. #ifndef WOLFSSL_GEN_DNS
  465. #define WOLFSSL_GEN_DNS 2
  466. #endif
  467. #ifndef WOLFSSL_GEN_URI
  468. #define WOLFSSL_GEN_URI 6
  469. #endif
  470. #ifndef WOLFSSL_GEN_IPADD
  471. #define WOLFSSL_GEN_IPADD 7
  472. #endif
  473. #include <wolfssl/ssl.h>
  474. #include <wolfssl/wolfcrypt/hash.h>
  475. #include <wolfssl/wolfcrypt/md5.h>
  476. #include <wolfssl/wolfcrypt/sha256.h>
  477. #include <wolfssl/wolfcrypt/sha512.h>
  478. #ifdef _WIN32
  479. #include <wincrypt.h>
  480. #ifdef _MSC_VER
  481. #pragma comment(lib, "crypt32.lib")
  482. #endif
  483. #endif // _WIN32
  484. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  485. #if TARGET_OS_OSX
  486. #include <Security/Security.h>
  487. #endif
  488. #endif
  489. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  490. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  491. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  492. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  493. #define CPPHTTPLIB_SSL_ENABLED
  494. #endif
  495. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  496. #include <zlib.h>
  497. #endif
  498. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  499. #include <brotli/decode.h>
  500. #include <brotli/encode.h>
  501. #endif
  502. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  503. #include <zstd.h>
  504. #endif
  505. /*
  506. * Declaration
  507. */
  508. namespace httplib {
  509. namespace ws {
  510. class WebSocket;
  511. } // namespace ws
  512. namespace sse {
  513. class SSEClient;
  514. } // namespace sse
  515. namespace detail {
  516. /*
  517. * Backport std::make_unique from C++14.
  518. *
  519. * NOTE: This code came up with the following stackoverflow post:
  520. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  521. *
  522. */
  523. template <class T, class... Args>
  524. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  525. make_unique(Args &&...args) {
  526. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  527. }
  528. template <class T>
  529. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  530. make_unique(std::size_t n) {
  531. typedef typename std::remove_extent<T>::type RT;
  532. return std::unique_ptr<T>(new RT[n]);
  533. }
  534. // Locale-independent ASCII character classification. The <cctype>
  535. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  536. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  537. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  538. // classified without regard to the locale.
  539. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  540. inline bool is_ascii_alpha(char c) {
  541. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  542. }
  543. inline bool is_ascii_alnum(char c) {
  544. return is_ascii_digit(c) || is_ascii_alpha(c);
  545. }
  546. namespace case_ignore {
  547. inline unsigned char to_lower(int c) {
  548. const static unsigned char table[256] = {
  549. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  550. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  551. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  552. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  553. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  554. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  555. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  556. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  557. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  558. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  559. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  560. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  561. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  562. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  563. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  564. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  565. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  566. 255,
  567. };
  568. return table[(unsigned char)(char)c];
  569. }
  570. inline std::string to_lower(const std::string &s) {
  571. std::string result = s;
  572. std::transform(
  573. result.begin(), result.end(), result.begin(),
  574. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  575. return result;
  576. }
  577. inline bool equal(const std::string &a, const std::string &b) {
  578. return a.size() == b.size() &&
  579. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  580. return to_lower(ca) == to_lower(cb);
  581. });
  582. }
  583. // For a literal, without building a std::string from it.
  584. template <size_t N>
  585. inline bool equal(const std::string &a, const char (&b)[N]) {
  586. return a.size() == N - 1 &&
  587. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  588. return to_lower(ca) == to_lower(cb);
  589. });
  590. }
  591. struct equal_to {
  592. bool operator()(const std::string &a, const std::string &b) const {
  593. return equal(a, b);
  594. }
  595. };
  596. struct hash {
  597. size_t operator()(const std::string &key) const {
  598. size_t h = 0;
  599. for (auto c : key) {
  600. // Unsets the 6 high bits of h, therefore no overflow happens
  601. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  602. static_cast<unsigned char>(to_lower(c));
  603. }
  604. return h;
  605. }
  606. };
  607. template <typename T>
  608. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  609. detail::case_ignore::equal_to>;
  610. } // namespace case_ignore
  611. // This is based on
  612. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  613. struct scope_exit {
  614. explicit scope_exit(std::function<void(void)> &&f)
  615. : exit_function(std::move(f)), execute_on_destruction{true} {}
  616. scope_exit(scope_exit &&rhs) noexcept
  617. : exit_function(std::move(rhs.exit_function)),
  618. execute_on_destruction{rhs.execute_on_destruction} {
  619. rhs.release();
  620. }
  621. ~scope_exit() {
  622. if (execute_on_destruction) { this->exit_function(); }
  623. }
  624. void release() { this->execute_on_destruction = false; }
  625. private:
  626. scope_exit(const scope_exit &) = delete;
  627. void operator=(const scope_exit &) = delete;
  628. scope_exit &operator=(scope_exit &&) = delete;
  629. std::function<void(void)> exit_function;
  630. bool execute_on_destruction;
  631. };
  632. // Simple from_chars implementation for integer and double types (C++17
  633. // substitute)
  634. template <typename T> struct from_chars_result {
  635. const char *ptr;
  636. std::errc ec;
  637. };
  638. template <typename T>
  639. inline from_chars_result<T> from_chars(const char *first, const char *last,
  640. T &value, int base = 10) {
  641. value = 0;
  642. const char *p = first;
  643. bool negative = false;
  644. if (p != last && *p == '-') {
  645. negative = true;
  646. ++p;
  647. }
  648. if (p == last) { return {first, std::errc::invalid_argument}; }
  649. auto radix = static_cast<T>(base);
  650. T result = 0;
  651. for (; p != last; ++p) {
  652. char c = *p;
  653. int digit = -1;
  654. if (is_ascii_digit(c)) {
  655. digit = c - '0';
  656. } else if ('a' <= c && c <= 'z') {
  657. digit = c - 'a' + 10;
  658. } else if ('A' <= c && c <= 'Z') {
  659. digit = c - 'A' + 10;
  660. } else {
  661. break;
  662. }
  663. if (digit < 0 || digit >= base) { break; }
  664. auto d = static_cast<T>(digit);
  665. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  666. return {p, std::errc::result_out_of_range};
  667. }
  668. result = result * radix + d;
  669. }
  670. if (p == first || (negative && p == first + 1)) {
  671. return {first, std::errc::invalid_argument};
  672. }
  673. value = negative ? T(0) - result : result;
  674. return {p, std::errc{}};
  675. }
  676. // from_chars for double (hand-written, locale-independent)
  677. //
  678. // The only double consumed by this library is the HTTP quality value, whose
  679. // grammar is (RFC 9110 12.4.2):
  680. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  681. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  682. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  683. // '.' always the decimal separator (std::strtod would instead read it from the
  684. // global C locale, mis-parsing q-values once an embedder calls
  685. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  686. // the result to [0, 1], so inputs outside that range need not be distinguished
  687. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  688. // cases that exponent and wide-range handling would introduce.
  689. inline from_chars_result<double> from_chars(const char *first, const char *last,
  690. double &value) {
  691. value = 0.0;
  692. const char *p = first;
  693. // Each 1eN is exactly representable, so a single final division by the
  694. // matching entry yields a correctly-rounded result.
  695. static const double powers_of_ten[] = {
  696. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  697. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  698. const int max_frac_digits =
  699. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  700. // Accumulate digits into a 64-bit integer and remember how many were
  701. // fractional. Two independent caps keep this bounded and safe:
  702. // * accumulation saturates before mantissa could overflow uint64_t, and
  703. // * frac_digits is capped at max_frac_digits so it is always a valid index
  704. // into powers_of_ten (without this an input like "0.000...0" would never
  705. // grow mantissa, so the saturation cap alone would not bound it).
  706. // Both caps only drop digits far beyond the precision a q-value needs; any
  707. // value they would change is well outside [0, 1] and rejected by the caller.
  708. uint64_t mantissa = 0;
  709. int frac_digits = 0;
  710. bool seen_digit = false;
  711. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  712. auto accumulate = [&](char c) {
  713. if (mantissa <= limit) {
  714. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  715. return true;
  716. }
  717. return false;
  718. };
  719. for (; p != last && is_ascii_digit(*p); ++p) {
  720. seen_digit = true;
  721. accumulate(*p);
  722. }
  723. if (p != last && *p == '.') {
  724. ++p;
  725. for (; p != last && is_ascii_digit(*p); ++p) {
  726. seen_digit = true;
  727. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  728. }
  729. }
  730. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  731. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  732. return {p, std::errc{}};
  733. }
  734. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  735. int &out) {
  736. int val = 0;
  737. auto r = from_chars(s, s + len, val);
  738. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  739. return false;
  740. }
  741. out = val;
  742. return true;
  743. }
  744. inline bool parse_port(const char *s, size_t len, int &port) {
  745. return parse_int_in_range(s, len, 1, 65535, port);
  746. }
  747. inline bool parse_port(const std::string &s, int &port) {
  748. return parse_port(s.data(), s.size(), port);
  749. }
  750. struct UrlComponents {
  751. std::string scheme;
  752. std::string host;
  753. std::string port;
  754. std::string path;
  755. std::string query;
  756. };
  757. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  758. uc = {};
  759. size_t pos = 0;
  760. auto sep = url.find("://");
  761. if (sep != std::string::npos) {
  762. uc.scheme = url.substr(0, sep);
  763. // Scheme must be [a-z]+ only
  764. if (uc.scheme.empty()) { return false; }
  765. for (auto c : uc.scheme) {
  766. if (c < 'a' || c > 'z') { return false; }
  767. }
  768. pos = sep + 3;
  769. } else if (url.compare(0, 2, "//") == 0) {
  770. pos = 2;
  771. }
  772. auto has_authority_prefix = pos > 0;
  773. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  774. url[0] != '?' && url[0] != '#');
  775. if (has_authority) {
  776. // userinfo is not supported, and a backslash that some parsers take for
  777. // '/' would leave them seeing another host than this one.
  778. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  779. return false;
  780. }
  781. if (pos < url.size() && url[pos] == '[') {
  782. auto close = url.find(']', pos);
  783. if (close == std::string::npos) { return false; }
  784. uc.host = url.substr(pos + 1, close - pos - 1);
  785. // IPv6 host must be [a-fA-F0-9:]+ only
  786. if (uc.host.empty()) { return false; }
  787. for (auto c : uc.host) {
  788. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  789. (c >= 'A' && c <= 'F') || c == ':')) {
  790. return false;
  791. }
  792. }
  793. pos = close + 1;
  794. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  795. // path, query or fragment delimiter (or the end of input). Otherwise the
  796. // trailing bytes would be folded into the path while the connection
  797. // still targets the bracketed address.
  798. if (pos < url.size()) {
  799. auto c = url[pos];
  800. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  801. }
  802. } else {
  803. auto end = url.find_first_of(":/?#", pos);
  804. if (end == std::string::npos) { end = url.size(); }
  805. uc.host = url.substr(pos, end - pos);
  806. pos = end;
  807. }
  808. if (pos < url.size() && url[pos] == ':') {
  809. ++pos;
  810. auto end = url.find_first_of("/?#", pos);
  811. if (end == std::string::npos) { end = url.size(); }
  812. uc.port = url.substr(pos, end - pos);
  813. pos = end;
  814. }
  815. // Without :// or //, the entire input must be consumed as host[:port].
  816. // If there is leftover (path, query, etc.), this is not a valid
  817. // host[:port] string — clear and reparse as a plain path.
  818. if (!has_authority_prefix && pos < url.size()) {
  819. uc.host.clear();
  820. uc.port.clear();
  821. pos = 0;
  822. }
  823. }
  824. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  825. auto end = url.find_first_of("?#", pos);
  826. if (end == std::string::npos) { end = url.size(); }
  827. uc.path = url.substr(pos, end - pos);
  828. pos = end;
  829. }
  830. if (pos < url.size() && url[pos] == '?') {
  831. auto end = url.find('#', pos);
  832. if (end == std::string::npos) { end = url.size(); }
  833. uc.query = url.substr(pos, end - pos);
  834. }
  835. return true;
  836. }
  837. // Removes "." and ".." segments from a path that starts with '/' (RFC 3986
  838. // section 5.2.4).
  839. inline std::string remove_dot_segments(const std::string &path) {
  840. std::string out;
  841. size_t i = 0;
  842. while (i < path.size()) {
  843. auto next = (std::min)(path.find('/', i + 1), path.size());
  844. auto segment = path.substr(i + 1, next - i - 1);
  845. auto is_last = next == path.size();
  846. if (segment == "." || segment == "..") {
  847. if (segment == "..") {
  848. out.erase((std::min)(out.rfind('/'), out.size()));
  849. }
  850. if (is_last) { out += '/'; }
  851. } else {
  852. out += '/';
  853. out += segment;
  854. }
  855. i = next;
  856. }
  857. if (out.empty()) { out = "/"; }
  858. return out;
  859. }
  860. // Resolves a relative-path or query-only Location value against the path of
  861. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  862. // references starting with '/' are returned unchanged.
  863. inline std::string resolve_relative_location(const std::string &location,
  864. const std::string &base) {
  865. if (location.empty() || location[0] == '/') { return location; }
  866. // A ':' in the first segment means the value has a scheme.
  867. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  868. // A path starting with "//" would be re-parsed as an authority. Prefix "/."
  869. // (as the URL Standard does); remove_dot_segments strips it later.
  870. auto on_this_host = [](std::string path) -> std::string {
  871. if (path.compare(0, 2, "//") == 0) { path.insert(0, "/."); }
  872. return path;
  873. };
  874. if (location[0] == '#') {
  875. return on_this_host(base.substr(0, base.find('#')) + location);
  876. }
  877. auto base_path = base.substr(0, base.find_first_of("?#"));
  878. if (location[0] == '?') { return on_this_host(base_path + location); }
  879. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  880. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  881. // Remove "." and ".." segments from the merged path.
  882. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  883. return on_this_host(remove_dot_segments(merged.substr(0, path_end)) +
  884. merged.substr(path_end));
  885. }
  886. } // namespace detail
  887. enum class SSLVerifierResponse {
  888. // no decision has been made, use the built-in certificate verifier
  889. NoDecisionMade,
  890. // connection certificate is verified and accepted
  891. CertificateAccepted,
  892. // connection certificate was processed but is rejected
  893. CertificateRejected
  894. };
  895. // System CA loading policy for SSL clients. Auto (the default) loads system
  896. // CA certs only when no custom CA is configured; enable_system_ca() switches
  897. // to an explicit policy.
  898. enum class SystemCAMode { Auto, Enabled, Disabled };
  899. enum StatusCode {
  900. // Information responses
  901. Continue_100 = 100,
  902. SwitchingProtocol_101 = 101,
  903. Processing_102 = 102,
  904. EarlyHints_103 = 103,
  905. // Successful responses
  906. OK_200 = 200,
  907. Created_201 = 201,
  908. Accepted_202 = 202,
  909. NonAuthoritativeInformation_203 = 203,
  910. NoContent_204 = 204,
  911. ResetContent_205 = 205,
  912. PartialContent_206 = 206,
  913. MultiStatus_207 = 207,
  914. AlreadyReported_208 = 208,
  915. IMUsed_226 = 226,
  916. // Redirection messages
  917. MultipleChoices_300 = 300,
  918. MovedPermanently_301 = 301,
  919. Found_302 = 302,
  920. SeeOther_303 = 303,
  921. NotModified_304 = 304,
  922. UseProxy_305 = 305,
  923. unused_306 = 306,
  924. TemporaryRedirect_307 = 307,
  925. PermanentRedirect_308 = 308,
  926. // Client error responses
  927. BadRequest_400 = 400,
  928. Unauthorized_401 = 401,
  929. PaymentRequired_402 = 402,
  930. Forbidden_403 = 403,
  931. NotFound_404 = 404,
  932. MethodNotAllowed_405 = 405,
  933. NotAcceptable_406 = 406,
  934. ProxyAuthenticationRequired_407 = 407,
  935. RequestTimeout_408 = 408,
  936. Conflict_409 = 409,
  937. Gone_410 = 410,
  938. LengthRequired_411 = 411,
  939. PreconditionFailed_412 = 412,
  940. PayloadTooLarge_413 = 413,
  941. UriTooLong_414 = 414,
  942. UnsupportedMediaType_415 = 415,
  943. RangeNotSatisfiable_416 = 416,
  944. ExpectationFailed_417 = 417,
  945. ImATeapot_418 = 418,
  946. MisdirectedRequest_421 = 421,
  947. UnprocessableContent_422 = 422,
  948. Locked_423 = 423,
  949. FailedDependency_424 = 424,
  950. TooEarly_425 = 425,
  951. UpgradeRequired_426 = 426,
  952. PreconditionRequired_428 = 428,
  953. TooManyRequests_429 = 429,
  954. RequestHeaderFieldsTooLarge_431 = 431,
  955. UnavailableForLegalReasons_451 = 451,
  956. // Server error responses
  957. InternalServerError_500 = 500,
  958. NotImplemented_501 = 501,
  959. BadGateway_502 = 502,
  960. ServiceUnavailable_503 = 503,
  961. GatewayTimeout_504 = 504,
  962. HttpVersionNotSupported_505 = 505,
  963. VariantAlsoNegotiates_506 = 506,
  964. InsufficientStorage_507 = 507,
  965. LoopDetected_508 = 508,
  966. NotExtended_510 = 510,
  967. NetworkAuthenticationRequired_511 = 511,
  968. };
  969. namespace detail {
  970. // A multimap that keeps its entries in the order they were inserted.
  971. //
  972. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  973. // fields sharing a field name significant and forbids a proxy from reordering
  974. // them, and a query string's parameters are meaningful in the order the caller
  975. // wrote them. Neither standard container expresses it: std::unordered_multimap
  976. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  977. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  978. // key, which would drop control data such as Host behind whatever else the
  979. // message carries and alphabetise a query string.
  980. //
  981. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  982. // scan, which beats hashing for the handful of entries a message carries
  983. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  984. //
  985. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  986. // Params, whose parameter names are case-sensitive, not.
  987. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  988. public:
  989. using key_type = std::string;
  990. using mapped_type = Mapped;
  991. using value_type = std::pair<std::string, Mapped>;
  992. using size_type = std::size_t;
  993. using difference_type = std::ptrdiff_t;
  994. using reference = value_type &;
  995. using const_reference = const value_type &;
  996. private:
  997. static size_type npos() { return static_cast<size_type>(-1); }
  998. static bool keys_equal(const std::string &a, const std::string &b) {
  999. return KeyEqual()(a, b);
  1000. }
  1001. // Iterating yields every entry in insertion order, but equal_range() and
  1002. // find() have to walk only the entries sharing one key, which are not
  1003. // adjacent. Both are the same iterator type: key_idx_ selects between the
  1004. // two traversals, and since equality compares only the position, an iterator
  1005. // restricted to one key still compares equal to end().
  1006. template <typename V> class iterator_t {
  1007. public:
  1008. using iterator_category = std::bidirectional_iterator_tag;
  1009. using value_type = insertion_ordered_multimap::value_type;
  1010. using difference_type = insertion_ordered_multimap::difference_type;
  1011. using pointer = V *;
  1012. using reference = V &;
  1013. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  1014. template <typename U,
  1015. typename std::enable_if<std::is_convertible<U *, V *>::value,
  1016. int>::type = 0>
  1017. iterator_t(const iterator_t<U> &rhs)
  1018. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1019. key_idx_(rhs.key_idx_) {}
  1020. reference operator*() const { return data_[idx_]; }
  1021. pointer operator->() const { return data_ + idx_; }
  1022. iterator_t &operator++() {
  1023. // Saturating, so that advancing past the last entry of a key stays at
  1024. // end() instead of running off the container.
  1025. if (idx_ >= size_) { return *this; }
  1026. ++idx_;
  1027. if (key_idx_ != npos()) {
  1028. while (idx_ < size_ && !matches(idx_)) {
  1029. ++idx_;
  1030. }
  1031. }
  1032. return *this;
  1033. }
  1034. iterator_t operator++(int) {
  1035. auto tmp = *this;
  1036. ++*this;
  1037. return tmp;
  1038. }
  1039. iterator_t &operator--() {
  1040. if (idx_ == 0) { return *this; }
  1041. --idx_;
  1042. if (key_idx_ != npos()) {
  1043. while (idx_ > 0 && !matches(idx_)) {
  1044. --idx_;
  1045. }
  1046. }
  1047. return *this;
  1048. }
  1049. iterator_t operator--(int) {
  1050. auto tmp = *this;
  1051. --*this;
  1052. return tmp;
  1053. }
  1054. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1055. return idx_ == rhs.idx_;
  1056. }
  1057. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1058. return idx_ != rhs.idx_;
  1059. }
  1060. private:
  1061. friend class insertion_ordered_multimap;
  1062. template <typename> friend class iterator_t;
  1063. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1064. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1065. bool matches(size_type i) const {
  1066. return keys_equal(data_[i].first, data_[key_idx_].first);
  1067. }
  1068. V *data_;
  1069. size_type idx_;
  1070. size_type size_;
  1071. size_type key_idx_;
  1072. };
  1073. public:
  1074. using iterator = iterator_t<value_type>;
  1075. using const_iterator = iterator_t<const value_type>;
  1076. insertion_ordered_multimap() = default;
  1077. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1078. : entries_(il) {}
  1079. template <typename InputIt>
  1080. insertion_ordered_multimap(InputIt first, InputIt last)
  1081. : entries_(first, last) {}
  1082. iterator begin() { return make_iter(0, npos()); }
  1083. iterator end() { return make_iter(entries_.size(), npos()); }
  1084. const_iterator begin() const { return make_citer(0, npos()); }
  1085. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1086. const_iterator cbegin() const { return begin(); }
  1087. const_iterator cend() const { return end(); }
  1088. bool empty() const { return entries_.empty(); }
  1089. size_type size() const { return entries_.size(); }
  1090. void clear() { entries_.clear(); }
  1091. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1092. iterator insert(const value_type &val) {
  1093. entries_.push_back(val);
  1094. return make_iter(entries_.size() - 1, npos());
  1095. }
  1096. iterator insert(value_type &&val) {
  1097. entries_.push_back(std::move(val));
  1098. return make_iter(entries_.size() - 1, npos());
  1099. }
  1100. template <typename... Args> iterator emplace(Args &&...args) {
  1101. entries_.emplace_back(std::forward<Args>(args)...);
  1102. return make_iter(entries_.size() - 1, npos());
  1103. }
  1104. // For entries that have to lead the message, such as the Host header field
  1105. // (RFC 9110 5.3 recommends sending control data first).
  1106. template <typename... Args> iterator emplace_front(Args &&...args) {
  1107. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1108. return make_iter(0, npos());
  1109. }
  1110. iterator find(const std::string &key) {
  1111. auto i = index_of(key);
  1112. return i == npos() ? end() : make_iter(i, i);
  1113. }
  1114. const_iterator find(const std::string &key) const {
  1115. auto i = index_of(key);
  1116. return i == npos() ? end() : make_citer(i, i);
  1117. }
  1118. size_type count(const std::string &key) const {
  1119. size_type n = 0;
  1120. for (const auto &entry : entries_) {
  1121. if (keys_equal(entry.first, key)) { n++; }
  1122. }
  1123. return n;
  1124. }
  1125. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1126. auto i = index_of(key);
  1127. return i == npos() ? std::make_pair(end(), end())
  1128. : std::make_pair(make_iter(i, i), end());
  1129. }
  1130. std::pair<const_iterator, const_iterator>
  1131. equal_range(const std::string &key) const {
  1132. auto i = index_of(key);
  1133. return i == npos() ? std::make_pair(end(), end())
  1134. : std::make_pair(make_citer(i, i), end());
  1135. }
  1136. size_type erase(const std::string &key) {
  1137. auto before = entries_.size();
  1138. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1139. [key](const value_type &entry) {
  1140. return keys_equal(entry.first, key);
  1141. }),
  1142. entries_.end());
  1143. return before - entries_.size();
  1144. }
  1145. iterator erase(const_iterator pos) {
  1146. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1147. return make_iter(pos.idx_, npos());
  1148. }
  1149. // Erases what iterating [first, last) would actually visit, so erasing an
  1150. // equal_range() removes only the entries with that key, not everything
  1151. // positioned between them.
  1152. iterator erase(const_iterator first, const_iterator last) {
  1153. auto from = first.idx_;
  1154. auto to = last.idx_;
  1155. if (from >= to) { return make_iter(from, npos()); }
  1156. auto begin_it = entries_.begin();
  1157. auto from_it = begin_it + static_cast<difference_type>(from);
  1158. auto to_it = begin_it + static_cast<difference_type>(to);
  1159. if (first.key_idx_ == npos()) {
  1160. entries_.erase(from_it, to_it);
  1161. } else {
  1162. auto key = entries_[first.key_idx_].first;
  1163. auto keep = from_it;
  1164. for (auto it = from_it; it != to_it; ++it) {
  1165. if (!keys_equal(it->first, key)) {
  1166. if (keep != it) { *keep = std::move(*it); }
  1167. ++keep;
  1168. }
  1169. }
  1170. if (keep != to_it) {
  1171. keep = std::move(to_it, entries_.end(), keep);
  1172. } else {
  1173. keep = entries_.end();
  1174. }
  1175. entries_.erase(keep, entries_.end());
  1176. }
  1177. return make_iter(from, npos());
  1178. }
  1179. friend bool operator==(const insertion_ordered_multimap &lhs,
  1180. const insertion_ordered_multimap &rhs) {
  1181. return lhs.entries_ == rhs.entries_;
  1182. }
  1183. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1184. const insertion_ordered_multimap &rhs) {
  1185. return !(lhs == rhs);
  1186. }
  1187. private:
  1188. size_type index_of(const std::string &key) const {
  1189. for (size_type i = 0; i < entries_.size(); i++) {
  1190. if (keys_equal(entries_[i].first, key)) { return i; }
  1191. }
  1192. return npos();
  1193. }
  1194. iterator make_iter(size_type idx, size_type key_idx) {
  1195. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1196. }
  1197. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1198. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1199. }
  1200. std::vector<value_type> entries_;
  1201. };
  1202. } // namespace detail
  1203. using Headers =
  1204. detail::insertion_ordered_multimap<std::string,
  1205. detail::case_ignore::equal_to>;
  1206. // Query parameter names are case-sensitive, unlike header field names.
  1207. using Params =
  1208. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1209. using Match = std::smatch;
  1210. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1211. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1212. /*
  1213. * detail: type-erased storage used by UserData.
  1214. * ABI-stable regardless of C++ standard — always uses this custom
  1215. * implementation instead of std::any.
  1216. */
  1217. namespace detail {
  1218. using any_type_id = const void *;
  1219. template <typename T> any_type_id any_typeid() noexcept {
  1220. static const char id = 0;
  1221. return &id;
  1222. }
  1223. struct any_storage {
  1224. virtual ~any_storage() = default;
  1225. virtual std::unique_ptr<any_storage> clone() const = 0;
  1226. virtual any_type_id type_id() const noexcept = 0;
  1227. };
  1228. template <typename T> struct any_value final : any_storage {
  1229. T value;
  1230. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1231. std::unique_ptr<any_storage> clone() const override {
  1232. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1233. }
  1234. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1235. };
  1236. } // namespace detail
  1237. class UserData {
  1238. public:
  1239. UserData() = default;
  1240. UserData(UserData &&) noexcept = default;
  1241. UserData &operator=(UserData &&) noexcept = default;
  1242. UserData(const UserData &o) {
  1243. for (const auto &e : o.entries_) {
  1244. if (e.second) { entries_[e.first] = e.second->clone(); }
  1245. }
  1246. }
  1247. UserData &operator=(const UserData &o) {
  1248. if (this != &o) {
  1249. entries_.clear();
  1250. for (const auto &e : o.entries_) {
  1251. if (e.second) { entries_[e.first] = e.second->clone(); }
  1252. }
  1253. }
  1254. return *this;
  1255. }
  1256. template <typename T> void set(const std::string &key, T &&value) {
  1257. using D = typename std::decay<T>::type;
  1258. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1259. }
  1260. template <typename T> T *get(const std::string &key) noexcept {
  1261. auto it = entries_.find(key);
  1262. if (it == entries_.end() || !it->second) { return nullptr; }
  1263. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1264. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1265. }
  1266. template <typename T> const T *get(const std::string &key) const noexcept {
  1267. auto it = entries_.find(key);
  1268. if (it == entries_.end() || !it->second) { return nullptr; }
  1269. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1270. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1271. }
  1272. bool has(const std::string &key) const noexcept {
  1273. return entries_.find(key) != entries_.end();
  1274. }
  1275. void erase(const std::string &key) { entries_.erase(key); }
  1276. void clear() noexcept { entries_.clear(); }
  1277. private:
  1278. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1279. entries_;
  1280. };
  1281. struct Response;
  1282. using ResponseHandler = std::function<bool(const Response &response)>;
  1283. struct FormData {
  1284. std::string name;
  1285. std::string content;
  1286. std::string filename;
  1287. std::string content_type;
  1288. Headers headers;
  1289. };
  1290. struct FormField {
  1291. std::string name;
  1292. std::string content;
  1293. Headers headers;
  1294. };
  1295. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1296. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1297. // should see the parts as they were sent. A std::multimap sorts by field name
  1298. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1299. // than the case-insensitive predicate Headers uses.
  1300. using FormFields =
  1301. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1302. using FormFiles =
  1303. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1304. struct MultipartFormData {
  1305. FormFields fields; // Text fields from multipart
  1306. FormFiles files; // Files from multipart
  1307. // Text field access
  1308. std::string get_field(const std::string &key, size_t id = 0) const;
  1309. std::vector<std::string> get_fields(const std::string &key) const;
  1310. bool has_field(const std::string &key) const;
  1311. size_t get_field_count(const std::string &key) const;
  1312. // File access
  1313. FormData get_file(const std::string &key, size_t id = 0) const;
  1314. std::vector<FormData> get_files(const std::string &key) const;
  1315. bool has_file(const std::string &key) const;
  1316. size_t get_file_count(const std::string &key) const;
  1317. };
  1318. struct UploadFormData {
  1319. std::string name;
  1320. std::string content;
  1321. std::string filename;
  1322. std::string content_type;
  1323. };
  1324. using UploadFormDataItems = std::vector<UploadFormData>;
  1325. class DataSink {
  1326. public:
  1327. DataSink() : os(&sb_), sb_(*this) {}
  1328. DataSink(const DataSink &) = delete;
  1329. DataSink &operator=(const DataSink &) = delete;
  1330. DataSink(DataSink &&) = delete;
  1331. DataSink &operator=(DataSink &&) = delete;
  1332. std::function<bool(const char *data, size_t data_len)> write;
  1333. // Only `write` is mandatory. The rest are defaulted so that a provider
  1334. // calling one on a writer that does not set it gets sensible behaviour
  1335. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1336. // `this` is safe: DataSink is neither copyable nor movable.
  1337. std::function<bool()> is_writable = []() { return true; };
  1338. std::function<void()> done = []() {};
  1339. std::function<void(const Headers &trailer)> done_with_trailer =
  1340. [this](const Headers & /*trailer*/) { done(); };
  1341. std::ostream os;
  1342. private:
  1343. class data_sink_streambuf final : public std::streambuf {
  1344. public:
  1345. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1346. protected:
  1347. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1348. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1349. return 0;
  1350. }
  1351. private:
  1352. DataSink &sink_;
  1353. };
  1354. data_sink_streambuf sb_;
  1355. };
  1356. using ContentProvider =
  1357. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1358. using ContentProviderWithoutLength =
  1359. std::function<bool(size_t offset, DataSink &sink)>;
  1360. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1361. struct FormDataProvider {
  1362. std::string name;
  1363. ContentProviderWithoutLength provider;
  1364. std::string filename;
  1365. std::string content_type;
  1366. };
  1367. using FormDataProviderItems = std::vector<FormDataProvider>;
  1368. inline FormDataProvider
  1369. make_file_provider(const std::string &name, const std::string &filepath,
  1370. const std::string &filename = std::string(),
  1371. const std::string &content_type = std::string()) {
  1372. FormDataProvider fdp;
  1373. fdp.name = name;
  1374. fdp.filename = filename.empty() ? filepath : filename;
  1375. fdp.content_type = content_type;
  1376. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1377. std::ifstream f(filepath, std::ios::binary);
  1378. if (!f) { return false; }
  1379. if (offset > 0) {
  1380. f.seekg(static_cast<std::streamoff>(offset));
  1381. if (!f.good()) {
  1382. sink.done();
  1383. return true;
  1384. }
  1385. }
  1386. char buf[8192];
  1387. f.read(buf, sizeof(buf));
  1388. auto n = static_cast<size_t>(f.gcount());
  1389. if (n > 0) { return sink.write(buf, n); }
  1390. sink.done(); // EOF
  1391. return true;
  1392. };
  1393. return fdp;
  1394. }
  1395. inline std::pair<size_t, ContentProvider>
  1396. make_file_body(const std::string &filepath) {
  1397. size_t size = 0;
  1398. {
  1399. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1400. if (!f) { return {0, ContentProvider{}}; }
  1401. size = static_cast<size_t>(f.tellg());
  1402. }
  1403. ContentProvider provider = [filepath](size_t offset, size_t length,
  1404. DataSink &sink) -> bool {
  1405. std::ifstream f(filepath, std::ios::binary);
  1406. if (!f) { return false; }
  1407. f.seekg(static_cast<std::streamoff>(offset));
  1408. if (!f.good()) { return false; }
  1409. char buf[8192];
  1410. while (length > 0) {
  1411. auto to_read = (std::min)(sizeof(buf), length);
  1412. f.read(buf, static_cast<std::streamsize>(to_read));
  1413. auto n = static_cast<size_t>(f.gcount());
  1414. // The file is shorter than the size make_file_body() measured, which the
  1415. // caller has already committed to as Content-Length. The body cannot be
  1416. // completed, so fail as every other error here does.
  1417. if (n == 0) { return false; }
  1418. if (!sink.write(buf, n)) { return false; }
  1419. length -= n;
  1420. }
  1421. return true;
  1422. };
  1423. return {size, std::move(provider)};
  1424. }
  1425. using ContentReceiverWithProgress = std::function<bool(
  1426. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1427. using ContentReceiver =
  1428. std::function<bool(const char *data, size_t data_length)>;
  1429. using FormDataHeader = std::function<bool(const FormData &file)>;
  1430. class ContentReader {
  1431. public:
  1432. using Reader = std::function<bool(ContentReceiver receiver)>;
  1433. using FormDataReader =
  1434. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1435. ContentReader(Reader reader, FormDataReader multipart_reader)
  1436. : reader_(std::move(reader)),
  1437. formdata_reader_(std::move(multipart_reader)) {}
  1438. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1439. return formdata_reader_(std::move(header), std::move(receiver));
  1440. }
  1441. bool operator()(ContentReceiver receiver) const {
  1442. return reader_(std::move(receiver));
  1443. }
  1444. Reader reader_;
  1445. FormDataReader formdata_reader_;
  1446. };
  1447. using Range = std::pair<ssize_t, ssize_t>;
  1448. using Ranges = std::vector<Range>;
  1449. #ifdef CPPHTTPLIB_SSL_ENABLED
  1450. // TLS abstraction layer - public type definitions and API
  1451. namespace tls {
  1452. // Opaque handles (defined as void* for abstraction)
  1453. using ctx_t = void *;
  1454. using session_t = void *;
  1455. using const_session_t = const void *; // For read-only session access
  1456. using cert_t = void *;
  1457. using ca_store_t = void *;
  1458. // TLS versions
  1459. enum class Version {
  1460. TLS1_2 = 0x0303,
  1461. TLS1_3 = 0x0304,
  1462. };
  1463. // Subject Alternative Names (SAN) entry types
  1464. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1465. // SAN entry structure
  1466. struct SanEntry {
  1467. SanType type;
  1468. std::string value;
  1469. };
  1470. // Verification context for certificate verification callback
  1471. struct VerifyContext {
  1472. session_t session; // TLS session handle
  1473. cert_t cert; // Current certificate being verified
  1474. int depth; // Certificate chain depth (0 = leaf)
  1475. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1476. long error_code; // Backend-specific error code (0 = no error)
  1477. const char *error_string; // Human-readable error description
  1478. // Certificate introspection methods
  1479. std::string subject_cn() const;
  1480. std::string issuer_name() const;
  1481. bool check_hostname(const char *hostname) const;
  1482. std::vector<SanEntry> sans() const;
  1483. bool validity(time_t &not_before, time_t &not_after) const;
  1484. std::string serial() const;
  1485. };
  1486. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1487. // TlsError codes for TLS operations (backend-independent)
  1488. enum class ErrorCode : int {
  1489. Success = 0,
  1490. WantRead, // Non-blocking: need to wait for read
  1491. WantWrite, // Non-blocking: need to wait for write
  1492. PeerClosed, // Peer closed the connection
  1493. Fatal, // Unrecoverable error
  1494. SyscallError, // System call error (check sys_errno)
  1495. CertVerifyFailed, // Certificate verification failed
  1496. HostnameMismatch, // Hostname verification failed
  1497. };
  1498. // TLS error information
  1499. struct TlsError {
  1500. ErrorCode code = ErrorCode::Fatal;
  1501. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1502. int sys_errno = 0; // errno when SyscallError
  1503. // Convert verification error code to human-readable string
  1504. static std::string verify_error_to_string(long error_code);
  1505. };
  1506. // RAII wrapper for peer certificate
  1507. class PeerCert {
  1508. public:
  1509. PeerCert();
  1510. PeerCert(PeerCert &&other) noexcept;
  1511. PeerCert &operator=(PeerCert &&other) noexcept;
  1512. ~PeerCert();
  1513. PeerCert(const PeerCert &) = delete;
  1514. PeerCert &operator=(const PeerCert &) = delete;
  1515. explicit operator bool() const;
  1516. std::string subject_cn() const;
  1517. std::string issuer_name() const;
  1518. bool check_hostname(const char *hostname) const;
  1519. std::vector<SanEntry> sans() const;
  1520. bool validity(time_t &not_before, time_t &not_after) const;
  1521. std::string serial() const;
  1522. private:
  1523. explicit PeerCert(cert_t cert);
  1524. cert_t cert_ = nullptr;
  1525. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1526. };
  1527. // Callback for TLS context setup (used by SSLServer constructor)
  1528. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1529. } // namespace tls
  1530. #endif
  1531. struct Request {
  1532. std::string method;
  1533. std::string path;
  1534. std::string matched_route;
  1535. Params params;
  1536. Headers headers;
  1537. Headers trailers;
  1538. std::string body;
  1539. std::string remote_addr;
  1540. int remote_port = -1;
  1541. std::string local_addr;
  1542. int local_port = -1;
  1543. // for server
  1544. std::string version;
  1545. std::string target;
  1546. MultipartFormData form;
  1547. Ranges ranges;
  1548. Match matches;
  1549. std::unordered_map<std::string, std::string> path_params;
  1550. std::function<bool()> is_connection_closed = []() { return true; };
  1551. // for client
  1552. std::vector<std::string> accept_content_types;
  1553. ResponseHandler response_handler;
  1554. ContentReceiverWithProgress content_receiver;
  1555. DownloadProgress download_progress;
  1556. UploadProgress upload_progress;
  1557. bool has_header(const std::string &key) const;
  1558. std::string get_header_value(const std::string &key, const char *def = "",
  1559. size_t id = 0) const;
  1560. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1561. size_t id = 0) const;
  1562. size_t get_header_value_count(const std::string &key) const;
  1563. void set_header(const std::string &key, const std::string &val);
  1564. bool has_trailer(const std::string &key) const;
  1565. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1566. size_t get_trailer_value_count(const std::string &key) const;
  1567. bool has_param(const std::string &key) const;
  1568. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1569. std::vector<std::string> get_param_values(const std::string &key) const;
  1570. size_t get_param_value_count(const std::string &key) const;
  1571. bool is_multipart_form_data() const;
  1572. // private members...
  1573. bool body_read_started_ = false;
  1574. bool body_consumed_ = false;
  1575. bool expect_100_continue_pending_ = false;
  1576. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1577. size_t content_length_ = 0;
  1578. ContentProvider content_provider_;
  1579. bool is_chunked_content_provider_ = false;
  1580. size_t authorization_count_ = 0;
  1581. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1582. (std::chrono::steady_clock::time_point::min)();
  1583. #ifdef CPPHTTPLIB_SSL_ENABLED
  1584. tls::const_session_t ssl = nullptr;
  1585. tls::PeerCert peer_cert() const;
  1586. std::string sni() const;
  1587. #endif
  1588. };
  1589. namespace detail {
  1590. // Declared up here, away from the rest of the compression helpers, because
  1591. // `Response` stores one.
  1592. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1593. } // namespace detail
  1594. struct Response {
  1595. std::string version;
  1596. int status = -1;
  1597. std::string reason;
  1598. Headers headers;
  1599. Headers trailers;
  1600. std::string body;
  1601. std::string location; // Redirect location
  1602. // User-defined context — set by pre-routing/pre-request handlers and read
  1603. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1604. UserData user_data;
  1605. bool has_header(const std::string &key) const;
  1606. std::string get_header_value(const std::string &key, const char *def = "",
  1607. size_t id = 0) const;
  1608. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1609. size_t id = 0) const;
  1610. size_t get_header_value_count(const std::string &key) const;
  1611. void set_header(const std::string &key, const std::string &val);
  1612. bool has_trailer(const std::string &key) const;
  1613. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1614. size_t get_trailer_value_count(const std::string &key) const;
  1615. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1616. void set_content(const char *s, size_t n, const std::string &content_type);
  1617. void set_content(const std::string &s, const std::string &content_type);
  1618. void set_content(std::string &&s, const std::string &content_type);
  1619. void set_content_provider(
  1620. size_t length, const std::string &content_type, ContentProvider provider,
  1621. ContentProviderResourceReleaser resource_releaser = nullptr);
  1622. void set_content_provider(
  1623. const std::string &content_type, ContentProviderWithoutLength provider,
  1624. ContentProviderResourceReleaser resource_releaser = nullptr);
  1625. void set_chunked_content_provider(
  1626. const std::string &content_type, ContentProviderWithoutLength provider,
  1627. ContentProviderResourceReleaser resource_releaser = nullptr);
  1628. void set_file_content(const std::string &path,
  1629. const std::string &content_type);
  1630. void set_file_content(const std::string &path);
  1631. Response() = default;
  1632. Response(const Response &) = default;
  1633. Response &operator=(const Response &) = default;
  1634. Response(Response &&) = default;
  1635. Response &operator=(Response &&) = default;
  1636. ~Response() {
  1637. if (content_provider_resource_releaser_) {
  1638. content_provider_resource_releaser_(content_provider_success_);
  1639. }
  1640. }
  1641. // private members...
  1642. size_t content_length_ = 0;
  1643. ContentProvider content_provider_;
  1644. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1645. bool is_chunked_content_provider_ = false;
  1646. bool is_file_content_provider_ = false;
  1647. bool content_provider_success_ = false;
  1648. std::string file_content_path_;
  1649. std::string file_content_content_type_;
  1650. // Content coding chosen for the response body, decided once so that the
  1651. // headers and the body cannot disagree: where the file is opened for a
  1652. // file-backed content provider (keeping the ETag honest), and in
  1653. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1654. // for every other kind of response.
  1655. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1656. };
  1657. enum class Error {
  1658. Success = 0,
  1659. Unknown,
  1660. Connection,
  1661. BindIPAddress,
  1662. Read,
  1663. Write,
  1664. ExceedRedirectCount,
  1665. Canceled,
  1666. SSLConnection,
  1667. SSLLoadingCerts,
  1668. SSLServerVerification,
  1669. SSLServerHostnameVerification,
  1670. UnsupportedMultipartBoundaryChars,
  1671. Compression,
  1672. ConnectionTimeout,
  1673. ProxyConnection,
  1674. ConnectionClosed,
  1675. Timeout,
  1676. ResourceExhaustion,
  1677. TooManyFormDataFiles,
  1678. ExceedMaxPayloadSize,
  1679. ExceedUriMaxLength,
  1680. ExceedMaxSocketDescriptorCount,
  1681. InvalidRequestLine,
  1682. InvalidHTTPMethod,
  1683. InvalidHTTPVersion,
  1684. InvalidHeaders,
  1685. MultipartParsing,
  1686. OpenFile,
  1687. Listen,
  1688. GetSockName,
  1689. UnsupportedAddressFamily,
  1690. HTTPParsing,
  1691. InvalidRangeHeader,
  1692. UnsupportedContentEncoding,
  1693. WebSocketHandshake,
  1694. UserCallbackException,
  1695. // For internal use only
  1696. SSLPeerCouldBeClosed_,
  1697. };
  1698. std::string to_string(Error error);
  1699. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1700. class Stream {
  1701. public:
  1702. virtual ~Stream() = default;
  1703. virtual bool is_readable() const = 0;
  1704. virtual bool wait_readable() const = 0;
  1705. virtual bool wait_writable() const = 0;
  1706. virtual bool is_peer_alive() const { return wait_writable(); }
  1707. virtual ssize_t read(char *ptr, size_t size) = 0;
  1708. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1709. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1710. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1711. virtual socket_t socket() const = 0;
  1712. virtual time_t duration() const = 0;
  1713. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1714. (void)sec;
  1715. (void)usec;
  1716. }
  1717. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1718. // each one. 0 lifts the bound.
  1719. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1720. // Lets a wait for data end early once `interrupted` returns true, so that
  1721. // another thread can stop a blocked read on every platform.
  1722. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1723. (void)interrupted;
  1724. }
  1725. // Bytes already pulled off the socket and sitting in this stream's own
  1726. // buffer. Exposing them lets a line reader scan for a terminator in one
  1727. // pass instead of asking for a byte at a time. A stream that does no
  1728. // buffering of its own reports none, and readers fall back to read().
  1729. virtual const char *buffered_data(size_t &size) const {
  1730. size = 0;
  1731. return nullptr;
  1732. }
  1733. // Discards `size` bytes previously returned by buffered_data().
  1734. virtual void consume_buffered(size_t size) { (void)size; }
  1735. ssize_t write(const char *ptr);
  1736. ssize_t write(const std::string &s);
  1737. Error get_error() const { return error_; }
  1738. protected:
  1739. Error error_ = Error::Success;
  1740. };
  1741. class TaskQueue {
  1742. public:
  1743. TaskQueue() = default;
  1744. virtual ~TaskQueue() = default;
  1745. virtual bool enqueue(std::function<void()> fn) = 0;
  1746. virtual void shutdown() = 0;
  1747. virtual void on_idle() {}
  1748. };
  1749. class ThreadPool final : public TaskQueue {
  1750. public:
  1751. explicit ThreadPool(
  1752. size_t n, size_t max_n = 0, size_t mqr = 0,
  1753. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1754. ThreadPool(const ThreadPool &) = delete;
  1755. ~ThreadPool() override = default;
  1756. bool enqueue(std::function<void()> fn) override;
  1757. void shutdown() override;
  1758. private:
  1759. void worker(bool is_dynamic);
  1760. void move_to_finished(std::thread::id id);
  1761. void cleanup_finished_threads();
  1762. size_t base_thread_count_;
  1763. size_t max_thread_count_;
  1764. size_t max_queued_requests_;
  1765. time_t idle_timeout_sec_;
  1766. size_t idle_thread_count_;
  1767. bool shutdown_;
  1768. std::list<std::function<void()>> jobs_;
  1769. std::vector<std::thread> threads_; // base threads
  1770. std::list<std::thread> dynamic_threads_; // dynamic threads
  1771. std::vector<std::thread>
  1772. finished_threads_; // exited dynamic threads awaiting join
  1773. std::condition_variable cond_;
  1774. std::mutex mutex_;
  1775. };
  1776. using Logger = std::function<void(const Request &, const Response &)>;
  1777. // Forward declaration for Error type
  1778. enum class Error;
  1779. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1780. using SocketOptions = std::function<void(socket_t sock)>;
  1781. void default_socket_options(socket_t sock);
  1782. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1783. const char *status_message(int status);
  1784. std::string to_string(Error error);
  1785. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1786. std::string get_bearer_token_auth(const Request &req);
  1787. namespace detail {
  1788. class MatcherBase {
  1789. public:
  1790. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1791. virtual ~MatcherBase() = default;
  1792. const std::string &pattern() const { return pattern_; }
  1793. // Match request path and populate its matches and
  1794. virtual bool match(Request &request) const = 0;
  1795. private:
  1796. std::string pattern_;
  1797. };
  1798. /**
  1799. * Captures parameters in request path and stores them in Request::path_params
  1800. *
  1801. * Capture name is a substring of a pattern from : to /.
  1802. * The rest of the pattern is matched against the request path directly
  1803. * Parameters are captured starting from the next character after
  1804. * the end of the last matched static pattern fragment until the next /.
  1805. *
  1806. * Example pattern:
  1807. * "/path/fragments/:capture/more/fragments/:second_capture"
  1808. * Static fragments:
  1809. * "/path/fragments/", "more/fragments/"
  1810. *
  1811. * Given the following request path:
  1812. * "/path/fragments/:1/more/fragments/:2"
  1813. * the resulting capture will be
  1814. * {{"capture", "1"}, {"second_capture", "2"}}
  1815. */
  1816. class PathParamsMatcher final : public MatcherBase {
  1817. public:
  1818. PathParamsMatcher(const std::string &pattern);
  1819. bool match(Request &request) const override;
  1820. private:
  1821. // Treat segment separators as the end of path parameter capture
  1822. // Does not need to handle query parameters as they are parsed before path
  1823. // matching
  1824. static constexpr char separator = '/';
  1825. // Contains static path fragments to match against, excluding the '/' after
  1826. // path params
  1827. // Fragments are separated by path params
  1828. std::vector<std::string> static_fragments_;
  1829. // Stores the names of the path parameters to be used as keys in the
  1830. // Request::path_params map
  1831. std::vector<std::string> param_names_;
  1832. };
  1833. /**
  1834. * Performs std::regex_match on request path
  1835. * and stores the result in Request::matches
  1836. *
  1837. * Note that regex match is performed directly on the whole request.
  1838. * This means that wildcard patterns may match multiple path segments with /:
  1839. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1840. */
  1841. class RegexMatcher final : public MatcherBase {
  1842. public:
  1843. RegexMatcher(const std::string &pattern)
  1844. : MatcherBase(pattern), regex_(pattern) {}
  1845. bool match(Request &request) const override;
  1846. private:
  1847. std::regex regex_;
  1848. };
  1849. int close_socket(socket_t sock) noexcept;
  1850. bool is_accept_resource_error();
  1851. bool is_accept_transient_error();
  1852. ssize_t write_headers(Stream &strm, const Headers &headers);
  1853. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1854. time_t usec);
  1855. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1856. const std::string &boundary);
  1857. ContentProvider
  1858. make_multipart_content_provider(const UploadFormDataItems &items,
  1859. const std::string &boundary);
  1860. } // namespace detail
  1861. bool is_valid_multipart_boundary(const std::string &boundary);
  1862. // Serializer for multipart/form-data request bodies. The boundary is owned
  1863. // by the writer so that per-part framing and the final terminator always
  1864. // agree. Field names and filenames are escaped following the WHATWG HTML
  1865. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1866. // in content types.
  1867. class MultipartFormDataWriter {
  1868. public:
  1869. MultipartFormDataWriter();
  1870. // precondition: is_valid_multipart_boundary(boundary)
  1871. explicit MultipartFormDataWriter(std::string boundary);
  1872. const std::string &boundary() const;
  1873. std::string content_type() const;
  1874. // In-memory items -> whole body (known length)
  1875. std::string serialize(const UploadFormDataItems &items) const;
  1876. size_t content_length(const UploadFormDataItems &items) const;
  1877. // Per-part framing for streaming via a content provider
  1878. std::string item_begin(const UploadFormData &item) const;
  1879. static std::string item_end();
  1880. std::string finish() const;
  1881. private:
  1882. std::string boundary_;
  1883. };
  1884. class Server {
  1885. public:
  1886. using Handler = std::function<void(const Request &, Response &)>;
  1887. using ExceptionHandler =
  1888. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1889. enum class HandlerResponse {
  1890. Handled,
  1891. Unhandled,
  1892. };
  1893. using HandlerWithResponse =
  1894. std::function<HandlerResponse(const Request &, Response &)>;
  1895. using HandlerWithContentReader = std::function<void(
  1896. const Request &, Response &, const ContentReader &content_reader)>;
  1897. using Expect100ContinueHandler =
  1898. std::function<int(const Request &, Response &)>;
  1899. using StartHandler = std::function<void()>;
  1900. using WebSocketHandler =
  1901. std::function<void(const Request &, ws::WebSocket &)>;
  1902. using SubProtocolSelector =
  1903. std::function<std::string(const std::vector<std::string> &protocols)>;
  1904. Server();
  1905. virtual ~Server();
  1906. virtual bool is_valid() const;
  1907. Server &Get(const std::string &pattern, Handler handler);
  1908. Server &Post(const std::string &pattern, Handler handler);
  1909. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1910. Server &Put(const std::string &pattern, Handler handler);
  1911. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1912. Server &Patch(const std::string &pattern, Handler handler);
  1913. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1914. Server &Delete(const std::string &pattern, Handler handler);
  1915. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1916. Server &Options(const std::string &pattern, Handler handler);
  1917. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1918. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1919. // server accept it; an unregistered method is still rejected with 400.
  1920. // `method` must be a valid HTTP method token and must not be one of the
  1921. // built-in methods, which have their own registration functions above. A
  1922. // rejected registration makes is_valid() return false, so listen() fails.
  1923. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1924. Handler handler);
  1925. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1926. HandlerWithContentReader handler);
  1927. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1928. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1929. SubProtocolSelector sub_protocol_selector);
  1930. bool set_base_dir(const std::string &dir,
  1931. const std::string &mount_point = std::string());
  1932. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1933. Headers headers = Headers());
  1934. bool remove_mount_point(const std::string &mount_point);
  1935. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1936. const std::string &mime);
  1937. Server &set_default_file_mimetype(const std::string &mime);
  1938. Server &set_file_request_handler(Handler handler);
  1939. template <class ErrorHandlerFunc>
  1940. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1941. return set_error_handler_core(
  1942. std::forward<ErrorHandlerFunc>(handler),
  1943. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1944. }
  1945. Server &set_exception_handler(ExceptionHandler handler);
  1946. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1947. Server &set_post_routing_handler(Handler handler);
  1948. Server &set_pre_request_handler(HandlerWithResponse handler);
  1949. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1950. Server &set_start_handler(StartHandler handler);
  1951. Server &set_logger(Logger logger);
  1952. Server &set_pre_compression_logger(Logger logger);
  1953. Server &set_error_logger(ErrorLogger error_logger);
  1954. Server &set_address_family(int family);
  1955. Server &set_tcp_nodelay(bool on);
  1956. Server &set_ipv6_v6only(bool on);
  1957. Server &set_socket_options(SocketOptions socket_options);
  1958. Server &set_default_headers(Headers headers);
  1959. Server &
  1960. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1961. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1962. Server &set_keep_alive_max_count(size_t count);
  1963. Server &set_keep_alive_timeout(time_t sec);
  1964. template <class Rep, class Period>
  1965. Server &
  1966. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1967. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1968. template <class Rep, class Period>
  1969. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1970. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1971. template <class Rep, class Period>
  1972. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1973. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1974. template <class Rep, class Period>
  1975. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1976. Server &set_payload_max_length(size_t length);
  1977. Server &set_compress(bool on);
  1978. Server &set_static_file_compression(bool on);
  1979. Server &set_static_file_compression_min_length(size_t length);
  1980. Server &set_static_file_compression_max_length(size_t length);
  1981. Server &set_websocket_ping_interval(time_t sec);
  1982. template <class Rep, class Period>
  1983. Server &set_websocket_ping_interval(
  1984. const std::chrono::duration<Rep, Period> &duration);
  1985. Server &set_websocket_max_missed_pongs(int count);
  1986. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1987. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1988. bool listen_after_bind();
  1989. bool listen(const std::string &host, int port, int socket_flags = 0);
  1990. bool is_running() const;
  1991. void wait_until_ready() const;
  1992. void stop() noexcept;
  1993. void decommission();
  1994. std::function<TaskQueue *(void)> new_task_queue;
  1995. protected:
  1996. bool process_request(Stream &strm, const std::string &remote_addr,
  1997. int remote_port, const std::string &local_addr,
  1998. int local_port, bool close_connection,
  1999. bool &connection_closed,
  2000. const std::function<void(Request &)> &setup_request,
  2001. bool *websocket_upgraded = nullptr);
  2002. // Runs the per-connection serving loop and stops an exception thrown by a
  2003. // user callback from escaping the worker thread.
  2004. //
  2005. // process_request() wraps only routing() and the hooks before a WebSocket
  2006. // upgrade in a try/catch. Content providers, the post-routing, error,
  2007. // logging and expect-100 handlers and WebSocket handlers all run outside
  2008. // it, and the task queue calls the job without a catch, so an exception
  2009. // from any of those would terminate the process.
  2010. //
  2011. // No 500 is possible here: by the time a content provider runs, the status
  2012. // line and headers are already on the wire. Report it through the error
  2013. // logger and drop the connection, which is what the peer observes either
  2014. // way. Other connections are unaffected.
  2015. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  2016. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  2017. return serve();
  2018. #else
  2019. try {
  2020. return serve();
  2021. } catch (...) {
  2022. // The error logger is a user callback too, so it must not be able to
  2023. // throw the guard back open.
  2024. try {
  2025. output_error_log(Error::UserCallbackException, nullptr);
  2026. } catch (...) {}
  2027. return false;
  2028. }
  2029. #endif
  2030. }
  2031. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2032. std::vector<std::string> trusted_proxies_;
  2033. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2034. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2035. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2036. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2037. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2038. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2039. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2040. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2041. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2042. bool compress_ = true;
  2043. bool static_file_compression_ = false;
  2044. size_t static_file_compression_min_length_ =
  2045. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2046. size_t static_file_compression_max_length_ =
  2047. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2048. time_t websocket_ping_interval_sec_ =
  2049. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2050. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2051. private:
  2052. using Handlers =
  2053. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2054. using HandlersForContentReader =
  2055. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2056. HandlerWithContentReader>>;
  2057. // Both handler tables for one custom method live in a single entry, so that
  2058. // routing() needs only one map lookup per request to reach either of them.
  2059. struct CustomHandlerEntry {
  2060. Handlers handlers;
  2061. HandlersForContentReader handlers_for_content_reader;
  2062. };
  2063. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2064. static std::unique_ptr<detail::MatcherBase>
  2065. make_matcher(const std::string &pattern);
  2066. static const std::set<std::string> &builtin_methods();
  2067. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2068. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2069. template <typename H>
  2070. Server &add_handler(
  2071. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2072. const std::string &pattern, H handler) {
  2073. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2074. return *this;
  2075. }
  2076. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2077. Server &set_error_handler_core(Handler handler, std::false_type);
  2078. socket_t create_server_socket(const std::string &host, int port,
  2079. int socket_flags,
  2080. SocketOptions socket_options) const;
  2081. int bind_internal(const std::string &host, int port, int socket_flags);
  2082. bool listen_internal();
  2083. bool routing(Request &req, Response &res, Stream &strm,
  2084. bool skip_pre_routing);
  2085. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  2086. bool handle_exception(Request &req, Response &res);
  2087. #endif
  2088. bool handle_file_request(Request &req, Response &res);
  2089. bool check_if_not_modified(const Request &req, Response &res,
  2090. const std::string &etag, time_t mtime) const;
  2091. bool check_if_range(Request &req, const std::string &etag,
  2092. time_t mtime) const;
  2093. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2094. Stream &strm);
  2095. bool dispatch_request_for_content_reader(
  2096. Request &req, Response &res, ContentReader content_reader,
  2097. const HandlersForContentReader &handlers) const;
  2098. bool parse_request_line(const char *s, Request &req) const;
  2099. detail::EncodingType static_file_encoding(const Request &req,
  2100. const Response &res,
  2101. const std::string &content_type,
  2102. size_t length) const;
  2103. bool apply_static_file_compression(const Request &req, Response &res) const;
  2104. void apply_ranges(const Request &req, Response &res,
  2105. std::string &content_type, std::string &boundary) const;
  2106. bool write_response(Stream &strm, bool close_connection, Request &req,
  2107. Response &res);
  2108. bool write_response_with_content(Stream &strm, bool close_connection,
  2109. const Request &req, Response &res);
  2110. bool write_response_core(Stream &strm, bool close_connection,
  2111. const Request &req, Response &res,
  2112. bool need_apply_ranges);
  2113. bool write_content_with_provider(Stream &strm, const Request &req,
  2114. Response &res, const std::string &boundary,
  2115. const std::string &content_type);
  2116. bool read_content(Stream &strm, Request &req, Response &res);
  2117. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2118. Response &res,
  2119. ContentReceiver receiver,
  2120. FormDataHeader multipart_header,
  2121. ContentReceiver multipart_receiver);
  2122. bool read_content_core(Stream &strm, Request &req, Response &res,
  2123. ContentReceiver receiver,
  2124. FormDataHeader multipart_header,
  2125. ContentReceiver multipart_receiver) const;
  2126. virtual bool process_and_close_socket(socket_t sock);
  2127. void output_log(const Request &req, const Response &res) const;
  2128. void output_pre_compression_log(const Request &req,
  2129. const Response &res) const;
  2130. void output_error_log(const Error &err, const Request *req) const;
  2131. std::atomic<bool> is_running_{false};
  2132. std::atomic<bool> is_decommissioned{false};
  2133. // Set when CustomRoute() refuses a registration. Written before listen(),
  2134. // read by is_valid() on the same thread, so it needs no synchronization.
  2135. bool has_invalid_registration_ = false;
  2136. struct MountPointEntry {
  2137. std::string mount_point;
  2138. std::string base_dir;
  2139. std::string resolved_base_dir;
  2140. Headers headers;
  2141. };
  2142. std::vector<MountPointEntry> base_dirs_;
  2143. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2144. std::string default_file_mimetype_ = "application/octet-stream";
  2145. Handler file_request_handler_;
  2146. Handlers get_handlers_;
  2147. Handlers post_handlers_;
  2148. HandlersForContentReader post_handlers_for_content_reader_;
  2149. Handlers put_handlers_;
  2150. HandlersForContentReader put_handlers_for_content_reader_;
  2151. Handlers patch_handlers_;
  2152. HandlersForContentReader patch_handlers_for_content_reader_;
  2153. Handlers delete_handlers_;
  2154. HandlersForContentReader delete_handlers_for_content_reader_;
  2155. Handlers options_handlers_;
  2156. CustomHandlers custom_handlers_;
  2157. struct WebSocketHandlerEntry {
  2158. std::unique_ptr<detail::MatcherBase> matcher;
  2159. WebSocketHandler handler;
  2160. SubProtocolSelector sub_protocol_selector;
  2161. };
  2162. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2163. WebSocketHandlers websocket_handlers_;
  2164. HandlerWithResponse error_handler_;
  2165. ExceptionHandler exception_handler_;
  2166. HandlerWithResponse pre_routing_handler_;
  2167. Handler post_routing_handler_;
  2168. HandlerWithResponse pre_request_handler_;
  2169. Expect100ContinueHandler expect_100_continue_handler_;
  2170. StartHandler start_handler_;
  2171. mutable std::mutex logger_mutex_;
  2172. Logger logger_;
  2173. Logger pre_compression_logger_;
  2174. ErrorLogger error_logger_;
  2175. int address_family_ = AF_UNSPEC;
  2176. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2177. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2178. SocketOptions socket_options_ = default_socket_options;
  2179. Headers default_headers_;
  2180. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2181. detail::write_headers;
  2182. };
  2183. class Result {
  2184. public:
  2185. Result() = default;
  2186. Result(std::unique_ptr<Response> &&res, Error err,
  2187. Headers &&request_headers = Headers{})
  2188. : res_(std::move(res)), err_(err),
  2189. request_headers_(std::move(request_headers)) {}
  2190. // Response
  2191. operator bool() const { return res_ != nullptr; }
  2192. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2193. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2194. const Response &value() const { return *res_; }
  2195. Response &value() { return *res_; }
  2196. const Response &operator*() const { return *res_; }
  2197. Response &operator*() { return *res_; }
  2198. const Response *operator->() const { return res_.get(); }
  2199. Response *operator->() { return res_.get(); }
  2200. // Error
  2201. Error error() const { return err_; }
  2202. // Request Headers
  2203. bool has_request_header(const std::string &key) const;
  2204. std::string get_request_header_value(const std::string &key,
  2205. const char *def = "",
  2206. size_t id = 0) const;
  2207. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2208. size_t id = 0) const;
  2209. size_t get_request_header_value_count(const std::string &key) const;
  2210. private:
  2211. std::unique_ptr<Response> res_;
  2212. Error err_ = Error::Unknown;
  2213. Headers request_headers_;
  2214. #ifdef CPPHTTPLIB_SSL_ENABLED
  2215. public:
  2216. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2217. int ssl_error)
  2218. : res_(std::move(res)), err_(err),
  2219. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2220. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2221. int ssl_error, uint64_t ssl_backend_error)
  2222. : res_(std::move(res)), err_(err),
  2223. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2224. ssl_backend_error_(ssl_backend_error) {}
  2225. int ssl_error() const { return ssl_error_; }
  2226. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2227. private:
  2228. int ssl_error_ = 0;
  2229. uint64_t ssl_backend_error_ = 0;
  2230. #endif
  2231. };
  2232. struct ClientConnection {
  2233. socket_t sock = INVALID_SOCKET;
  2234. bool is_open() const { return sock != INVALID_SOCKET; }
  2235. ClientConnection() = default;
  2236. ~ClientConnection();
  2237. ClientConnection(const ClientConnection &) = delete;
  2238. ClientConnection &operator=(const ClientConnection &) = delete;
  2239. ClientConnection(ClientConnection &&other) noexcept
  2240. : sock(other.sock)
  2241. #ifdef CPPHTTPLIB_SSL_ENABLED
  2242. ,
  2243. session(other.session)
  2244. #endif
  2245. {
  2246. other.sock = INVALID_SOCKET;
  2247. #ifdef CPPHTTPLIB_SSL_ENABLED
  2248. other.session = nullptr;
  2249. #endif
  2250. }
  2251. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2252. if (this != &other) {
  2253. sock = other.sock;
  2254. other.sock = INVALID_SOCKET;
  2255. #ifdef CPPHTTPLIB_SSL_ENABLED
  2256. session = other.session;
  2257. other.session = nullptr;
  2258. #endif
  2259. }
  2260. return *this;
  2261. }
  2262. #ifdef CPPHTTPLIB_SSL_ENABLED
  2263. tls::session_t session = nullptr;
  2264. #endif
  2265. };
  2266. namespace detail {
  2267. struct ChunkedDecoder;
  2268. struct BodyReader {
  2269. Stream *stream = nullptr;
  2270. bool has_content_length = false;
  2271. size_t content_length = 0;
  2272. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2273. size_t bytes_read = 0;
  2274. bool chunked = false;
  2275. bool eof = false;
  2276. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2277. Error last_error = Error::Success;
  2278. ssize_t read(char *buf, size_t len);
  2279. bool has_error() const { return last_error != Error::Success; }
  2280. };
  2281. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2282. size_t len) {
  2283. (void)stream;
  2284. return br.read(buf, len);
  2285. }
  2286. class decompressor;
  2287. enum class NoProxyKind {
  2288. Wildcard, // "*"
  2289. HostnameSuffix, // "example.com" or ".example.com"
  2290. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2291. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2292. };
  2293. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2294. // Lets one CIDR matcher cover both families.
  2295. using IPBytes = std::array<uint8_t, 16>;
  2296. struct NoProxyEntry {
  2297. NoProxyKind kind = NoProxyKind::Wildcard;
  2298. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2299. IPBytes net{};
  2300. int prefix_bits = 0;
  2301. };
  2302. struct NormalizedTarget {
  2303. std::string hostname; // lowercase; brackets and trailing dot removed
  2304. bool is_ipv4 = false;
  2305. bool is_ipv6 = false;
  2306. IPBytes ip{};
  2307. };
  2308. } // namespace detail
  2309. class ClientImpl {
  2310. public:
  2311. explicit ClientImpl(const std::string &host);
  2312. explicit ClientImpl(const std::string &host, int port);
  2313. explicit ClientImpl(const std::string &host, int port,
  2314. const std::string &client_cert_path,
  2315. const std::string &client_key_path);
  2316. virtual ~ClientImpl();
  2317. virtual bool is_valid() const;
  2318. struct StreamHandle {
  2319. std::unique_ptr<Response> response;
  2320. Error error = Error::Success;
  2321. StreamHandle() = default;
  2322. StreamHandle(const StreamHandle &) = delete;
  2323. StreamHandle &operator=(const StreamHandle &) = delete;
  2324. StreamHandle(StreamHandle &&) = default;
  2325. StreamHandle &operator=(StreamHandle &&) = default;
  2326. ~StreamHandle() = default;
  2327. bool is_valid() const {
  2328. return response != nullptr && error == Error::Success;
  2329. }
  2330. ssize_t read(char *buf, size_t len);
  2331. void parse_trailers_if_needed();
  2332. Error get_read_error() const { return body_reader_.last_error; }
  2333. bool has_read_error() const { return body_reader_.has_error(); }
  2334. bool trailers_parsed_ = false;
  2335. private:
  2336. friend class ClientImpl;
  2337. friend class sse::SSEClient;
  2338. ssize_t read_with_decompression(char *buf, size_t len);
  2339. std::unique_ptr<ClientConnection> connection_;
  2340. std::unique_ptr<Stream> socket_stream_;
  2341. Stream *stream_ = nullptr;
  2342. detail::BodyReader body_reader_;
  2343. std::unique_ptr<detail::decompressor> decompressor_;
  2344. std::string decompress_buffer_;
  2345. size_t decompress_offset_ = 0;
  2346. size_t decompressed_bytes_read_ = 0;
  2347. };
  2348. // clang-format off
  2349. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2350. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2351. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2352. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2353. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2354. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2355. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2356. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2357. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2358. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2359. Result Head(const std::string &path);
  2360. Result Head(const std::string &path, const Headers &headers);
  2361. Result Post(const std::string &path);
  2362. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2363. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2364. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2365. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2366. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2367. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2368. Result Post(const std::string &path, const Params &params);
  2369. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2370. Result Post(const std::string &path, const Headers &headers);
  2371. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2372. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2373. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2374. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2375. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2376. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2377. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2378. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2379. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2380. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2381. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2382. Result Put(const std::string &path);
  2383. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2384. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2385. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2386. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2387. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2388. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2389. Result Put(const std::string &path, const Params &params);
  2390. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2391. Result Put(const std::string &path, const Headers &headers);
  2392. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2393. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2394. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2395. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2396. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2397. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2398. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2399. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2400. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2401. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2402. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2403. Result Patch(const std::string &path);
  2404. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2405. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2406. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2407. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2408. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2409. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2410. Result Patch(const std::string &path, const Params &params);
  2411. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2412. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2413. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2414. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2415. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2416. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2417. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2418. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2419. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2420. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2421. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2422. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2423. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2424. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2425. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2426. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2427. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2428. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2429. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2430. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2431. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2432. Result Options(const std::string &path);
  2433. Result Options(const std::string &path, const Headers &headers);
  2434. // clang-format on
  2435. // Streaming API: Open a stream for reading response body incrementally
  2436. // Socket ownership is transferred to StreamHandle for true streaming
  2437. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2438. StreamHandle open_stream(const std::string &method, const std::string &path,
  2439. const Params &params = {},
  2440. const Headers &headers = {},
  2441. const std::string &body = {},
  2442. const std::string &content_type = {});
  2443. bool send(Request &req, Response &res, Error &error);
  2444. Result send(const Request &req);
  2445. void stop();
  2446. std::string host() const;
  2447. int port() const;
  2448. size_t is_socket_open() const;
  2449. socket_t socket() const;
  2450. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2451. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2452. void
  2453. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2454. void
  2455. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2456. void set_default_headers(Headers headers);
  2457. void
  2458. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2459. void set_address_family(int family);
  2460. void set_tcp_nodelay(bool on);
  2461. void set_ipv6_v6only(bool on);
  2462. void set_socket_options(SocketOptions socket_options);
  2463. void set_connection_timeout(time_t sec, time_t usec = 0);
  2464. template <class Rep, class Period>
  2465. void
  2466. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2467. void set_read_timeout(time_t sec, time_t usec = 0);
  2468. template <class Rep, class Period>
  2469. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2470. void set_write_timeout(time_t sec, time_t usec = 0);
  2471. template <class Rep, class Period>
  2472. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2473. void set_max_timeout(time_t msec);
  2474. template <class Rep, class Period>
  2475. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2476. void set_basic_auth(const std::string &username, const std::string &password);
  2477. void set_bearer_token_auth(const std::string &token);
  2478. void set_keep_alive(bool on);
  2479. void set_follow_location(bool on);
  2480. void set_path_encode(bool on);
  2481. void set_compress(bool on);
  2482. void set_decompress(bool on);
  2483. void set_payload_max_length(size_t length);
  2484. void set_interface(const std::string &intf);
  2485. void set_proxy(const std::string &host, int port);
  2486. void set_proxy_basic_auth(const std::string &username,
  2487. const std::string &password);
  2488. void set_proxy_bearer_token_auth(const std::string &token);
  2489. void set_no_proxy(const std::vector<std::string> &patterns);
  2490. void set_logger(Logger logger);
  2491. void set_error_logger(ErrorLogger error_logger);
  2492. protected:
  2493. struct Socket {
  2494. socket_t sock = INVALID_SOCKET;
  2495. // For Mbed TLS compatibility: start_time for request timeout tracking
  2496. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2497. bool is_open() const { return sock != INVALID_SOCKET; }
  2498. #ifdef CPPHTTPLIB_SSL_ENABLED
  2499. tls::session_t ssl = nullptr;
  2500. #endif
  2501. };
  2502. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2503. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2504. virtual bool setup_proxy_connection(
  2505. Socket &socket,
  2506. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2507. Response &res, bool &success, Error &error);
  2508. bool is_proxy_enabled_for_host(const std::string &host) const;
  2509. // All of:
  2510. // shutdown_ssl
  2511. // shutdown_socket
  2512. // close_socket
  2513. // disconnect
  2514. // should ONLY be called when socket_mutex_ is locked, and only when
  2515. // no other thread is using the socket.
  2516. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2517. void shutdown_socket(Socket &socket) const;
  2518. void close_socket(Socket &socket);
  2519. void disconnect(bool gracefully);
  2520. // Under socket_mutex_: whether the connection kept alive can take another
  2521. // request. One the peer has closed, or one set up under TLS settings changed
  2522. // since, is closed instead.
  2523. bool socket_reusable();
  2524. // TLS settings apply as a connection is set up, so a change makes the
  2525. // connection kept alive unfit for the next request.
  2526. void tls_settings_changed() { tls_settings_version_++; }
  2527. std::string make_request_target(const Request &req) const;
  2528. bool process_request(Stream &strm, Request &req, Response &res,
  2529. bool close_connection, Error &error);
  2530. bool write_content_with_provider(Stream &strm, const Request &req,
  2531. Error &error) const;
  2532. void output_log(const Request &req, const Response &res) const;
  2533. void output_error_log(const Error &err, const Request *req) const;
  2534. // Socket endpoint information
  2535. const std::string host_;
  2536. const int port_;
  2537. // Current open socket
  2538. Socket socket_;
  2539. mutable std::mutex socket_mutex_;
  2540. std::recursive_mutex request_mutex_;
  2541. // How many send() calls are running on this client, guarded by
  2542. // request_mutex_
  2543. size_t send_depth_ = 0;
  2544. // These are all protected under socket_mutex
  2545. size_t socket_requests_in_flight_ = 0;
  2546. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2547. bool socket_should_be_closed_when_request_is_done_ = false;
  2548. size_t socket_tls_settings_version_ = 0;
  2549. // Set by stop() while a request is in flight. The request's reads poll it,
  2550. // because shutting the socket down does not wake a read on Windows.
  2551. std::atomic<bool> stop_requested_{false};
  2552. std::atomic<size_t> tls_settings_version_{0};
  2553. // Hostname to connection target map. The value is an IP literal or another
  2554. // hostname; only the connection target changes, never the identity.
  2555. std::map<std::string, std::string> addr_map_;
  2556. // Hostname to CONNECT target map, used only through a proxy.
  2557. std::map<std::string, std::string> tunnel_addr_map_;
  2558. // Default headers
  2559. Headers default_headers_;
  2560. // Header writer
  2561. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2562. detail::write_headers;
  2563. // Settings
  2564. std::string client_cert_path_;
  2565. std::string client_key_path_;
  2566. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2567. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2568. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2569. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2570. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2571. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2572. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2573. std::string basic_auth_username_;
  2574. std::string basic_auth_password_;
  2575. std::string bearer_token_auth_token_;
  2576. bool keep_alive_ = false;
  2577. bool follow_location_ = false;
  2578. bool path_encode_ = true;
  2579. int address_family_ = AF_UNSPEC;
  2580. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2581. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2582. SocketOptions socket_options_ = nullptr;
  2583. bool compress_ = false;
  2584. bool decompress_ = true;
  2585. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2586. bool has_payload_max_length_ = false;
  2587. std::string interface_;
  2588. std::string proxy_host_;
  2589. int proxy_port_ = -1;
  2590. std::string proxy_basic_auth_username_;
  2591. std::string proxy_basic_auth_password_;
  2592. std::string proxy_bearer_token_auth_token_;
  2593. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2594. mutable detail::NormalizedTarget host_normalized_;
  2595. mutable bool host_normalized_valid_ = false;
  2596. mutable std::mutex logger_mutex_;
  2597. Logger logger_;
  2598. ErrorLogger error_logger_;
  2599. private:
  2600. bool send_(Request &req, Response &res, Error &error);
  2601. Result send_(Request &&req);
  2602. socket_t create_client_socket(Error &error) const;
  2603. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2604. bool skip_100_continue = true) const;
  2605. bool write_request(Stream &strm, Request &req, bool close_connection,
  2606. Error &error, bool skip_body, bool &rejected_locally);
  2607. bool write_request_body(Stream &strm, Request &req, Error &error);
  2608. void prepare_default_headers(Request &r, bool for_stream,
  2609. const std::string &ct);
  2610. bool redirect(Request &req, Response &res, Error &error);
  2611. bool create_redirect_client(const std::string &scheme,
  2612. const std::string &host, int port, Request &req,
  2613. Response &res, const std::string &path,
  2614. const std::string &location, Error &error);
  2615. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2616. bool handle_request(Stream &strm, Request &req, Response &res,
  2617. bool close_connection, Error &error);
  2618. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2619. Request &req, const char *body, size_t content_length,
  2620. ContentProvider content_provider,
  2621. ContentProviderWithoutLength content_provider_without_length,
  2622. const std::string &content_type, ContentReceiver content_receiver,
  2623. Error &error);
  2624. Result send_with_content_provider_and_receiver(
  2625. const std::string &method, const std::string &path,
  2626. const Headers &headers, const char *body, size_t content_length,
  2627. ContentProvider content_provider,
  2628. ContentProviderWithoutLength content_provider_without_length,
  2629. const std::string &content_type, ContentReceiver content_receiver,
  2630. UploadProgress progress);
  2631. ContentProviderWithoutLength get_multipart_content_provider(
  2632. const std::string &boundary, const UploadFormDataItems &items,
  2633. const FormDataProviderItems &provider_items) const;
  2634. virtual bool
  2635. process_socket(const Socket &socket,
  2636. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2637. std::function<bool(Stream &strm)> callback);
  2638. virtual bool is_ssl() const;
  2639. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2640. StreamHandle open_stream_(Request &req);
  2641. void add_credential_headers(Request &req);
  2642. std::string proxy_target_prefix() const;
  2643. #ifdef CPPHTTPLIB_SSL_ENABLED
  2644. public:
  2645. void set_digest_auth(const std::string &username,
  2646. const std::string &password);
  2647. void set_proxy_digest_auth(const std::string &username,
  2648. const std::string &password);
  2649. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2650. const std::string &ca_cert_dir_path = std::string());
  2651. void enable_server_certificate_verification(bool enabled);
  2652. void enable_server_hostname_verification(bool enabled);
  2653. void enable_system_ca(bool enabled);
  2654. protected:
  2655. std::string digest_auth_username_;
  2656. std::string digest_auth_password_;
  2657. std::string proxy_digest_auth_username_;
  2658. std::string proxy_digest_auth_password_;
  2659. std::string ca_cert_file_path_;
  2660. std::string ca_cert_dir_path_;
  2661. bool server_certificate_verification_ = true;
  2662. bool server_hostname_verification_ = true;
  2663. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2664. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2665. int last_ssl_error_ = 0;
  2666. uint64_t last_backend_error_ = 0;
  2667. #endif
  2668. };
  2669. namespace detail {
  2670. // Stands in for a client that Client could not make from its arguments, so a
  2671. // request fails rather than going through a null pointer.
  2672. class InvalidClientImpl final : public ClientImpl {
  2673. public:
  2674. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2675. bool is_valid() const override { return false; }
  2676. private:
  2677. bool create_and_connect_socket(Socket &, Error &error) override {
  2678. error = Error::Connection;
  2679. return false;
  2680. }
  2681. };
  2682. } // namespace detail
  2683. class Client {
  2684. public:
  2685. // Universal interface
  2686. explicit Client(const std::string &scheme_host_port);
  2687. explicit Client(const std::string &scheme_host_port,
  2688. const std::string &client_cert_path,
  2689. const std::string &client_key_path);
  2690. // HTTP only interface
  2691. explicit Client(const std::string &host, int port);
  2692. explicit Client(const std::string &host, int port,
  2693. const std::string &client_cert_path,
  2694. const std::string &client_key_path);
  2695. Client(Client &&) = default;
  2696. Client &operator=(Client &&) = default;
  2697. ~Client();
  2698. bool is_valid() const;
  2699. // clang-format off
  2700. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2701. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2702. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2703. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2704. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2705. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2706. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2707. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2708. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2709. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2710. Result Head(const std::string &path);
  2711. Result Head(const std::string &path, const Headers &headers);
  2712. Result Post(const std::string &path);
  2713. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2714. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2715. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2716. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2717. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2718. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2719. Result Post(const std::string &path, const Params &params);
  2720. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2721. Result Post(const std::string &path, const Headers &headers);
  2722. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2723. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2724. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2725. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2726. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2727. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2728. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2729. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2730. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2731. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2732. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2733. Result Put(const std::string &path);
  2734. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2735. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2736. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2737. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2738. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2739. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2740. Result Put(const std::string &path, const Params &params);
  2741. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2742. Result Put(const std::string &path, const Headers &headers);
  2743. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2744. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2745. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2746. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2747. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2748. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2749. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2750. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2751. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2752. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2753. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2754. Result Patch(const std::string &path);
  2755. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2756. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2757. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2758. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2759. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2760. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2761. Result Patch(const std::string &path, const Params &params);
  2762. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2763. Result Patch(const std::string &path, const Headers &headers);
  2764. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2765. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2766. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2767. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2768. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2769. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2770. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2771. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2772. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2773. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2774. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2775. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2776. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2777. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2778. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2779. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2780. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2781. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2782. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2783. Result Options(const std::string &path);
  2784. Result Options(const std::string &path, const Headers &headers);
  2785. // clang-format on
  2786. // Streaming API: Open a stream for reading response body incrementally
  2787. // Socket ownership is transferred to StreamHandle for true streaming
  2788. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2789. ClientImpl::StreamHandle open_stream(const std::string &method,
  2790. const std::string &path,
  2791. const Params &params = {},
  2792. const Headers &headers = {},
  2793. const std::string &body = {},
  2794. const std::string &content_type = {});
  2795. bool send(Request &req, Response &res, Error &error);
  2796. Result send(const Request &req);
  2797. void stop();
  2798. std::string host() const;
  2799. int port() const;
  2800. size_t is_socket_open() const;
  2801. socket_t socket() const;
  2802. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  2803. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2804. void
  2805. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2806. void
  2807. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2808. void set_default_headers(Headers headers);
  2809. void
  2810. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2811. void set_address_family(int family);
  2812. void set_tcp_nodelay(bool on);
  2813. void set_socket_options(SocketOptions socket_options);
  2814. void set_connection_timeout(time_t sec, time_t usec = 0);
  2815. template <class Rep, class Period>
  2816. void
  2817. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2818. void set_read_timeout(time_t sec, time_t usec = 0);
  2819. template <class Rep, class Period>
  2820. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2821. void set_write_timeout(time_t sec, time_t usec = 0);
  2822. template <class Rep, class Period>
  2823. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2824. void set_max_timeout(time_t msec);
  2825. template <class Rep, class Period>
  2826. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2827. void set_basic_auth(const std::string &username, const std::string &password);
  2828. void set_bearer_token_auth(const std::string &token);
  2829. void set_keep_alive(bool on);
  2830. void set_follow_location(bool on);
  2831. void set_path_encode(bool on);
  2832. void set_compress(bool on);
  2833. void set_decompress(bool on);
  2834. void set_payload_max_length(size_t length);
  2835. void set_interface(const std::string &intf);
  2836. void set_proxy(const std::string &host, int port);
  2837. void set_proxy_basic_auth(const std::string &username,
  2838. const std::string &password);
  2839. void set_proxy_bearer_token_auth(const std::string &token);
  2840. void set_no_proxy(const std::vector<std::string> &patterns);
  2841. void set_logger(Logger logger);
  2842. void set_error_logger(ErrorLogger error_logger);
  2843. private:
  2844. std::unique_ptr<ClientImpl> cli_;
  2845. #ifdef CPPHTTPLIB_SSL_ENABLED
  2846. public:
  2847. void set_digest_auth(const std::string &username,
  2848. const std::string &password);
  2849. void set_proxy_digest_auth(const std::string &username,
  2850. const std::string &password);
  2851. void enable_server_certificate_verification(bool enabled);
  2852. void enable_server_hostname_verification(bool enabled);
  2853. void enable_system_ca(bool enabled);
  2854. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2855. const std::string &ca_cert_dir_path = std::string());
  2856. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2857. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2858. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2859. void set_session_verifier(
  2860. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2861. tls::ctx_t tls_context() const;
  2862. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2863. void enable_windows_certificate_verification(bool enabled);
  2864. #endif
  2865. private:
  2866. bool is_ssl_ = false;
  2867. #endif
  2868. };
  2869. #ifdef CPPHTTPLIB_SSL_ENABLED
  2870. class SSLServer : public Server {
  2871. public:
  2872. SSLServer(const char *cert_path, const char *private_key_path,
  2873. const char *client_ca_cert_file_path = nullptr,
  2874. const char *client_ca_cert_dir_path = nullptr,
  2875. const char *private_key_password = nullptr);
  2876. struct PemMemory {
  2877. const char *cert_pem;
  2878. size_t cert_pem_len;
  2879. const char *key_pem;
  2880. size_t key_pem_len;
  2881. const char *client_ca_pem;
  2882. size_t client_ca_pem_len;
  2883. const char *private_key_password;
  2884. };
  2885. explicit SSLServer(const PemMemory &pem);
  2886. // The callback receives the ctx_t handle which can be cast to the
  2887. // appropriate backend type (SSL_CTX* for OpenSSL,
  2888. // tls::impl::MbedTlsContext* for Mbed TLS)
  2889. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2890. ~SSLServer() override;
  2891. bool is_valid() const override;
  2892. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2893. const char *client_ca_pem = nullptr,
  2894. const char *password = nullptr);
  2895. tls::ctx_t tls_context() const { return ctx_; }
  2896. int ssl_last_error() const { return last_ssl_error_; }
  2897. private:
  2898. bool process_and_close_socket(socket_t sock) override;
  2899. tls::ctx_t ctx_ = nullptr;
  2900. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2901. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2902. // bounds, and new ones wait while it is pending so that they cannot keep it
  2903. // waiting.
  2904. std::mutex ctx_mutex_;
  2905. std::condition_variable ctx_cv_;
  2906. size_t handshakes_in_progress_ = 0;
  2907. size_t updates_pending_ = 0;
  2908. int last_ssl_error_ = 0;
  2909. };
  2910. class SSLClient final : public ClientImpl {
  2911. public:
  2912. explicit SSLClient(const std::string &host);
  2913. explicit SSLClient(const std::string &host, int port);
  2914. explicit SSLClient(const std::string &host, int port,
  2915. const std::string &client_cert_path,
  2916. const std::string &client_key_path,
  2917. const std::string &private_key_password = std::string());
  2918. struct PemMemory {
  2919. const char *cert_pem;
  2920. size_t cert_pem_len;
  2921. const char *key_pem;
  2922. size_t key_pem_len;
  2923. const char *private_key_password;
  2924. };
  2925. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2926. ~SSLClient() override;
  2927. bool is_valid() const override;
  2928. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2929. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2930. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2931. // Post-handshake session verifier (backend-independent)
  2932. void set_session_verifier(
  2933. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2934. tls::ctx_t tls_context() const { return ctx_; }
  2935. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2936. void enable_windows_certificate_verification(bool enabled);
  2937. #endif
  2938. private:
  2939. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2940. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2941. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2942. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2943. bool
  2944. process_socket(const Socket &socket,
  2945. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2946. std::function<bool(Stream &strm)> callback) override;
  2947. bool is_ssl() const override;
  2948. bool setup_proxy_connection(
  2949. Socket &socket,
  2950. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2951. Response &res, bool &success, Error &error) override;
  2952. bool connect_with_proxy(
  2953. Socket &sock,
  2954. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2955. Response &res, bool &success, Error &error);
  2956. bool initialize_ssl(Socket &socket, Error &error);
  2957. void init_ctx();
  2958. void reset_ctx_on_error();
  2959. bool load_certs();
  2960. tls::ctx_t ctx_ = nullptr;
  2961. std::mutex ctx_mutex_;
  2962. std::once_flag initialize_cert_;
  2963. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2964. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2965. bool ca_cert_store_set_ = false;
  2966. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2967. // no certificate, so that a CA that failed to come through fails
  2968. // verification instead of letting the system CAs in.
  2969. bool custom_ca_loaded_ = false;
  2970. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2971. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2972. // set_server_certificate_verifier() installed there.
  2973. tls::VerifyCallback server_certificate_verifier_;
  2974. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2975. bool enable_windows_cert_verification_ = true;
  2976. #endif
  2977. friend class ClientImpl;
  2978. };
  2979. #endif // CPPHTTPLIB_SSL_ENABLED
  2980. namespace detail {
  2981. template <typename T, typename U>
  2982. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2983. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2984. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2985. duration - std::chrono::seconds(sec))
  2986. .count();
  2987. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2988. }
  2989. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2990. return N - 1;
  2991. }
  2992. inline bool is_numeric(const std::string &str) {
  2993. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2994. }
  2995. // std::ranges::next(first, n, last) for C++11
  2996. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2997. for (; n > 0 && first != last; --n) {
  2998. ++first;
  2999. }
  3000. return first;
  3001. }
  3002. inline size_t get_header_value_u64(const Headers &headers,
  3003. const std::string &key, size_t def,
  3004. size_t id, bool &is_invalid_value) {
  3005. is_invalid_value = false;
  3006. auto rng = headers.equal_range(key);
  3007. auto it = bounded_next(rng.first, id, rng.second);
  3008. if (it != rng.second) {
  3009. if (is_numeric(it->second)) {
  3010. // Parse at size_t width so an out-of-range Content-Length is reported
  3011. // rather than silently saturated/truncated (a value above 2^32 would
  3012. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  3013. // and return SIZE_MAX so the existing oversized-value guards reject it.
  3014. size_t val = 0;
  3015. const auto &s = it->second;
  3016. auto r = from_chars(s.data(), s.data() + s.size(), val);
  3017. if (r.ec == std::errc::result_out_of_range) {
  3018. is_invalid_value = true;
  3019. return (std::numeric_limits<size_t>::max)();
  3020. }
  3021. return val;
  3022. } else {
  3023. is_invalid_value = true;
  3024. }
  3025. }
  3026. return def;
  3027. }
  3028. inline size_t get_header_value_u64(const Headers &headers,
  3029. const std::string &key, size_t def,
  3030. size_t id) {
  3031. auto dummy = false;
  3032. return get_header_value_u64(headers, key, def, id, dummy);
  3033. }
  3034. } // namespace detail
  3035. template <class Rep, class Period>
  3036. inline Server &
  3037. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3038. detail::duration_to_sec_and_usec(
  3039. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3040. return *this;
  3041. }
  3042. template <class Rep, class Period>
  3043. inline Server &
  3044. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3045. detail::duration_to_sec_and_usec(
  3046. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3047. return *this;
  3048. }
  3049. template <class Rep, class Period>
  3050. inline Server &
  3051. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3052. detail::duration_to_sec_and_usec(
  3053. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3054. return *this;
  3055. }
  3056. template <class Rep, class Period>
  3057. inline void ClientImpl::set_connection_timeout(
  3058. const std::chrono::duration<Rep, Period> &duration) {
  3059. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3060. set_connection_timeout(sec, usec);
  3061. });
  3062. }
  3063. template <class Rep, class Period>
  3064. inline void ClientImpl::set_read_timeout(
  3065. const std::chrono::duration<Rep, Period> &duration) {
  3066. detail::duration_to_sec_and_usec(
  3067. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3068. }
  3069. template <class Rep, class Period>
  3070. inline void ClientImpl::set_write_timeout(
  3071. const std::chrono::duration<Rep, Period> &duration) {
  3072. detail::duration_to_sec_and_usec(
  3073. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3074. }
  3075. template <class Rep, class Period>
  3076. inline void ClientImpl::set_max_timeout(
  3077. const std::chrono::duration<Rep, Period> &duration) {
  3078. auto msec =
  3079. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3080. set_max_timeout(static_cast<time_t>(msec));
  3081. }
  3082. template <class Rep, class Period>
  3083. inline void Client::set_connection_timeout(
  3084. const std::chrono::duration<Rep, Period> &duration) {
  3085. cli_->set_connection_timeout(duration);
  3086. }
  3087. template <class Rep, class Period>
  3088. inline void
  3089. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3090. cli_->set_read_timeout(duration);
  3091. }
  3092. template <class Rep, class Period>
  3093. inline void
  3094. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3095. cli_->set_write_timeout(duration);
  3096. }
  3097. inline void Client::set_max_timeout(time_t msec) {
  3098. cli_->set_max_timeout(msec);
  3099. }
  3100. template <class Rep, class Period>
  3101. inline void
  3102. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3103. cli_->set_max_timeout(duration);
  3104. }
  3105. /*
  3106. * Forward declarations and types that will be part of the .h file if split into
  3107. * .h + .cc.
  3108. */
  3109. std::string hosted_at(const std::string &hostname);
  3110. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3111. // JavaScript-style URL encoding/decoding functions
  3112. std::string encode_uri_component(const std::string &value);
  3113. std::string encode_uri(const std::string &value);
  3114. std::string decode_uri_component(const std::string &value);
  3115. std::string decode_uri(const std::string &value);
  3116. // RFC 3986 compliant URL component encoding/decoding functions
  3117. std::string encode_path_component(const std::string &component);
  3118. std::string decode_path_component(const std::string &component);
  3119. std::string encode_query_component(const std::string &component,
  3120. bool space_as_plus = true);
  3121. std::string decode_query_component(const std::string &component,
  3122. bool plus_as_space = true);
  3123. std::string sanitize_filename(const std::string &filename);
  3124. std::string append_query_params(const std::string &path, const Params &params);
  3125. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3126. std::pair<std::string, std::string>
  3127. make_basic_authentication_header(const std::string &username,
  3128. const std::string &password,
  3129. bool is_proxy = false);
  3130. namespace detail {
  3131. #if defined(_WIN32)
  3132. inline std::wstring u8string_to_wstring(const char *s) {
  3133. if (!s) { return std::wstring(); }
  3134. auto len = static_cast<int>(strlen(s));
  3135. if (!len) { return std::wstring(); }
  3136. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3137. if (!wlen) { return std::wstring(); }
  3138. std::wstring ws;
  3139. ws.resize(wlen);
  3140. wlen = ::MultiByteToWideChar(
  3141. CP_UTF8, 0, s, len,
  3142. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3143. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3144. return ws;
  3145. }
  3146. #endif
  3147. struct FileStat {
  3148. FileStat(const std::string &path);
  3149. bool is_file() const;
  3150. bool is_dir() const;
  3151. time_t mtime() const;
  3152. size_t size() const;
  3153. private:
  3154. #if defined(_WIN32)
  3155. struct _stat st_;
  3156. #else
  3157. struct stat st_;
  3158. #endif
  3159. int ret_ = -1;
  3160. };
  3161. std::string make_host_and_port_string(const std::string &host, int port,
  3162. bool is_ssl);
  3163. template <typename T>
  3164. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3165. Error &error);
  3166. bool write_data(Stream &strm, const char *d, size_t l);
  3167. std::string trim_copy(const std::string &s);
  3168. void divide(
  3169. const char *data, std::size_t size, char d,
  3170. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3171. fn);
  3172. void divide(
  3173. const std::string &str, char d,
  3174. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3175. fn);
  3176. void split(const char *b, const char *e, char d,
  3177. std::function<void(const char *, const char *)> fn);
  3178. void split(const char *b, const char *e, char d, size_t m,
  3179. std::function<void(const char *, const char *)> fn);
  3180. bool split_find(const char *b, const char *e, char d,
  3181. std::function<bool(const char *, const char *)> fn);
  3182. bool has_header_token(const Headers &headers, const std::string &key,
  3183. const std::string &token);
  3184. std::string websocket_accept_key(const std::string &client_key);
  3185. bool is_websocket_upgrade(const Request &req);
  3186. bool process_client_socket(
  3187. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3188. time_t write_timeout_sec, time_t write_timeout_usec,
  3189. time_t max_timeout_msec,
  3190. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3191. std::function<bool(Stream &)> callback);
  3192. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3193. int port, int address_family, bool tcp_nodelay,
  3194. bool ipv6_v6only, SocketOptions socket_options,
  3195. time_t connection_timeout_sec,
  3196. time_t connection_timeout_usec,
  3197. time_t read_timeout_sec, time_t read_timeout_usec,
  3198. time_t write_timeout_sec,
  3199. time_t write_timeout_usec,
  3200. const std::string &intf, Error &error);
  3201. const char *get_header_value(const Headers &headers, const std::string &key,
  3202. const char *def, size_t id);
  3203. std::string get_combined_header_value(const Headers &headers,
  3204. const std::string &key);
  3205. std::string params_to_query_str(const Params &params);
  3206. void parse_query_text(const char *data, std::size_t size, Params &params);
  3207. void parse_query_text(const std::string &s, Params &params);
  3208. bool parse_multipart_boundary(const std::string &content_type,
  3209. std::string &boundary);
  3210. bool parse_range_header(const std::string &s, Ranges &ranges);
  3211. bool parse_accept_header(const std::string &s,
  3212. std::vector<std::string> &content_types);
  3213. void parse_disposition_params(const std::string &s, Params &params);
  3214. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3215. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3216. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3217. EncodingType encoding_type(const Request &req, const Response &res,
  3218. const std::string &content_type);
  3219. EncodingType encoding_type(const Request &req, const Response &res);
  3220. class BufferStream final : public Stream {
  3221. public:
  3222. BufferStream() = default;
  3223. ~BufferStream() override = default;
  3224. bool is_readable() const override;
  3225. bool wait_readable() const override;
  3226. bool wait_writable() const override;
  3227. ssize_t read(char *ptr, size_t size) override;
  3228. ssize_t write(const char *ptr, size_t size) override;
  3229. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3230. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3231. socket_t socket() const override;
  3232. time_t duration() const override;
  3233. const std::string &get_buffer() const;
  3234. private:
  3235. std::string buffer;
  3236. size_t position = 0;
  3237. };
  3238. class compressor {
  3239. public:
  3240. virtual ~compressor() = default;
  3241. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3242. virtual bool compress(const char *data, size_t data_length, bool last,
  3243. Callback callback) = 0;
  3244. };
  3245. class decompressor {
  3246. public:
  3247. virtual ~decompressor() = default;
  3248. virtual bool is_valid() const = 0;
  3249. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3250. virtual bool decompress(const char *data, size_t data_length,
  3251. Callback callback) = 0;
  3252. };
  3253. class nocompressor final : public compressor {
  3254. public:
  3255. ~nocompressor() override = default;
  3256. bool compress(const char *data, size_t data_length, bool /*last*/,
  3257. Callback callback) override;
  3258. };
  3259. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3260. class gzip_compressor final : public compressor {
  3261. public:
  3262. gzip_compressor();
  3263. ~gzip_compressor() override;
  3264. bool compress(const char *data, size_t data_length, bool last,
  3265. Callback callback) override;
  3266. private:
  3267. bool is_valid_ = false;
  3268. z_stream strm_;
  3269. };
  3270. class gzip_decompressor final : public decompressor {
  3271. public:
  3272. gzip_decompressor();
  3273. ~gzip_decompressor() override;
  3274. bool is_valid() const override;
  3275. bool decompress(const char *data, size_t data_length,
  3276. Callback callback) override;
  3277. private:
  3278. bool is_valid_ = false;
  3279. z_stream strm_;
  3280. };
  3281. #endif
  3282. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3283. class brotli_compressor final : public compressor {
  3284. public:
  3285. brotli_compressor();
  3286. ~brotli_compressor();
  3287. bool compress(const char *data, size_t data_length, bool last,
  3288. Callback callback) override;
  3289. private:
  3290. BrotliEncoderState *state_ = nullptr;
  3291. };
  3292. class brotli_decompressor final : public decompressor {
  3293. public:
  3294. brotli_decompressor();
  3295. ~brotli_decompressor();
  3296. bool is_valid() const override;
  3297. bool decompress(const char *data, size_t data_length,
  3298. Callback callback) override;
  3299. private:
  3300. BrotliDecoderResult decoder_r;
  3301. BrotliDecoderState *decoder_s = nullptr;
  3302. };
  3303. #endif
  3304. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3305. class zstd_compressor : public compressor {
  3306. public:
  3307. zstd_compressor();
  3308. ~zstd_compressor();
  3309. bool compress(const char *data, size_t data_length, bool last,
  3310. Callback callback) override;
  3311. private:
  3312. ZSTD_CCtx *ctx_ = nullptr;
  3313. };
  3314. class zstd_decompressor : public decompressor {
  3315. public:
  3316. zstd_decompressor();
  3317. ~zstd_decompressor();
  3318. bool is_valid() const override;
  3319. bool decompress(const char *data, size_t data_length,
  3320. Callback callback) override;
  3321. private:
  3322. ZSTD_DCtx *ctx_ = nullptr;
  3323. };
  3324. #endif
  3325. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3326. // to store data. The call can set memory on stack for performance.
  3327. class stream_line_reader {
  3328. public:
  3329. stream_line_reader(Stream &strm, char *fixed_buffer,
  3330. size_t fixed_buffer_size);
  3331. const char *ptr() const;
  3332. size_t size() const;
  3333. bool end_with_crlf() const;
  3334. bool getline();
  3335. private:
  3336. void append(char c);
  3337. void append(const char *data, size_t size);
  3338. Stream &strm_;
  3339. char *fixed_buffer_;
  3340. const size_t fixed_buffer_size_;
  3341. size_t fixed_buffer_used_size_ = 0;
  3342. std::string growable_buffer_;
  3343. };
  3344. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3345. const Headers &src_headers);
  3346. struct ChunkedDecoder {
  3347. Stream &strm;
  3348. size_t chunk_remaining = 0;
  3349. bool finished = false;
  3350. char line_buf[64];
  3351. size_t last_chunk_total = 0;
  3352. size_t last_chunk_offset = 0;
  3353. size_t overhead = 0;
  3354. explicit ChunkedDecoder(Stream &s);
  3355. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3356. size_t &out_chunk_total);
  3357. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3358. };
  3359. // A regular file opened to be served: mapped on Windows, read with pread()
  3360. // elsewhere.
  3361. class mmap {
  3362. public:
  3363. mmap(const char *path);
  3364. ~mmap();
  3365. bool open(const char *path);
  3366. void close();
  3367. bool is_open() const;
  3368. size_t size() const;
  3369. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3370. // down to 0, if the file has shrunk since it was opened.
  3371. size_t read(size_t offset, char *buf, size_t len) const;
  3372. private:
  3373. #if defined(_WIN32)
  3374. HANDLE hFile_ = NULL;
  3375. HANDLE hMapping_ = NULL;
  3376. void *addr_ = nullptr;
  3377. bool is_open_empty_file = false;
  3378. #else
  3379. int fd_ = -1;
  3380. #endif
  3381. size_t size_ = 0;
  3382. };
  3383. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3384. namespace fields {
  3385. bool is_token_char(char c);
  3386. bool is_token(const std::string &s);
  3387. bool is_field_name(const std::string &s);
  3388. bool is_vchar(char c);
  3389. bool is_obs_text(char c);
  3390. bool is_field_vchar(char c);
  3391. bool is_field_content(const std::string &s);
  3392. bool is_field_value(const std::string &s);
  3393. bool is_field_valid(const std::string &name, const std::string &value);
  3394. bool is_request_target(const std::string &s);
  3395. bool is_host(const std::string &s);
  3396. } // namespace fields
  3397. } // namespace detail
  3398. /*
  3399. * TLS Abstraction Layer Declarations
  3400. */
  3401. #ifdef CPPHTTPLIB_SSL_ENABLED
  3402. // TLS abstraction layer - backend-specific type declarations
  3403. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3404. namespace tls {
  3405. namespace impl {
  3406. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3407. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3408. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3409. struct MbedTlsContext {
  3410. mbedtls_ssl_config conf;
  3411. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3412. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3413. mbedtls_entropy_context entropy;
  3414. mbedtls_ctr_drbg_context ctr_drbg;
  3415. #endif
  3416. mbedtls_x509_crt ca_chain;
  3417. mbedtls_x509_crt own_cert;
  3418. mbedtls_pk_context own_key;
  3419. bool is_server = false;
  3420. // Peer certificate required (set_verify_client()); a client defaults to true
  3421. bool verify_client = false;
  3422. // Set by tls::set_verify_callback().
  3423. VerifyCallback verify_callback;
  3424. MbedTlsContext();
  3425. ~MbedTlsContext();
  3426. MbedTlsContext(const MbedTlsContext &) = delete;
  3427. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3428. };
  3429. } // namespace impl
  3430. } // namespace tls
  3431. #endif
  3432. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3433. namespace tls {
  3434. namespace impl {
  3435. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3436. // This struct is accessible via tls::impl for use in SSL context
  3437. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3438. struct WolfSSLContext {
  3439. WOLFSSL_CTX *ctx = nullptr;
  3440. bool is_server = false;
  3441. // Peer certificate required (set_verify_client()); a client defaults to true
  3442. bool verify_client = false;
  3443. // Replaced under verify_callback_mutex()
  3444. std::shared_ptr<VerifyCallback> verify_callback;
  3445. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3446. WolfSSLContext();
  3447. ~WolfSSLContext();
  3448. WolfSSLContext(const WolfSSLContext &) = delete;
  3449. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3450. };
  3451. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3452. struct WolfSSLCAStore {
  3453. std::string pem_data;
  3454. };
  3455. } // namespace impl
  3456. } // namespace tls
  3457. #endif
  3458. #endif // CPPHTTPLIB_SSL_ENABLED
  3459. namespace stream {
  3460. class Result {
  3461. public:
  3462. Result();
  3463. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3464. Result(Result &&other) noexcept;
  3465. Result &operator=(Result &&other) noexcept;
  3466. Result(const Result &) = delete;
  3467. Result &operator=(const Result &) = delete;
  3468. // Response info
  3469. bool is_valid() const;
  3470. explicit operator bool() const;
  3471. int status() const;
  3472. const Headers &headers() const;
  3473. std::string get_header_value(const std::string &key,
  3474. const char *def = "") const;
  3475. bool has_header(const std::string &key) const;
  3476. Error error() const;
  3477. Error read_error() const;
  3478. bool has_read_error() const;
  3479. // Stream reading
  3480. bool next();
  3481. const char *data() const;
  3482. size_t size() const;
  3483. std::string read_all();
  3484. private:
  3485. ClientImpl::StreamHandle handle_;
  3486. std::string buffer_;
  3487. size_t current_size_ = 0;
  3488. size_t chunk_size_;
  3489. bool finished_ = false;
  3490. };
  3491. // GET
  3492. template <typename ClientType>
  3493. inline Result Get(ClientType &cli, const std::string &path,
  3494. size_t chunk_size = 8192) {
  3495. return Result{cli.open_stream("GET", path), chunk_size};
  3496. }
  3497. template <typename ClientType>
  3498. inline Result Get(ClientType &cli, const std::string &path,
  3499. const Headers &headers, size_t chunk_size = 8192) {
  3500. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3501. }
  3502. template <typename ClientType>
  3503. inline Result Get(ClientType &cli, const std::string &path,
  3504. const Params &params, size_t chunk_size = 8192) {
  3505. return Result{cli.open_stream("GET", path, params), chunk_size};
  3506. }
  3507. template <typename ClientType>
  3508. inline Result Get(ClientType &cli, const std::string &path,
  3509. const Params &params, const Headers &headers,
  3510. size_t chunk_size = 8192) {
  3511. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3512. }
  3513. // POST
  3514. template <typename ClientType>
  3515. inline Result Post(ClientType &cli, const std::string &path,
  3516. const std::string &body, const std::string &content_type,
  3517. size_t chunk_size = 8192) {
  3518. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3519. chunk_size};
  3520. }
  3521. template <typename ClientType>
  3522. inline Result Post(ClientType &cli, const std::string &path,
  3523. const Headers &headers, const std::string &body,
  3524. const std::string &content_type, size_t chunk_size = 8192) {
  3525. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3526. chunk_size};
  3527. }
  3528. template <typename ClientType>
  3529. inline Result Post(ClientType &cli, const std::string &path,
  3530. const Params &params, const std::string &body,
  3531. const std::string &content_type, size_t chunk_size = 8192) {
  3532. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3533. chunk_size};
  3534. }
  3535. template <typename ClientType>
  3536. inline Result Post(ClientType &cli, const std::string &path,
  3537. const Params &params, const Headers &headers,
  3538. const std::string &body, const std::string &content_type,
  3539. size_t chunk_size = 8192) {
  3540. return Result{
  3541. cli.open_stream("POST", path, params, headers, body, content_type),
  3542. chunk_size};
  3543. }
  3544. // PUT
  3545. template <typename ClientType>
  3546. inline Result Put(ClientType &cli, const std::string &path,
  3547. const std::string &body, const std::string &content_type,
  3548. size_t chunk_size = 8192) {
  3549. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3550. chunk_size};
  3551. }
  3552. template <typename ClientType>
  3553. inline Result Put(ClientType &cli, const std::string &path,
  3554. const Headers &headers, const std::string &body,
  3555. const std::string &content_type, size_t chunk_size = 8192) {
  3556. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3557. chunk_size};
  3558. }
  3559. template <typename ClientType>
  3560. inline Result Put(ClientType &cli, const std::string &path,
  3561. const Params &params, const std::string &body,
  3562. const std::string &content_type, size_t chunk_size = 8192) {
  3563. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3564. chunk_size};
  3565. }
  3566. template <typename ClientType>
  3567. inline Result Put(ClientType &cli, const std::string &path,
  3568. const Params &params, const Headers &headers,
  3569. const std::string &body, const std::string &content_type,
  3570. size_t chunk_size = 8192) {
  3571. return Result{
  3572. cli.open_stream("PUT", path, params, headers, body, content_type),
  3573. chunk_size};
  3574. }
  3575. // PATCH
  3576. template <typename ClientType>
  3577. inline Result Patch(ClientType &cli, const std::string &path,
  3578. const std::string &body, const std::string &content_type,
  3579. size_t chunk_size = 8192) {
  3580. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3581. chunk_size};
  3582. }
  3583. template <typename ClientType>
  3584. inline Result Patch(ClientType &cli, const std::string &path,
  3585. const Headers &headers, const std::string &body,
  3586. const std::string &content_type, size_t chunk_size = 8192) {
  3587. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3588. chunk_size};
  3589. }
  3590. template <typename ClientType>
  3591. inline Result Patch(ClientType &cli, const std::string &path,
  3592. const Params &params, const std::string &body,
  3593. const std::string &content_type, size_t chunk_size = 8192) {
  3594. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3595. chunk_size};
  3596. }
  3597. template <typename ClientType>
  3598. inline Result Patch(ClientType &cli, const std::string &path,
  3599. const Params &params, const Headers &headers,
  3600. const std::string &body, const std::string &content_type,
  3601. size_t chunk_size = 8192) {
  3602. return Result{
  3603. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3604. chunk_size};
  3605. }
  3606. // DELETE
  3607. template <typename ClientType>
  3608. inline Result Delete(ClientType &cli, const std::string &path,
  3609. size_t chunk_size = 8192) {
  3610. return Result{cli.open_stream("DELETE", path), chunk_size};
  3611. }
  3612. template <typename ClientType>
  3613. inline Result Delete(ClientType &cli, const std::string &path,
  3614. const Headers &headers, size_t chunk_size = 8192) {
  3615. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3616. }
  3617. template <typename ClientType>
  3618. inline Result Delete(ClientType &cli, const std::string &path,
  3619. const std::string &body, const std::string &content_type,
  3620. size_t chunk_size = 8192) {
  3621. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3622. chunk_size};
  3623. }
  3624. template <typename ClientType>
  3625. inline Result Delete(ClientType &cli, const std::string &path,
  3626. const Headers &headers, const std::string &body,
  3627. const std::string &content_type,
  3628. size_t chunk_size = 8192) {
  3629. return Result{
  3630. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3631. chunk_size};
  3632. }
  3633. template <typename ClientType>
  3634. inline Result Delete(ClientType &cli, const std::string &path,
  3635. const Params &params, size_t chunk_size = 8192) {
  3636. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3637. }
  3638. template <typename ClientType>
  3639. inline Result Delete(ClientType &cli, const std::string &path,
  3640. const Params &params, const Headers &headers,
  3641. size_t chunk_size = 8192) {
  3642. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3643. }
  3644. template <typename ClientType>
  3645. inline Result Delete(ClientType &cli, const std::string &path,
  3646. const Params &params, const std::string &body,
  3647. const std::string &content_type,
  3648. size_t chunk_size = 8192) {
  3649. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3650. chunk_size};
  3651. }
  3652. template <typename ClientType>
  3653. inline Result Delete(ClientType &cli, const std::string &path,
  3654. const Params &params, const Headers &headers,
  3655. const std::string &body, const std::string &content_type,
  3656. size_t chunk_size = 8192) {
  3657. return Result{
  3658. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3659. chunk_size};
  3660. }
  3661. // HEAD
  3662. template <typename ClientType>
  3663. inline Result Head(ClientType &cli, const std::string &path,
  3664. size_t chunk_size = 8192) {
  3665. return Result{cli.open_stream("HEAD", path), chunk_size};
  3666. }
  3667. template <typename ClientType>
  3668. inline Result Head(ClientType &cli, const std::string &path,
  3669. const Headers &headers, size_t chunk_size = 8192) {
  3670. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3671. }
  3672. template <typename ClientType>
  3673. inline Result Head(ClientType &cli, const std::string &path,
  3674. const Params &params, size_t chunk_size = 8192) {
  3675. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3676. }
  3677. template <typename ClientType>
  3678. inline Result Head(ClientType &cli, const std::string &path,
  3679. const Params &params, const Headers &headers,
  3680. size_t chunk_size = 8192) {
  3681. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3682. }
  3683. // OPTIONS
  3684. template <typename ClientType>
  3685. inline Result Options(ClientType &cli, const std::string &path,
  3686. size_t chunk_size = 8192) {
  3687. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3688. }
  3689. template <typename ClientType>
  3690. inline Result Options(ClientType &cli, const std::string &path,
  3691. const Headers &headers, size_t chunk_size = 8192) {
  3692. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3693. }
  3694. template <typename ClientType>
  3695. inline Result Options(ClientType &cli, const std::string &path,
  3696. const Params &params, size_t chunk_size = 8192) {
  3697. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3698. }
  3699. template <typename ClientType>
  3700. inline Result Options(ClientType &cli, const std::string &path,
  3701. const Params &params, const Headers &headers,
  3702. size_t chunk_size = 8192) {
  3703. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3704. }
  3705. } // namespace stream
  3706. namespace sse {
  3707. struct SSEMessage {
  3708. std::string event; // Event type (default: "message")
  3709. std::string data; // Event payload
  3710. std::string id; // Event ID for Last-Event-ID header
  3711. SSEMessage();
  3712. void clear();
  3713. };
  3714. class SSEClient {
  3715. public:
  3716. using MessageHandler = std::function<void(const SSEMessage &)>;
  3717. using ErrorHandler = std::function<void(Error)>;
  3718. using OpenHandler = std::function<void()>;
  3719. SSEClient(Client &client, const std::string &path);
  3720. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3721. ~SSEClient();
  3722. SSEClient(const SSEClient &) = delete;
  3723. SSEClient &operator=(const SSEClient &) = delete;
  3724. // Event handlers
  3725. SSEClient &on_message(MessageHandler handler);
  3726. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3727. SSEClient &on_open(OpenHandler handler);
  3728. SSEClient &on_error(ErrorHandler handler);
  3729. SSEClient &set_reconnect_interval(int ms);
  3730. SSEClient &set_max_reconnect_attempts(int n);
  3731. // Update headers (thread-safe)
  3732. SSEClient &set_headers(const Headers &headers);
  3733. // State accessors
  3734. bool is_connected() const;
  3735. std::string last_event_id() const;
  3736. // Blocking start - runs event loop with auto-reconnect
  3737. void start();
  3738. // Non-blocking start - runs in background thread
  3739. void start_async();
  3740. // Stop the client (thread-safe)
  3741. void stop();
  3742. private:
  3743. void run_event_loop();
  3744. void dispatch_event(const SSEMessage &msg);
  3745. bool should_reconnect(int count) const;
  3746. void wait_for_reconnect();
  3747. // Client and path
  3748. Client &client_;
  3749. std::string path_;
  3750. Headers headers_;
  3751. mutable std::mutex headers_mutex_;
  3752. // Callbacks
  3753. MessageHandler on_message_;
  3754. std::map<std::string, MessageHandler> event_handlers_;
  3755. OpenHandler on_open_;
  3756. ErrorHandler on_error_;
  3757. // Configuration
  3758. int reconnect_interval_ms_ = 3000;
  3759. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3760. // State
  3761. std::atomic<bool> running_{false};
  3762. std::atomic<bool> connected_{false};
  3763. // Written by the event loop, which start_async() runs on its own thread
  3764. std::string last_event_id_;
  3765. mutable std::mutex last_event_id_mutex_;
  3766. // Async support
  3767. std::thread async_thread_;
  3768. };
  3769. } // namespace sse
  3770. namespace detail {
  3771. // Interprets an event stream fed in chunks of any size
  3772. class SSEParser {
  3773. public:
  3774. using EventHandler = std::function<void(const sse::SSEMessage &msg)>;
  3775. using IdHandler = std::function<void(const std::string &id)>;
  3776. using RetryHandler = std::function<void(int retry_ms)>;
  3777. SSEParser(EventHandler on_event, IdHandler on_id, RetryHandler on_retry,
  3778. size_t max_event_length = CPPHTTPLIB_SSE_MAX_EVENT_LENGTH);
  3779. // Returns false once the line and the event still waiting for their end
  3780. // exceed max_event_length. 0 means no limit.
  3781. bool parse(const char *buf, size_t n);
  3782. private:
  3783. void parse_line(const std::string &line);
  3784. EventHandler on_event_;
  3785. IdHandler on_id_;
  3786. RetryHandler on_retry_;
  3787. size_t max_event_length_;
  3788. std::string buffer_;
  3789. sse::SSEMessage msg_;
  3790. bool has_data_ = false;
  3791. bool has_id_ = false;
  3792. bool first_line_ = true;
  3793. bool after_cr_ = false;
  3794. };
  3795. } // namespace detail
  3796. namespace ws {
  3797. class WebSocketClient;
  3798. enum class Opcode : uint8_t {
  3799. Continuation = 0x0,
  3800. Text = 0x1,
  3801. Binary = 0x2,
  3802. Close = 0x8,
  3803. Ping = 0x9,
  3804. Pong = 0xA,
  3805. };
  3806. enum class CloseStatus : uint16_t {
  3807. Normal = 1000,
  3808. GoingAway = 1001,
  3809. ProtocolError = 1002,
  3810. UnsupportedData = 1003,
  3811. NoStatus = 1005,
  3812. Abnormal = 1006,
  3813. InvalidPayload = 1007,
  3814. PolicyViolation = 1008,
  3815. MessageTooBig = 1009,
  3816. MandatoryExtension = 1010,
  3817. InternalError = 1011,
  3818. };
  3819. // Timeout is returned only when a read timeout was set and it elapsed before
  3820. // any byte of a frame arrived: nothing was consumed and the connection is
  3821. // still open, so the caller can send on it and read again. `msg` is left
  3822. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3823. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3824. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3825. // upgrade handshake fully succeeded. On failure error() identifies the
  3826. // failing layer; status()/headers() expose the server's upgrade response
  3827. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3828. // CONNECT when error() is ProxyConnection.
  3829. class Result {
  3830. public:
  3831. Result() = default;
  3832. Result(Error err, int status, Headers &&headers)
  3833. : err_(err), status_(status), headers_(std::move(headers)) {}
  3834. explicit operator bool() const { return err_ == Error::Success; }
  3835. Error error() const { return err_; }
  3836. // Upgrade response info
  3837. int status() const { return status_; }
  3838. const Headers &headers() const { return headers_; }
  3839. std::string get_header_value(const std::string &key,
  3840. const char *def = "") const {
  3841. return detail::get_header_value(headers_, key, def, 0);
  3842. }
  3843. bool has_header(const std::string &key) const {
  3844. return headers_.find(key) != headers_.end();
  3845. }
  3846. #ifdef CPPHTTPLIB_SSL_ENABLED
  3847. Result(Error err, int status, Headers &&headers, int ssl_error,
  3848. uint64_t ssl_backend_error)
  3849. : err_(err), status_(status), headers_(std::move(headers)),
  3850. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3851. int ssl_error() const { return ssl_error_; }
  3852. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3853. #endif
  3854. private:
  3855. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3856. int status_ = -1;
  3857. Headers headers_;
  3858. #ifdef CPPHTTPLIB_SSL_ENABLED
  3859. int ssl_error_ = 0;
  3860. uint64_t ssl_backend_error_ = 0;
  3861. #endif
  3862. };
  3863. class WebSocket {
  3864. public:
  3865. WebSocket(const WebSocket &) = delete;
  3866. WebSocket &operator=(const WebSocket &) = delete;
  3867. ~WebSocket();
  3868. ReadResult read(std::string &msg);
  3869. bool send(const std::string &data);
  3870. bool send(const char *data, size_t len);
  3871. void close(CloseStatus status = CloseStatus::Normal,
  3872. const std::string &reason = "");
  3873. const Request &request() const;
  3874. bool is_open() const;
  3875. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3876. // A server handler owns its connection's timeout this way; a client sets it
  3877. // through WebSocketClient. Safe to call while another thread is in read().
  3878. //
  3879. // Only a timeout set here is reported as Timeout. The compile-time default
  3880. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3881. // than a request for control, so when it elapses read() returns Fail and
  3882. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3883. void set_read_timeout(time_t sec, time_t usec = 0);
  3884. template <class Rep, class Period>
  3885. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3886. private:
  3887. friend class httplib::Server;
  3888. friend class httplib::ws::WebSocketClient;
  3889. WebSocket(
  3890. Stream &strm, const Request &req, bool is_server,
  3891. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3892. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3893. : strm_(strm), req_(req), is_server_(is_server),
  3894. ping_interval_sec_(ping_interval_sec),
  3895. max_missed_pongs_(max_missed_pongs) {
  3896. start_heartbeat();
  3897. }
  3898. WebSocket(
  3899. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3900. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3901. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3902. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3903. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3904. max_missed_pongs_(max_missed_pongs) {
  3905. start_heartbeat();
  3906. }
  3907. void start_heartbeat();
  3908. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3909. Stream &strm_;
  3910. std::unique_ptr<Stream> owned_strm_;
  3911. Request req_;
  3912. bool is_server_;
  3913. time_t ping_interval_sec_;
  3914. int max_missed_pongs_;
  3915. int unacked_pings_ = 0;
  3916. std::atomic<bool> closed_{false};
  3917. // Set when the peer stopped answering pings, to end a read() waiting on it
  3918. std::atomic<bool> pong_timed_out_{false};
  3919. // Set once the caller has bounded read() through set_read_timeout(). Until
  3920. // then the timeout in effect is the compile-time default, and elapsing it
  3921. // is a failure that closes the connection, not a Timeout.
  3922. std::atomic<bool> read_timeout_set_{false};
  3923. std::mutex write_mutex_;
  3924. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3925. // may do so: read_websocket_frame() reads a payload until it has the whole
  3926. // declared length, so a second parser stealing bytes silently corrupts the
  3927. // message the first one is assembling.
  3928. std::mutex read_mutex_;
  3929. std::thread ping_thread_;
  3930. std::mutex ping_mutex_;
  3931. std::condition_variable ping_cv_;
  3932. };
  3933. class WebSocketClient {
  3934. public:
  3935. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3936. const Headers &headers = {});
  3937. ~WebSocketClient();
  3938. WebSocketClient(const WebSocketClient &) = delete;
  3939. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3940. bool is_valid() const;
  3941. Result connect();
  3942. ReadResult read(std::string &msg);
  3943. bool send(const std::string &data);
  3944. bool send(const char *data, size_t len);
  3945. void close(CloseStatus status = CloseStatus::Normal,
  3946. const std::string &reason = "");
  3947. bool is_open() const;
  3948. const std::string &subprotocol() const;
  3949. void set_read_timeout(time_t sec, time_t usec = 0);
  3950. template <class Rep, class Period>
  3951. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3952. void set_write_timeout(time_t sec, time_t usec = 0);
  3953. template <class Rep, class Period>
  3954. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3955. void set_websocket_ping_interval(time_t sec);
  3956. void set_websocket_max_missed_pongs(int count);
  3957. void set_tcp_nodelay(bool on);
  3958. void set_address_family(int family);
  3959. void set_ipv6_v6only(bool on);
  3960. void set_socket_options(SocketOptions socket_options);
  3961. void set_connection_timeout(time_t sec, time_t usec = 0);
  3962. template <class Rep, class Period>
  3963. void
  3964. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3965. void set_interface(const std::string &intf);
  3966. [[deprecated("Use set_direct_hostname_addr_map() instead.")]]
  3967. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3968. void
  3969. set_direct_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3970. void
  3971. set_tunnel_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3972. void set_basic_auth(const std::string &username, const std::string &password);
  3973. void set_bearer_token_auth(const std::string &token);
  3974. void set_proxy(const std::string &host, int port);
  3975. void set_proxy_basic_auth(const std::string &username,
  3976. const std::string &password);
  3977. void set_proxy_bearer_token_auth(const std::string &token);
  3978. void set_no_proxy(const std::vector<std::string> &patterns);
  3979. #ifdef CPPHTTPLIB_SSL_ENABLED
  3980. struct PemMemory {
  3981. const char *cert_pem;
  3982. size_t cert_pem_len;
  3983. const char *key_pem;
  3984. size_t key_pem_len;
  3985. const char *private_key_password;
  3986. };
  3987. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3988. const PemMemory &pem, const Headers &headers = {});
  3989. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3990. const std::string &ca_cert_dir_path = std::string());
  3991. void set_ca_cert_store(tls::ca_store_t store);
  3992. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3993. void enable_server_certificate_verification(bool enabled);
  3994. void enable_server_hostname_verification(bool enabled);
  3995. void enable_system_ca(bool enabled);
  3996. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3997. void set_session_verifier(
  3998. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3999. void set_proxy_digest_auth(const std::string &username,
  4000. const std::string &password);
  4001. #endif
  4002. private:
  4003. void shutdown_and_close();
  4004. std::pair<time_t, time_t> handshake_timeout() const;
  4005. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  4006. int &ssl_error, uint64_t &ssl_backend_error);
  4007. void prepare_default_headers(Request &req);
  4008. bool is_proxy_enabled() const;
  4009. bool create_and_connect_socket(Error &error);
  4010. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  4011. bool connect_with_proxy(Response &proxy_res, Error &error);
  4012. std::string host_;
  4013. int port_;
  4014. std::string path_;
  4015. Headers headers_;
  4016. std::string subprotocol_;
  4017. bool is_valid_ = false;
  4018. socket_t sock_ = INVALID_SOCKET;
  4019. std::unique_ptr<WebSocket> ws_;
  4020. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  4021. time_t read_timeout_usec_ = 0;
  4022. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  4023. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  4024. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  4025. time_t websocket_ping_interval_sec_ =
  4026. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  4027. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  4028. int address_family_ = AF_UNSPEC;
  4029. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  4030. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  4031. SocketOptions socket_options_ = nullptr;
  4032. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  4033. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  4034. std::string interface_;
  4035. // Hostname to connection target map. The value is an IP literal or another
  4036. // hostname; only the connection target changes, never the identity.
  4037. std::map<std::string, std::string> addr_map_;
  4038. // Hostname to CONNECT target map, used only through a proxy.
  4039. std::map<std::string, std::string> tunnel_addr_map_;
  4040. std::string basic_auth_username_;
  4041. std::string basic_auth_password_;
  4042. std::string bearer_token_auth_token_;
  4043. std::string proxy_host_;
  4044. int proxy_port_ = -1;
  4045. std::string proxy_basic_auth_username_;
  4046. std::string proxy_basic_auth_password_;
  4047. std::string proxy_bearer_token_auth_token_;
  4048. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  4049. #ifdef CPPHTTPLIB_SSL_ENABLED
  4050. bool is_ssl_ = false;
  4051. tls::ctx_t tls_ctx_ = nullptr;
  4052. tls::session_t tls_session_ = nullptr;
  4053. std::string ca_cert_file_path_;
  4054. std::string ca_cert_dir_path_;
  4055. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  4056. // no certificate, so that a CA that failed to come through fails
  4057. // verification instead of letting the system CAs in.
  4058. bool custom_ca_loaded_ = false;
  4059. bool certs_loaded_ = false;
  4060. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  4061. bool server_certificate_verification_ = true;
  4062. bool server_hostname_verification_ = true;
  4063. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  4064. std::string proxy_digest_auth_username_;
  4065. std::string proxy_digest_auth_password_;
  4066. #endif
  4067. };
  4068. template <class Rep, class Period>
  4069. inline void WebSocket::set_read_timeout(
  4070. const std::chrono::duration<Rep, Period> &duration) {
  4071. detail::duration_to_sec_and_usec(
  4072. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4073. }
  4074. template <class Rep, class Period>
  4075. inline void WebSocketClient::set_read_timeout(
  4076. const std::chrono::duration<Rep, Period> &duration) {
  4077. detail::duration_to_sec_and_usec(
  4078. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  4079. }
  4080. template <class Rep, class Period>
  4081. inline void WebSocketClient::set_write_timeout(
  4082. const std::chrono::duration<Rep, Period> &duration) {
  4083. detail::duration_to_sec_and_usec(
  4084. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  4085. }
  4086. template <class Rep, class Period>
  4087. inline void WebSocketClient::set_connection_timeout(
  4088. const std::chrono::duration<Rep, Period> &duration) {
  4089. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4090. set_connection_timeout(sec, usec);
  4091. });
  4092. }
  4093. namespace impl {
  4094. bool is_valid_utf8(const std::string &s);
  4095. // Three states, because a failure that consumed bytes and one that consumed
  4096. // none are not the same thing: the first has left the stream in the middle of
  4097. // a frame and the connection cannot be reused, the second can just be retried.
  4098. enum class FrameRead { Ok, Fail, Timeout };
  4099. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4100. std::string &payload, bool &fin,
  4101. bool expect_masked, size_t max_len);
  4102. } // namespace impl
  4103. } // namespace ws
  4104. // ----------------------------------------------------------------------------
  4105. /*
  4106. * Implementation that will be part of the .cc file if split into .h + .cc.
  4107. */
  4108. namespace stream {
  4109. // stream::Result implementations
  4110. inline Result::Result() : chunk_size_(8192) {}
  4111. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4112. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4113. inline Result::Result(Result &&other) noexcept
  4114. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4115. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4116. finished_(other.finished_) {
  4117. other.current_size_ = 0;
  4118. other.finished_ = true;
  4119. }
  4120. inline Result &Result::operator=(Result &&other) noexcept {
  4121. if (this != &other) {
  4122. handle_ = std::move(other.handle_);
  4123. buffer_ = std::move(other.buffer_);
  4124. current_size_ = other.current_size_;
  4125. chunk_size_ = other.chunk_size_;
  4126. finished_ = other.finished_;
  4127. other.current_size_ = 0;
  4128. other.finished_ = true;
  4129. }
  4130. return *this;
  4131. }
  4132. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4133. inline Result::operator bool() const { return is_valid(); }
  4134. inline int Result::status() const {
  4135. return handle_.response ? handle_.response->status : -1;
  4136. }
  4137. inline const Headers &Result::headers() const {
  4138. static const Headers empty_headers;
  4139. return handle_.response ? handle_.response->headers : empty_headers;
  4140. }
  4141. inline std::string Result::get_header_value(const std::string &key,
  4142. const char *def) const {
  4143. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4144. }
  4145. inline bool Result::has_header(const std::string &key) const {
  4146. return handle_.response ? handle_.response->has_header(key) : false;
  4147. }
  4148. inline Error Result::error() const { return handle_.error; }
  4149. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4150. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4151. inline bool Result::next() {
  4152. if (!handle_.is_valid() || finished_) { return false; }
  4153. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4154. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4155. if (n > 0) {
  4156. current_size_ = static_cast<size_t>(n);
  4157. return true;
  4158. }
  4159. current_size_ = 0;
  4160. finished_ = true;
  4161. return false;
  4162. }
  4163. inline const char *Result::data() const { return buffer_.data(); }
  4164. inline size_t Result::size() const { return current_size_; }
  4165. inline std::string Result::read_all() {
  4166. std::string result;
  4167. while (next()) {
  4168. result.append(data(), size());
  4169. }
  4170. return result;
  4171. }
  4172. } // namespace stream
  4173. namespace detail {
  4174. inline SSEParser::SSEParser(EventHandler on_event, IdHandler on_id,
  4175. RetryHandler on_retry, size_t max_event_length)
  4176. : on_event_(std::move(on_event)), on_id_(std::move(on_id)),
  4177. on_retry_(std::move(on_retry)), max_event_length_(max_event_length) {}
  4178. inline bool SSEParser::parse(const char *buf, size_t n) {
  4179. // What is left in the buffer has no line ending
  4180. auto search_pos = buffer_.size();
  4181. buffer_.append(buf, n);
  4182. // A line ends with \r\n, \n or \r per the SSE spec
  4183. size_t line_start = 0;
  4184. size_t eol_pos;
  4185. while ((eol_pos = buffer_.find_first_of("\r\n", search_pos)) !=
  4186. std::string::npos) {
  4187. auto line = buffer_.substr(line_start, eol_pos - line_start);
  4188. line_start = eol_pos + 1;
  4189. search_pos = line_start;
  4190. // The \n of a \r\n may arrive in a later chunk than its \r
  4191. auto is_lf_of_crlf = after_cr_ && line.empty() && buffer_[eol_pos] == '\n';
  4192. after_cr_ = buffer_[eol_pos] == '\r';
  4193. if (is_lf_of_crlf) { continue; }
  4194. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4195. if (first_line_) {
  4196. first_line_ = false;
  4197. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4198. }
  4199. parse_line(line);
  4200. }
  4201. // Keep unprocessed data in buffer
  4202. buffer_.erase(0, line_start);
  4203. return max_event_length_ == 0 ||
  4204. buffer_.size() + msg_.data.size() <= max_event_length_;
  4205. }
  4206. inline void SSEParser::parse_line(const std::string &line) {
  4207. // Blank line signals end of event
  4208. if (line.empty()) {
  4209. // The id counts for Last-Event-ID even for an event that has no data. An
  4210. // empty id clears it.
  4211. if (has_id_ && on_id_) { on_id_(msg_.id); }
  4212. // An event without a data field is not dispatched
  4213. if (has_data_ && on_event_) { on_event_(msg_); }
  4214. msg_.clear();
  4215. has_data_ = false;
  4216. has_id_ = false;
  4217. return;
  4218. }
  4219. // Lines starting with ':' are comments (ignored)
  4220. if (line[0] == ':') { return; }
  4221. // Find the colon separator
  4222. auto colon_pos = line.find(':');
  4223. auto field = line.substr(0, colon_pos);
  4224. std::string value;
  4225. // Value starts after colon, skip optional single space
  4226. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4227. auto value_start = colon_pos + 1;
  4228. if (line[value_start] == ' ') { value_start++; }
  4229. value = line.substr(value_start);
  4230. }
  4231. // Handle known fields
  4232. if (field == "event") {
  4233. // An empty event type is dispatched as "message" per the SSE spec
  4234. msg_.event = value.empty() ? std::string("message") : std::move(value);
  4235. } else if (field == "data") {
  4236. // Multiple data lines are concatenated with newlines
  4237. if (has_data_) { msg_.data += "\n"; }
  4238. msg_.data += value;
  4239. has_data_ = true;
  4240. } else if (field == "id") {
  4241. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4242. // valid (clears the last event ID)
  4243. if (fields::is_field_value(value)) {
  4244. msg_.id = value;
  4245. has_id_ = true;
  4246. }
  4247. } else if (field == "retry") {
  4248. // Parse retry interval in milliseconds
  4249. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4250. if (is_numeric(value)) {
  4251. int v = 0;
  4252. auto res = from_chars(value.data(), value.data() + value.size(), v);
  4253. if (res.ec == std::errc{} && on_retry_) { on_retry_(v); }
  4254. }
  4255. }
  4256. // Unknown fields are ignored per SSE spec
  4257. }
  4258. } // namespace detail
  4259. namespace sse {
  4260. // SSEMessage implementations
  4261. inline SSEMessage::SSEMessage() : event("message") {}
  4262. inline void SSEMessage::clear() {
  4263. event = "message";
  4264. data.clear();
  4265. id.clear();
  4266. }
  4267. // SSEClient implementations
  4268. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4269. : client_(client), path_(path) {}
  4270. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4271. const Headers &headers)
  4272. : client_(client), path_(path), headers_(headers) {}
  4273. inline SSEClient::~SSEClient() { stop(); }
  4274. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4275. on_message_ = std::move(handler);
  4276. return *this;
  4277. }
  4278. inline SSEClient &SSEClient::on_event(const std::string &type,
  4279. MessageHandler handler) {
  4280. event_handlers_[type] = std::move(handler);
  4281. return *this;
  4282. }
  4283. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4284. on_open_ = std::move(handler);
  4285. return *this;
  4286. }
  4287. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4288. on_error_ = std::move(handler);
  4289. return *this;
  4290. }
  4291. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4292. reconnect_interval_ms_ = ms;
  4293. return *this;
  4294. }
  4295. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4296. max_reconnect_attempts_ = n;
  4297. return *this;
  4298. }
  4299. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4300. std::lock_guard<std::mutex> lock(headers_mutex_);
  4301. headers_ = headers;
  4302. return *this;
  4303. }
  4304. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4305. inline std::string SSEClient::last_event_id() const {
  4306. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4307. return last_event_id_;
  4308. }
  4309. inline void SSEClient::start() {
  4310. running_.store(true);
  4311. run_event_loop();
  4312. }
  4313. inline void SSEClient::start_async() {
  4314. running_.store(true);
  4315. async_thread_ = std::thread([this]() { run_event_loop(); });
  4316. }
  4317. inline void SSEClient::stop() {
  4318. running_.store(false);
  4319. client_.stop(); // Cancel any pending operations
  4320. if (async_thread_.joinable()) { async_thread_.join(); }
  4321. }
  4322. inline void SSEClient::run_event_loop() {
  4323. auto reconnect_count = 0;
  4324. while (running_.load()) {
  4325. // Build headers, including Last-Event-ID if we have one
  4326. Headers request_headers;
  4327. {
  4328. std::lock_guard<std::mutex> lock(headers_mutex_);
  4329. request_headers = headers_;
  4330. }
  4331. if (!last_event_id_.empty()) {
  4332. request_headers.emplace("Last-Event-ID", last_event_id_);
  4333. }
  4334. // Open streaming connection. An event stream has no end, so each event is
  4335. // bounded instead of the whole body.
  4336. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4337. handle.body_reader_.payload_max_length = 0;
  4338. // stop() ends a read that is waiting for the next event
  4339. if (handle.stream_) {
  4340. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4341. }
  4342. stream::Result result{std::move(handle)};
  4343. // Connection error handling
  4344. if (!result) {
  4345. connected_.store(false);
  4346. if (on_error_) { on_error_(result.error()); }
  4347. if (!should_reconnect(reconnect_count)) { break; }
  4348. wait_for_reconnect();
  4349. reconnect_count++;
  4350. continue;
  4351. }
  4352. if (result.status() != StatusCode::OK_200) {
  4353. connected_.store(false);
  4354. if (on_error_) { on_error_(Error::Connection); }
  4355. // For certain errors, don't reconnect.
  4356. // Note: 401 is intentionally absent so that handlers can refresh
  4357. // credentials via set_headers() and let the client reconnect.
  4358. if (result.status() == StatusCode::NoContent_204 ||
  4359. result.status() == StatusCode::NotFound_404 ||
  4360. result.status() == StatusCode::Forbidden_403) {
  4361. break;
  4362. }
  4363. if (!should_reconnect(reconnect_count)) { break; }
  4364. wait_for_reconnect();
  4365. reconnect_count++;
  4366. continue;
  4367. }
  4368. // Connection successful
  4369. connected_.store(true);
  4370. reconnect_count = 0;
  4371. if (on_open_) { on_open_(); }
  4372. // Event receiving loop
  4373. detail::SSEParser parser(
  4374. [this](const SSEMessage &msg) { dispatch_event(msg); },
  4375. [this](const std::string &id) {
  4376. std::lock_guard<std::mutex> lock(last_event_id_mutex_);
  4377. last_event_id_ = id;
  4378. },
  4379. [this](int retry_ms) { reconnect_interval_ms_ = retry_ms; });
  4380. auto event_too_long = false;
  4381. while (running_.load() && result.next()) {
  4382. if (!parser.parse(result.data(), result.size())) {
  4383. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4384. event_too_long = true;
  4385. break;
  4386. }
  4387. }
  4388. // Connection ended
  4389. connected_.store(false);
  4390. // Reconnecting would only get the same event again
  4391. if (!running_.load() || event_too_long) { break; }
  4392. // Check for read errors
  4393. if (result.has_read_error()) {
  4394. if (on_error_) { on_error_(result.read_error()); }
  4395. }
  4396. if (!should_reconnect(reconnect_count)) { break; }
  4397. wait_for_reconnect();
  4398. reconnect_count++;
  4399. }
  4400. connected_.store(false);
  4401. }
  4402. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4403. // Check for specific event type handler first
  4404. auto it = event_handlers_.find(msg.event);
  4405. if (it != event_handlers_.end()) {
  4406. it->second(msg);
  4407. return;
  4408. }
  4409. // Fall back to generic message handler
  4410. if (on_message_) { on_message_(msg); }
  4411. }
  4412. inline bool SSEClient::should_reconnect(int count) const {
  4413. if (!running_.load()) { return false; }
  4414. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4415. return count < max_reconnect_attempts_;
  4416. }
  4417. inline void SSEClient::wait_for_reconnect() {
  4418. // Use small increments to check running_ flag frequently.
  4419. // Always wait at least one increment, so that a zero interval (e.g.
  4420. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4421. const auto step_ms = 100;
  4422. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4423. auto waited = 0;
  4424. while (running_.load() && waited < interval_ms) {
  4425. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4426. waited += step_ms;
  4427. }
  4428. }
  4429. } // namespace sse
  4430. #ifdef CPPHTTPLIB_SSL_ENABLED
  4431. /*
  4432. * TLS abstraction layer - internal function declarations
  4433. * These are implementation details and not part of the public API.
  4434. */
  4435. namespace tls {
  4436. // Client context
  4437. ctx_t create_client_context();
  4438. void free_context(ctx_t ctx);
  4439. bool set_min_version(ctx_t ctx, Version version);
  4440. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4441. bool load_ca_file(ctx_t ctx, const char *file_path);
  4442. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4443. bool load_system_certs(ctx_t ctx);
  4444. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4445. const char *password);
  4446. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4447. const char *key_path, const char *password);
  4448. // Server context
  4449. ctx_t create_server_context();
  4450. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4451. const char *password);
  4452. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4453. const char *key_path, const char *password);
  4454. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4455. void set_verify_client(ctx_t ctx, bool require);
  4456. // Session management
  4457. session_t create_session(ctx_t ctx, socket_t sock);
  4458. void free_session(session_t session);
  4459. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4460. // Handshake (non-blocking capable)
  4461. TlsError connect(session_t session);
  4462. TlsError accept(session_t session);
  4463. // Handshake with timeout (blocking until timeout)
  4464. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4465. time_t timeout_usec, TlsError *err);
  4466. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4467. time_t timeout_usec, TlsError *err);
  4468. // I/O (non-blocking capable)
  4469. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4470. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4471. int pending(const_session_t session);
  4472. void shutdown(session_t session, bool graceful);
  4473. // Connection state
  4474. bool is_peer_closed(session_t session, socket_t sock);
  4475. // Certificate verification
  4476. cert_t get_peer_cert(const_session_t session);
  4477. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4478. // do not use them after free_session(), as with get_peer_cert().
  4479. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4480. void free_cert(cert_t cert);
  4481. // Matches the host against the subjectAltName entries only, never the Common
  4482. // Name (RFC 9525).
  4483. bool verify_hostname(cert_t cert, const char *hostname);
  4484. uint64_t hostname_mismatch_code();
  4485. long get_verify_result(const_session_t session);
  4486. // Certificate introspection
  4487. std::string get_cert_subject_cn(cert_t cert);
  4488. std::string get_cert_issuer_name(cert_t cert);
  4489. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4490. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4491. std::string get_cert_serial(cert_t cert);
  4492. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4493. const char *get_sni(const_session_t session);
  4494. // CA store management
  4495. ca_store_t create_ca_store(const char *pem, size_t len);
  4496. void free_ca_store(ca_store_t store);
  4497. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4498. // Free each with free_cert(), and do not use them once the context's CA
  4499. // certificates change.
  4500. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4501. std::vector<std::string> get_ca_names(ctx_t ctx);
  4502. // Dynamic certificate update (for servers)
  4503. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4504. const char *password);
  4505. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4506. // Certificate verification callback
  4507. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4508. long get_verify_error(const_session_t session);
  4509. std::string verify_error_string(long error_code);
  4510. // TlsError information
  4511. uint64_t peek_error();
  4512. uint64_t get_error();
  4513. std::string error_string(uint64_t code);
  4514. } // namespace tls
  4515. #endif // CPPHTTPLIB_SSL_ENABLED
  4516. /*
  4517. * Group 1: detail namespace - Non-SSL utilities
  4518. */
  4519. namespace detail {
  4520. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4521. const void *optval, socklen_t optlen) {
  4522. return setsockopt(sock, level, optname,
  4523. #ifdef _WIN32
  4524. reinterpret_cast<const char *>(optval),
  4525. #else
  4526. optval,
  4527. #endif
  4528. optlen) == 0;
  4529. }
  4530. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4531. time_t sec, time_t usec) {
  4532. #ifdef _WIN32
  4533. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4534. #else
  4535. timeval timeout;
  4536. timeout.tv_sec = static_cast<long>(sec);
  4537. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4538. #endif
  4539. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4540. }
  4541. inline bool is_hex(char c, int &v) {
  4542. if (is_ascii_digit(c)) {
  4543. v = c - '0';
  4544. return true;
  4545. } else if ('A' <= c && c <= 'F') {
  4546. v = c - 'A' + 10;
  4547. return true;
  4548. } else if ('a' <= c && c <= 'f') {
  4549. v = c - 'a' + 10;
  4550. return true;
  4551. }
  4552. return false;
  4553. }
  4554. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4555. int &val) {
  4556. if (i >= s.size()) { return false; }
  4557. val = 0;
  4558. for (; cnt; i++, cnt--) {
  4559. if (!s[i]) { return false; }
  4560. auto v = 0;
  4561. if (is_hex(s[i], v)) {
  4562. val = val * 16 + v;
  4563. } else {
  4564. return false;
  4565. }
  4566. }
  4567. return true;
  4568. }
  4569. inline std::string from_i_to_hex(size_t n) {
  4570. static const auto charset = "0123456789abcdef";
  4571. std::string ret;
  4572. do {
  4573. ret = charset[n & 15] + ret;
  4574. n >>= 4;
  4575. } while (n > 0);
  4576. return ret;
  4577. }
  4578. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4579. // builds and trips -Wtautological-type-limit-compare.
  4580. inline bool fits_in_size_t(uint64_t n) {
  4581. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4582. }
  4583. inline std::string compute_etag(const FileStat &fs,
  4584. const std::string &suffix = std::string()) {
  4585. if (!fs.is_file()) { return std::string(); }
  4586. // If mtime cannot be determined (negative value indicates an error
  4587. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4588. // value like 0 could collide with a real file that legitimately has
  4589. // mtime == 0 (epoch) and lead to misleading validators.
  4590. auto mtime_raw = fs.mtime();
  4591. if (mtime_raw < 0) { return std::string(); }
  4592. auto mtime = static_cast<size_t>(mtime_raw);
  4593. auto size = fs.size();
  4594. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4595. from_i_to_hex(size) + suffix + "\"";
  4596. }
  4597. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4598. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4599. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4600. inline std::string file_mtime_to_http_date(time_t mtime) {
  4601. if (mtime < 0) { return std::string(); }
  4602. struct tm tm_buf;
  4603. #ifdef _WIN32
  4604. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4605. #else
  4606. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4607. #endif
  4608. char buf[64];
  4609. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4610. return std::string();
  4611. }
  4612. return std::string(buf);
  4613. }
  4614. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4615. inline time_t parse_http_date(const std::string &date_str) {
  4616. struct tm tm_buf;
  4617. // Create a classic locale object once for all parsing attempts
  4618. const std::locale classic_locale = std::locale::classic();
  4619. // Try to parse using std::get_time (C++11, cross-platform)
  4620. auto try_parse = [&](const char *fmt) -> bool {
  4621. std::istringstream ss(date_str);
  4622. ss.imbue(classic_locale);
  4623. memset(&tm_buf, 0, sizeof(tm_buf));
  4624. ss >> std::get_time(&tm_buf, fmt);
  4625. return !ss.fail();
  4626. };
  4627. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4628. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4629. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4630. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4631. // asctime format: "Sun Nov 6 08:49:37 1994"
  4632. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4633. return static_cast<time_t>(-1);
  4634. }
  4635. }
  4636. }
  4637. #ifdef _WIN32
  4638. return _mkgmtime(&tm_buf);
  4639. #elif defined _AIX
  4640. return mktime(&tm_buf);
  4641. #else
  4642. return timegm(&tm_buf);
  4643. #endif
  4644. }
  4645. inline bool is_weak_etag(const std::string &s) {
  4646. // Check if the string is a weak ETag (starts with 'W/"')
  4647. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4648. }
  4649. inline bool is_strong_etag(const std::string &s) {
  4650. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4651. // chars)
  4652. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4653. }
  4654. inline size_t to_utf8(int code, char *buff) {
  4655. if (code < 0x0080) {
  4656. buff[0] = static_cast<char>(code & 0x7F);
  4657. return 1;
  4658. } else if (code < 0x0800) {
  4659. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4660. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4661. return 2;
  4662. } else if (code < 0xD800) {
  4663. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4664. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4665. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4666. return 3;
  4667. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4668. return 0;
  4669. } else if (code < 0x10000) {
  4670. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4671. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4672. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4673. return 3;
  4674. } else if (code < 0x110000) {
  4675. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4676. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4677. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4678. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4679. return 4;
  4680. }
  4681. // NOTREACHED
  4682. return 0;
  4683. }
  4684. } // namespace detail
  4685. namespace ws {
  4686. namespace impl {
  4687. inline bool is_valid_utf8(const std::string &s) {
  4688. size_t i = 0;
  4689. auto n = s.size();
  4690. while (i < n) {
  4691. auto c = static_cast<unsigned char>(s[i]);
  4692. size_t len;
  4693. uint32_t cp;
  4694. if (c < 0x80) {
  4695. i++;
  4696. continue;
  4697. } else if ((c & 0xE0) == 0xC0) {
  4698. len = 2;
  4699. cp = c & 0x1F;
  4700. } else if ((c & 0xF0) == 0xE0) {
  4701. len = 3;
  4702. cp = c & 0x0F;
  4703. } else if ((c & 0xF8) == 0xF0) {
  4704. len = 4;
  4705. cp = c & 0x07;
  4706. } else {
  4707. return false;
  4708. }
  4709. if (i + len > n) { return false; }
  4710. for (size_t j = 1; j < len; j++) {
  4711. auto b = static_cast<unsigned char>(s[i + j]);
  4712. if ((b & 0xC0) != 0x80) { return false; }
  4713. cp = (cp << 6) | (b & 0x3F);
  4714. }
  4715. // Overlong encoding check
  4716. if (len == 2 && cp < 0x80) { return false; }
  4717. if (len == 3 && cp < 0x800) { return false; }
  4718. if (len == 4 && cp < 0x10000) { return false; }
  4719. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4720. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4721. if (cp > 0x10FFFF) { return false; }
  4722. i += len;
  4723. }
  4724. return true;
  4725. }
  4726. } // namespace impl
  4727. } // namespace ws
  4728. namespace detail {
  4729. // NOTE: This code came up with the following stackoverflow post:
  4730. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4731. inline std::string base64_encode(const std::string &in) {
  4732. static const auto lookup =
  4733. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4734. std::string out;
  4735. out.reserve(in.size());
  4736. // Unsigned: the accumulator is never masked, so with a signed int the
  4737. // `val << 8` below overflows once enough bytes are folded in (undefined
  4738. // behaviour before C++20). Only the low bits are ever emitted, so the
  4739. // wrap-around of an unsigned accumulator does not affect the output.
  4740. uint32_t val = 0;
  4741. auto valb = -6;
  4742. for (auto c : in) {
  4743. val = (val << 8) + static_cast<uint8_t>(c);
  4744. valb += 8;
  4745. while (valb >= 0) {
  4746. out.push_back(lookup[(val >> valb) & 0x3F]);
  4747. valb -= 6;
  4748. }
  4749. }
  4750. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4751. while (out.size() % 4) {
  4752. out.push_back('=');
  4753. }
  4754. return out;
  4755. }
  4756. inline std::string sha1(const std::string &input) {
  4757. // RFC 3174 SHA-1 implementation
  4758. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4759. return (x << n) | (x >> (32 - n));
  4760. };
  4761. uint32_t h0 = 0x67452301;
  4762. uint32_t h1 = 0xEFCDAB89;
  4763. uint32_t h2 = 0x98BADCFE;
  4764. uint32_t h3 = 0x10325476;
  4765. uint32_t h4 = 0xC3D2E1F0;
  4766. // Pre-processing: adding padding bits
  4767. std::string msg = input;
  4768. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4769. msg.push_back(static_cast<char>(0x80u));
  4770. while (msg.size() % 64 != 56) {
  4771. msg.push_back(0);
  4772. }
  4773. // Append original length in bits as 64-bit big-endian
  4774. for (int i = 56; i >= 0; i -= 8) {
  4775. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4776. }
  4777. // Process each 512-bit chunk
  4778. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4779. uint32_t w[80];
  4780. for (size_t i = 0; i < 16; i++) {
  4781. w[i] =
  4782. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4783. << 24) |
  4784. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4785. << 16) |
  4786. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4787. << 8) |
  4788. (static_cast<uint32_t>(
  4789. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4790. }
  4791. for (int i = 16; i < 80; i++) {
  4792. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4793. }
  4794. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4795. for (int i = 0; i < 80; i++) {
  4796. uint32_t f, k;
  4797. if (i < 20) {
  4798. f = (b & c) | ((~b) & d);
  4799. k = 0x5A827999;
  4800. } else if (i < 40) {
  4801. f = b ^ c ^ d;
  4802. k = 0x6ED9EBA1;
  4803. } else if (i < 60) {
  4804. f = (b & c) | (b & d) | (c & d);
  4805. k = 0x8F1BBCDC;
  4806. } else {
  4807. f = b ^ c ^ d;
  4808. k = 0xCA62C1D6;
  4809. }
  4810. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4811. e = d;
  4812. d = c;
  4813. c = left_rotate(b, 30);
  4814. b = a;
  4815. a = temp;
  4816. }
  4817. h0 += a;
  4818. h1 += b;
  4819. h2 += c;
  4820. h3 += d;
  4821. h4 += e;
  4822. }
  4823. // Produce the final hash as a 20-byte binary string
  4824. std::string hash(20, '\0');
  4825. for (size_t i = 0; i < 4; i++) {
  4826. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4827. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4828. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4829. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4830. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4831. }
  4832. return hash;
  4833. }
  4834. inline std::string websocket_accept_key(const std::string &client_key) {
  4835. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4836. return base64_encode(sha1(client_key + magic));
  4837. }
  4838. inline bool is_websocket_upgrade(const Request &req) {
  4839. if (req.method != "GET") { return false; }
  4840. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4841. // list of protocols and asks recipients to match each name
  4842. // case-insensitively, so look for the token rather than compare the whole
  4843. // field value.
  4844. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4845. // Check Connection: Upgrade
  4846. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4847. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4848. // RFC 6455 Section 4.2.1
  4849. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4850. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4851. return false;
  4852. }
  4853. static const std::string b64chars =
  4854. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4855. for (size_t i = 0; i < 22; i++) {
  4856. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4857. }
  4858. // Check Sec-WebSocket-Version: 13
  4859. auto version = req.get_header_value("Sec-WebSocket-Version");
  4860. if (version != "13") { return false; }
  4861. return true;
  4862. }
  4863. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4864. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4865. thread_local std::random_device rd;
  4866. size_t filled = 0;
  4867. while (filled < n) {
  4868. auto v = rd();
  4869. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4870. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4871. }
  4872. }
  4873. }
  4874. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4875. const char *data, size_t len, bool fin,
  4876. bool mask) {
  4877. // First byte: FIN + opcode
  4878. uint8_t header[2];
  4879. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4880. (static_cast<uint8_t>(opcode) & 0x0F));
  4881. // Second byte: MASK + payload length
  4882. if (len < 126) {
  4883. header[1] = static_cast<uint8_t>(len);
  4884. if (mask) { header[1] |= 0x80; }
  4885. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4886. return false;
  4887. }
  4888. } else if (len <= 0xFFFF) {
  4889. header[1] = 126;
  4890. if (mask) { header[1] |= 0x80; }
  4891. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4892. return false;
  4893. }
  4894. uint8_t ext[2];
  4895. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4896. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4897. if (!write_data(strm, reinterpret_cast<char *>(ext), 2)) { return false; }
  4898. } else {
  4899. header[1] = 127;
  4900. if (mask) { header[1] |= 0x80; }
  4901. if (!write_data(strm, reinterpret_cast<char *>(header), 2)) {
  4902. return false;
  4903. }
  4904. uint8_t ext[8];
  4905. for (int i = 7; i >= 0; i--) {
  4906. ext[7 - i] =
  4907. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4908. }
  4909. if (!write_data(strm, reinterpret_cast<char *>(ext), 8)) { return false; }
  4910. }
  4911. if (mask) {
  4912. // Generate random mask key
  4913. uint8_t mask_key[4];
  4914. fill_random_bytes(mask_key, sizeof(mask_key));
  4915. if (!write_data(strm, reinterpret_cast<char *>(mask_key), 4)) {
  4916. return false;
  4917. }
  4918. // Write masked payload in chunks
  4919. const size_t chunk_size = 4096;
  4920. std::vector<char> buf((std::min)(len, chunk_size));
  4921. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4922. size_t n = (std::min)(chunk_size, len - offset);
  4923. for (size_t i = 0; i < n; i++) {
  4924. buf[i] =
  4925. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4926. }
  4927. if (!write_data(strm, buf.data(), n)) { return false; }
  4928. }
  4929. } else {
  4930. if (len > 0) {
  4931. if (!write_data(strm, data, len)) { return false; }
  4932. }
  4933. }
  4934. return true;
  4935. }
  4936. } // namespace detail
  4937. namespace ws {
  4938. namespace impl {
  4939. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4940. // hands back whatever its buffer already holds -- so every multi-byte field has
  4941. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4942. // header straddles the read buffer's boundary.
  4943. //
  4944. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4945. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4946. // there is a failure like any other. (When read() fails it always records why,
  4947. // so the error belongs to this call and not to an earlier one.)
  4948. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4949. auto p = static_cast<char *>(buf);
  4950. size_t total = 0;
  4951. while (total < size) {
  4952. auto n = strm.read(p + total, size - total);
  4953. if (n <= 0) {
  4954. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4955. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4956. }
  4957. total += static_cast<size_t>(n);
  4958. }
  4959. return FrameRead::Ok;
  4960. }
  4961. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4962. std::string &payload, bool &fin,
  4963. bool expect_masked, size_t max_len) {
  4964. // Read first 2 bytes. This is the only read that may report a timeout: it
  4965. // sits on a frame boundary, where nothing has been consumed yet.
  4966. uint8_t header[2];
  4967. FrameRead first = read_exact(strm, header, 2);
  4968. if (first != FrameRead::Ok) { return first; }
  4969. fin = (header[0] & 0x80) != 0;
  4970. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4971. if (header[0] & 0x70) { return FrameRead::Fail; }
  4972. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4973. bool masked = (header[1] & 0x80) != 0;
  4974. uint64_t payload_len = header[1] & 0x7F;
  4975. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4976. // MUST have a payload length of 125 bytes or less
  4977. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4978. if (is_control) {
  4979. if (!fin) { return FrameRead::Fail; }
  4980. if (payload_len > 125) { return FrameRead::Fail; }
  4981. }
  4982. if (masked != expect_masked) { return FrameRead::Fail; }
  4983. // Extended payload length
  4984. if (payload_len == 126) {
  4985. uint8_t ext[2];
  4986. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4987. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4988. } else if (payload_len == 127) {
  4989. uint8_t ext[8];
  4990. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4991. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4992. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4993. payload_len = 0;
  4994. for (int i = 0; i < 8; i++) {
  4995. payload_len = (payload_len << 8) | ext[i];
  4996. }
  4997. }
  4998. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4999. // size_t cannot hold (32-bit builds) is refused either way.
  5000. if ((max_len > 0 && payload_len > max_len) ||
  5001. !detail::fits_in_size_t(payload_len)) {
  5002. return FrameRead::Fail;
  5003. }
  5004. // Read mask key if present
  5005. uint8_t mask_key[4] = {0};
  5006. if (masked) {
  5007. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  5008. return FrameRead::Fail;
  5009. }
  5010. }
  5011. // Grow the payload only as it arrives, since a header alone can announce
  5012. // max_len bytes that never come.
  5013. payload.clear();
  5014. auto len = static_cast<size_t>(payload_len);
  5015. while (payload.size() < len) {
  5016. auto offset = payload.size();
  5017. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  5018. payload.resize(offset + n);
  5019. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  5020. return FrameRead::Fail;
  5021. }
  5022. }
  5023. // Unmask if needed
  5024. if (masked) {
  5025. for (size_t i = 0; i < payload.size(); i++) {
  5026. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  5027. }
  5028. }
  5029. return FrameRead::Ok;
  5030. }
  5031. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  5032. // be sent followed by a UTF-8 reason.
  5033. inline bool is_valid_close_payload(const std::string &payload) {
  5034. if (payload.empty()) { return true; }
  5035. if (payload.size() < 2) { return false; }
  5036. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  5037. static_cast<uint8_t>(payload[1]);
  5038. auto may_be_sent = (1000 <= code && code <= 1003) ||
  5039. (1007 <= code && code <= 1014) ||
  5040. (3000 <= code && code <= 4999);
  5041. return may_be_sent && is_valid_utf8(payload.substr(2));
  5042. }
  5043. } // namespace impl
  5044. } // namespace ws
  5045. namespace detail {
  5046. // A path a mount point serves: absolute, with no empty segment except a
  5047. // trailing '/', no segment ending in '.' or a space (which covers "." and
  5048. // ".." and names Windows trims into another file's name) and, on Windows, no
  5049. // ':' (which names an NTFS stream, so "a.txt::$DATA" is a.txt), so the file
  5050. // served is the one that req.path names to the handlers that ran before it.
  5051. inline bool is_valid_path(const std::string &path) {
  5052. if (path.empty() || path[0] != '/') { return false; }
  5053. auto beg = size_t{1};
  5054. for (auto i = beg; i <= path.size(); i++) {
  5055. if (i < path.size() && path[i] != '/') {
  5056. if (path[i] == '\0' || path[i] == '\\') { return false; }
  5057. #ifdef _WIN32
  5058. if (path[i] == ':') { return false; }
  5059. #endif
  5060. continue;
  5061. }
  5062. auto len = i - beg;
  5063. if ((len == 0 && i < path.size()) ||
  5064. (len > 0 && (path[i - 1] == '.' || path[i - 1] == ' '))) {
  5065. return false;
  5066. }
  5067. beg = i + 1;
  5068. }
  5069. return true;
  5070. }
  5071. inline bool canonicalize_path(const char *path, std::string &resolved) {
  5072. #if defined(_WIN32)
  5073. // Resolve junctions and symlinks, as realpath() does
  5074. auto wpath = u8string_to_wstring(path);
  5075. if (wpath.empty()) { return false; }
  5076. CREATEFILE2_EXTENDED_PARAMETERS params{};
  5077. params.dwSize = sizeof(params);
  5078. params.dwFileFlags = FILE_FLAG_BACKUP_SEMANTICS; // Needed to open a directory
  5079. auto h = ::CreateFile2(wpath.c_str(), 0,
  5080. FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
  5081. OPEN_EXISTING, &params);
  5082. if (h == INVALID_HANDLE_VALUE) { return false; }
  5083. auto guard = scope_exit([&]() { ::CloseHandle(h); });
  5084. std::wstring wbuf(MAX_PATH, L'\0');
  5085. auto len = ::GetFinalPathNameByHandleW(
  5086. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5087. if (len >= wbuf.size()) {
  5088. wbuf.resize(len);
  5089. len = ::GetFinalPathNameByHandleW(
  5090. h, &wbuf[0], static_cast<DWORD>(wbuf.size()), FILE_NAME_NORMALIZED);
  5091. }
  5092. if (len == 0 || len >= wbuf.size()) { return false; }
  5093. auto n = ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5094. nullptr, 0, nullptr, nullptr);
  5095. if (n <= 0) { return false; }
  5096. resolved.assign(static_cast<size_t>(n), '\0');
  5097. ::WideCharToMultiByte(CP_UTF8, 0, wbuf.data(), static_cast<int>(len),
  5098. &resolved[0], n, nullptr, nullptr);
  5099. #elif defined(PATH_MAX)
  5100. char buf[PATH_MAX];
  5101. if (realpath(path, buf) == nullptr) { return false; }
  5102. resolved = buf;
  5103. #else
  5104. auto buf = realpath(path, nullptr);
  5105. auto guard = scope_exit([&]() { std::free(buf); });
  5106. if (buf == nullptr) { return false; }
  5107. resolved = buf;
  5108. #endif
  5109. return true;
  5110. }
  5111. inline bool is_path_within_base(const std::string &resolved_path,
  5112. const std::string &resolved_base) {
  5113. #if defined(_WIN32)
  5114. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  5115. resolved_base.size()) == 0;
  5116. #else
  5117. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  5118. resolved_base.size()) == 0;
  5119. #endif
  5120. }
  5121. inline FileStat::FileStat(const std::string &path) {
  5122. #if defined(_WIN32)
  5123. auto wpath = u8string_to_wstring(path.c_str());
  5124. ret_ = _wstat(wpath.c_str(), &st_);
  5125. #else
  5126. ret_ = stat(path.c_str(), &st_);
  5127. #endif
  5128. }
  5129. inline bool FileStat::is_file() const {
  5130. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5131. }
  5132. inline bool FileStat::is_dir() const {
  5133. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5134. }
  5135. inline time_t FileStat::mtime() const {
  5136. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5137. : static_cast<time_t>(-1);
  5138. }
  5139. inline size_t FileStat::size() const {
  5140. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5141. }
  5142. inline std::string encode_path(const std::string &s) {
  5143. std::string result;
  5144. result.reserve(s.size());
  5145. for (size_t i = 0; s[i]; i++) {
  5146. switch (s[i]) {
  5147. case ' ': result += "%20"; break;
  5148. case '+': result += "%2B"; break;
  5149. case '\'': result += "%27"; break;
  5150. case ',': result += "%2C"; break;
  5151. // case ':': result += "%3A"; break; // ok? probably...
  5152. case ';': result += "%3B"; break;
  5153. default:
  5154. auto c = static_cast<uint8_t>(s[i]);
  5155. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5156. // in a request-target as-is.
  5157. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5158. result += '%';
  5159. char hex[4];
  5160. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5161. assert(len == 2);
  5162. result.append(hex, static_cast<size_t>(len));
  5163. } else {
  5164. result += s[i];
  5165. }
  5166. break;
  5167. }
  5168. }
  5169. return result;
  5170. }
  5171. inline std::string file_extension(const std::string &path) {
  5172. auto i = path.size();
  5173. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5174. i--;
  5175. }
  5176. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5177. return std::string();
  5178. }
  5179. return path.substr(i);
  5180. }
  5181. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5182. template <typename T>
  5183. inline bool parse_header(const char *beg, const char *end, T fn);
  5184. template <typename T>
  5185. inline bool parse_header(const char *beg, const char *end, T fn) {
  5186. // Skip trailing spaces and tabs.
  5187. while (beg < end && is_space_or_tab(end[-1])) {
  5188. end--;
  5189. }
  5190. auto p = beg;
  5191. while (p < end && *p != ':') {
  5192. p++;
  5193. }
  5194. auto name = std::string(beg, p);
  5195. if (!detail::fields::is_field_name(name)) { return false; }
  5196. if (p == end) { return false; }
  5197. auto key_end = p;
  5198. if (*p++ != ':') { return false; }
  5199. while (p < end && is_space_or_tab(*p)) {
  5200. p++;
  5201. }
  5202. if (p <= end) {
  5203. auto key_len = key_end - beg;
  5204. if (!key_len) { return false; }
  5205. auto key = std::string(beg, key_end);
  5206. auto val = std::string(p, end);
  5207. if (!detail::fields::is_field_value(val)) { return false; }
  5208. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5209. // percent-decoded by the recipient. Applications that need to interpret a
  5210. // value as a URI component should call httplib::decode_uri_component()
  5211. // (or decode_path_component()) explicitly.
  5212. fn(key, val);
  5213. return true;
  5214. }
  5215. return false;
  5216. }
  5217. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5218. const Headers &src_headers) {
  5219. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5220. // transfer coding is complete when a chunk with a chunk-size of zero is
  5221. // received, possibly followed by a trailer section, and finally terminated by
  5222. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5223. //
  5224. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5225. // doesn't care for the existence of the final CRLF. In other words, it seems
  5226. // to be ok whether the final CRLF exists or not in the chunked data.
  5227. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5228. //
  5229. // According to the reference code in RFC 9112, cpp-httplib now allows
  5230. // chunked transfer coding data without the final CRLF.
  5231. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5232. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5233. "transfer-encoding",
  5234. "content-length",
  5235. "host",
  5236. "authorization",
  5237. "www-authenticate",
  5238. "proxy-authenticate",
  5239. "proxy-authorization",
  5240. "cookie",
  5241. "set-cookie",
  5242. "cache-control",
  5243. "expect",
  5244. "max-forwards",
  5245. "pragma",
  5246. "range",
  5247. "te",
  5248. "age",
  5249. "expires",
  5250. "date",
  5251. "location",
  5252. "retry-after",
  5253. "vary",
  5254. "warning",
  5255. "content-encoding",
  5256. "content-type",
  5257. "content-range",
  5258. "trailer"};
  5259. case_ignore::unordered_set<std::string> declared_trailers;
  5260. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5261. if (!trailer_header.empty()) {
  5262. // split() trims each token and skips empty ones, so the name arrives ready
  5263. // to look up.
  5264. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5265. ',', [&](const char *b, const char *e) {
  5266. // A legitimate message declares only a handful of trailers. Cap the
  5267. // set so a peer cannot grow it without bound: an oversized set only
  5268. // arises from an attempt to force many colliding names into
  5269. // quadratic lookups (case_ignore::hash is unkeyed).
  5270. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5271. return;
  5272. }
  5273. std::string key(b, e);
  5274. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5275. declared_trailers.insert(key);
  5276. }
  5277. });
  5278. }
  5279. size_t trailer_header_count = 0;
  5280. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5281. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5282. // Count every received trailer field, not only the declared ones stored in
  5283. // dest, so undeclared fields cannot keep this loop running past the limit.
  5284. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5285. constexpr auto line_terminator_len = 2;
  5286. auto line_beg = line_reader.ptr();
  5287. auto line_end =
  5288. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5289. if (!parse_header(line_beg, line_end,
  5290. [&](const std::string &key, const std::string &val) {
  5291. if (declared_trailers.find(key) !=
  5292. declared_trailers.end()) {
  5293. dest.emplace(key, val);
  5294. }
  5295. })) {
  5296. return false;
  5297. }
  5298. trailer_header_count++;
  5299. if (!line_reader.getline()) { return false; }
  5300. }
  5301. return true;
  5302. }
  5303. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5304. size_t right) {
  5305. while (b + left < e && is_space_or_tab(b[left])) {
  5306. left++;
  5307. }
  5308. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5309. right--;
  5310. }
  5311. return std::make_pair(left, right);
  5312. }
  5313. inline std::string trim_copy(const std::string &s) {
  5314. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5315. return s.substr(r.first, r.second - r.first);
  5316. }
  5317. inline std::string trim_double_quotes_copy(const std::string &s) {
  5318. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5319. return s.substr(1, s.size() - 2);
  5320. }
  5321. return s;
  5322. }
  5323. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5324. // here, as browsers send any other backslash, such as one in a Windows path,
  5325. // as it is.
  5326. inline std::string unquote_param(const std::string &s) {
  5327. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5328. std::string out;
  5329. for (size_t i = 1; i + 1 < s.size(); i++) {
  5330. if (s[i] == '\\' && i + 2 < s.size() &&
  5331. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5332. i++;
  5333. }
  5334. out += s[i];
  5335. }
  5336. return out;
  5337. }
  5338. inline void
  5339. divide(const char *data, std::size_t size, char d,
  5340. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5341. fn) {
  5342. const auto it = std::find(data, data + size, d);
  5343. const auto found = static_cast<std::size_t>(it != data + size);
  5344. const auto lhs_data = data;
  5345. const auto lhs_size = static_cast<std::size_t>(it - data);
  5346. const auto rhs_data = it + found;
  5347. const auto rhs_size = size - lhs_size - found;
  5348. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5349. }
  5350. inline void
  5351. divide(const std::string &str, char d,
  5352. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5353. fn) {
  5354. divide(str.data(), str.size(), d, std::move(fn));
  5355. }
  5356. inline void split(const char *b, const char *e, char d,
  5357. std::function<void(const char *, const char *)> fn) {
  5358. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5359. }
  5360. inline void split(const char *b, const char *e, char d, size_t m,
  5361. std::function<void(const char *, const char *)> fn) {
  5362. size_t i = 0;
  5363. size_t beg = 0;
  5364. size_t count = 1;
  5365. while (e ? (b + i < e) : (b[i] != '\0')) {
  5366. if (b[i] == d && count < m) {
  5367. auto r = trim(b, e, beg, i);
  5368. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5369. beg = i + 1;
  5370. count++;
  5371. }
  5372. i++;
  5373. }
  5374. if (i) {
  5375. auto r = trim(b, e, beg, i);
  5376. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5377. }
  5378. }
  5379. // Same contract as split(), except that a delimiter inside a quoted-string is
  5380. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5381. // quoted-string, and ';' and '=' are legal characters inside one.
  5382. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5383. std::function<void(const char *, const char *)> fn) {
  5384. size_t i = 0;
  5385. size_t beg = 0;
  5386. size_t count = 1;
  5387. auto in_quotes = false;
  5388. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5389. while (has(i)) {
  5390. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5391. // A quoted-pair, whose second character does not end the string.
  5392. i++;
  5393. } else if (b[i] == '"') {
  5394. in_quotes = !in_quotes;
  5395. } else if (b[i] == d && !in_quotes && count < m) {
  5396. auto r = trim(b, e, beg, i);
  5397. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5398. beg = i + 1;
  5399. count++;
  5400. }
  5401. i++;
  5402. }
  5403. if (i) {
  5404. auto r = trim(b, e, beg, i);
  5405. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5406. }
  5407. }
  5408. inline void split_unquoted(const char *b, const char *e, char d,
  5409. std::function<void(const char *, const char *)> fn) {
  5410. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5411. std::move(fn));
  5412. }
  5413. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5414. // key a token, so the first '=' is the separator even when the value is a
  5415. // quoted-string carrying more of them.
  5416. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5417. std::string &val) {
  5418. divide(
  5419. b, static_cast<std::size_t>(e - b), '=',
  5420. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5421. const auto kr = trim(kb, kb + klen, 0, klen);
  5422. key.assign(kb + kr.first, kb + kr.second);
  5423. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5424. val.assign(vb + vr.first, vb + vr.second);
  5425. });
  5426. }
  5427. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5428. std::function<bool(const char *, const char *)> fn) {
  5429. size_t i = 0;
  5430. size_t beg = 0;
  5431. size_t count = 1;
  5432. while (e ? (b + i < e) : (b[i] != '\0')) {
  5433. if (b[i] == d && count < m) {
  5434. auto r = trim(b, e, beg, i);
  5435. if (r.first < r.second) {
  5436. auto found = fn(&b[r.first], &b[r.second]);
  5437. if (found) { return true; }
  5438. }
  5439. beg = i + 1;
  5440. count++;
  5441. }
  5442. i++;
  5443. }
  5444. if (i) {
  5445. auto r = trim(b, e, beg, i);
  5446. if (r.first < r.second) {
  5447. auto found = fn(&b[r.first], &b[r.second]);
  5448. if (found) { return true; }
  5449. }
  5450. }
  5451. return false;
  5452. }
  5453. inline bool split_find(const char *b, const char *e, char d,
  5454. std::function<bool(const char *, const char *)> fn) {
  5455. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5456. std::move(fn));
  5457. }
  5458. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5459. size_t fixed_buffer_size)
  5460. : strm_(strm), fixed_buffer_(fixed_buffer),
  5461. fixed_buffer_size_(fixed_buffer_size) {}
  5462. inline const char *stream_line_reader::ptr() const {
  5463. if (growable_buffer_.empty()) {
  5464. return fixed_buffer_;
  5465. } else {
  5466. return growable_buffer_.data();
  5467. }
  5468. }
  5469. inline size_t stream_line_reader::size() const {
  5470. if (growable_buffer_.empty()) {
  5471. return fixed_buffer_used_size_;
  5472. } else {
  5473. return growable_buffer_.size();
  5474. }
  5475. }
  5476. inline bool stream_line_reader::end_with_crlf() const {
  5477. auto end = ptr() + size();
  5478. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5479. }
  5480. inline bool stream_line_reader::getline() {
  5481. fixed_buffer_used_size_ = 0;
  5482. growable_buffer_.clear();
  5483. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5484. char prev_byte = 0;
  5485. #endif
  5486. for (size_t i = 0;; i++) {
  5487. // Fast path: whatever the stream has already buffered can be scanned for
  5488. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5489. // call, a bounds check and a one-byte copy per character of the request.
  5490. size_t buffered_size = 0;
  5491. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5492. auto take = buffered_size;
  5493. auto terminated = false;
  5494. for (size_t at = 0; at < buffered_size;) {
  5495. auto nl = static_cast<const char *>(
  5496. memchr(buffered + at, '\n', buffered_size - at));
  5497. if (!nl) { break; }
  5498. auto pos = static_cast<size_t>(nl - buffered);
  5499. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5500. take = pos + 1;
  5501. terminated = true;
  5502. break;
  5503. #else
  5504. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5505. // be the last byte of an earlier chunk, hence prev_byte.
  5506. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5507. take = pos + 1;
  5508. terminated = true;
  5509. break;
  5510. }
  5511. at = pos + 1;
  5512. #endif
  5513. }
  5514. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5515. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5516. prev_byte = buffered[take - 1];
  5517. #endif
  5518. append(buffered, take);
  5519. strm_.consume_buffered(take);
  5520. i += take;
  5521. if (terminated) { return true; }
  5522. continue;
  5523. }
  5524. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5525. // Treat exceptionally long lines as an error to
  5526. // prevent infinite loops/memory exhaustion
  5527. return false;
  5528. }
  5529. char byte;
  5530. auto n = strm_.read(&byte, 1);
  5531. if (n < 0) {
  5532. return false;
  5533. } else if (n == 0) {
  5534. if (i == 0) {
  5535. return false;
  5536. } else {
  5537. break;
  5538. }
  5539. }
  5540. append(byte);
  5541. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5542. if (byte == '\n') { break; }
  5543. #else
  5544. if (prev_byte == '\r' && byte == '\n') { break; }
  5545. prev_byte = byte;
  5546. #endif
  5547. }
  5548. return true;
  5549. }
  5550. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5551. inline void stream_line_reader::append(const char *data, size_t size) {
  5552. // Once the line has outgrown the fixed buffer everything must keep going to
  5553. // the growable one, even if a later chunk would have fit. Without the
  5554. // emptiness check a short append after a long one would land in the fixed
  5555. // buffer, which ptr() and size() no longer look at, and be lost.
  5556. if (growable_buffer_.empty() &&
  5557. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5558. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5559. fixed_buffer_used_size_ += size;
  5560. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5561. } else {
  5562. // Unlike the per-character overload, this can be the very first append of
  5563. // the line, so the fixed buffer may hold nothing and carry no terminator
  5564. // yet. assign() takes an explicit length and does not need one.
  5565. if (growable_buffer_.empty()) {
  5566. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5567. }
  5568. growable_buffer_.append(data, size);
  5569. }
  5570. }
  5571. inline mmap::mmap(const char *path) { open(path); }
  5572. inline mmap::~mmap() { close(); }
  5573. inline bool mmap::open(const char *path) {
  5574. close();
  5575. #if defined(_WIN32)
  5576. auto wpath = u8string_to_wstring(path);
  5577. if (wpath.empty()) { return false; }
  5578. hFile_ =
  5579. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5580. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5581. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5582. LARGE_INTEGER size{};
  5583. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5584. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5585. // See:
  5586. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5587. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5588. size_ = static_cast<size_t>(size.QuadPart);
  5589. hMapping_ =
  5590. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5591. // Special treatment for an empty file...
  5592. if (hMapping_ == NULL && size_ == 0) {
  5593. close();
  5594. is_open_empty_file = true;
  5595. return true;
  5596. }
  5597. if (hMapping_ == NULL) {
  5598. close();
  5599. return false;
  5600. }
  5601. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5602. if (addr_ == nullptr) {
  5603. close();
  5604. return false;
  5605. }
  5606. #else
  5607. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5608. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5609. if (fd_ == -1) { return false; }
  5610. // Only a regular file has a size to serve, unlike a directory or a device.
  5611. struct stat sb;
  5612. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5613. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5614. close();
  5615. return false;
  5616. }
  5617. size_ = static_cast<size_t>(sb.st_size);
  5618. #endif
  5619. return true;
  5620. }
  5621. inline bool mmap::is_open() const {
  5622. #if defined(_WIN32)
  5623. return is_open_empty_file ? true : addr_ != nullptr;
  5624. #else
  5625. return fd_ != -1;
  5626. #endif
  5627. }
  5628. inline size_t mmap::size() const { return size_; }
  5629. inline void mmap::close() {
  5630. #if defined(_WIN32)
  5631. if (addr_) {
  5632. ::UnmapViewOfFile(addr_);
  5633. addr_ = nullptr;
  5634. }
  5635. if (hMapping_) {
  5636. ::CloseHandle(hMapping_);
  5637. hMapping_ = NULL;
  5638. }
  5639. if (hFile_ != INVALID_HANDLE_VALUE) {
  5640. ::CloseHandle(hFile_);
  5641. hFile_ = INVALID_HANDLE_VALUE;
  5642. }
  5643. is_open_empty_file = false;
  5644. #else
  5645. if (fd_ != -1) {
  5646. ::close(fd_);
  5647. fd_ = -1;
  5648. }
  5649. #endif
  5650. size_ = 0;
  5651. }
  5652. inline int close_socket(socket_t sock) noexcept {
  5653. #ifdef _WIN32
  5654. return closesocket(sock);
  5655. #else
  5656. return close(sock);
  5657. #endif
  5658. }
  5659. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5660. ssize_t res = 0;
  5661. while (true) {
  5662. res = fn();
  5663. if (res < 0 && errno == EINTR) {
  5664. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5665. continue;
  5666. }
  5667. break;
  5668. }
  5669. return res;
  5670. }
  5671. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5672. if (offset >= size_) { return 0; }
  5673. len = (std::min)(len, size_ - offset);
  5674. #if defined(_WIN32)
  5675. // Windows does not let a mapped file be truncated.
  5676. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5677. return len;
  5678. #else
  5679. auto n = handle_EINTR(
  5680. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5681. return n > 0 ? static_cast<size_t>(n) : 0;
  5682. #endif
  5683. }
  5684. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5685. return handle_EINTR([&]() {
  5686. return recv(sock,
  5687. #ifdef _WIN32
  5688. static_cast<char *>(ptr), static_cast<int>(size),
  5689. #else
  5690. ptr, size,
  5691. #endif
  5692. flags);
  5693. });
  5694. }
  5695. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5696. int flags) {
  5697. return handle_EINTR([&]() {
  5698. return send(sock,
  5699. #ifdef _WIN32
  5700. static_cast<const char *>(ptr), static_cast<int>(size),
  5701. #else
  5702. ptr, size,
  5703. #endif
  5704. flags);
  5705. });
  5706. }
  5707. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5708. #ifdef _WIN32
  5709. return ::WSAPoll(fds, nfds, timeout);
  5710. #else
  5711. return ::poll(fds, nfds, timeout);
  5712. #endif
  5713. }
  5714. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5715. time_t usec) {
  5716. struct pollfd pfd;
  5717. pfd.fd = sock;
  5718. pfd.events = events;
  5719. pfd.revents = 0;
  5720. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5721. // "return immediately", which callers here rely on to probe a socket.
  5722. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5723. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5724. }
  5725. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5726. return select_impl(sock, POLLIN, sec, usec);
  5727. }
  5728. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5729. return select_impl(sock, POLLOUT, sec, usec);
  5730. }
  5731. // The point sec and usec from now, for select_until(). A negative sec never
  5732. // comes, as a negative timeout waits forever in select_impl().
  5733. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5734. time_t usec) {
  5735. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5736. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5737. std::chrono::microseconds(usec);
  5738. }
  5739. // Waits only for the time left until deadline, so that all the waits of one
  5740. // TLS handshake come out of a single timeout.
  5741. inline ssize_t select_until(socket_t sock, short events,
  5742. std::chrono::steady_clock::time_point deadline) {
  5743. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5744. return select_impl(sock, events, -1, 0);
  5745. }
  5746. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5747. deadline - std::chrono::steady_clock::now())
  5748. .count();
  5749. if (left <= 0) { return 0; }
  5750. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5751. static_cast<time_t>(left % 1000000));
  5752. }
  5753. // select_read(), but waits in slices and gives up once interrupted() returns
  5754. // true. A local shutdown() would not wake the wait on Windows.
  5755. inline ssize_t
  5756. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5757. const std::function<bool()> &interrupted) {
  5758. if (!interrupted) { return select_read(sock, sec, usec); }
  5759. const auto slice = std::chrono::microseconds(100000);
  5760. auto deadline = deadline_after(sec, usec);
  5761. while (!interrupted()) {
  5762. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5763. deadline - std::chrono::steady_clock::now());
  5764. auto last = left < slice;
  5765. // poll() takes whole milliseconds, so round the last wait up to keep it
  5766. // from ending before the deadline.
  5767. auto wait_usec = last ? (std::max)((left.count() + 999) / 1000 * 1000,
  5768. static_cast<decltype(left.count())>(0))
  5769. : slice.count();
  5770. auto ret = select_impl(sock, POLLIN, 0, static_cast<time_t>(wait_usec));
  5771. if (ret != 0 || last) { return ret; }
  5772. }
  5773. return 0;
  5774. }
  5775. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5776. time_t usec) {
  5777. struct pollfd pfd_read;
  5778. pfd_read.fd = sock;
  5779. pfd_read.events = POLLIN | POLLOUT;
  5780. pfd_read.revents = 0;
  5781. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5782. auto poll_res =
  5783. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5784. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5785. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5786. auto error = 0;
  5787. socklen_t len = sizeof(error);
  5788. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5789. reinterpret_cast<char *>(&error), &len);
  5790. auto successful = res >= 0 && !error;
  5791. return successful ? Error::Success : Error::Connection;
  5792. }
  5793. return Error::Connection;
  5794. }
  5795. inline bool is_socket_alive(socket_t sock) {
  5796. const auto val = detail::select_read(sock, 0, 0);
  5797. if (val == 0) {
  5798. return true;
  5799. } else if (val < 0 && errno == EBADF) {
  5800. return false;
  5801. }
  5802. char buf[1];
  5803. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5804. }
  5805. class SocketStream final : public Stream {
  5806. public:
  5807. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5808. time_t write_timeout_sec, time_t write_timeout_usec,
  5809. time_t max_timeout_msec = 0,
  5810. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5811. (std::chrono::steady_clock::time_point::min)());
  5812. ~SocketStream() override;
  5813. bool is_readable() const override;
  5814. bool wait_readable() const override;
  5815. bool wait_writable() const override;
  5816. bool is_peer_alive() const override;
  5817. ssize_t read(char *ptr, size_t size) override;
  5818. ssize_t write(const char *ptr, size_t size) override;
  5819. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5820. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5821. socket_t socket() const override;
  5822. time_t duration() const override;
  5823. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5824. void set_max_timeout(time_t msec) override;
  5825. void set_read_interrupt(std::function<bool()> interrupted) override;
  5826. const char *buffered_data(size_t &size) const override;
  5827. void consume_buffered(size_t size) override;
  5828. // The caller has just seen this socket become readable. Lets the next read
  5829. // skip its own readiness wait, which would otherwise ask the kernel a
  5830. // question that was answered a moment ago. Consumed by that read.
  5831. void set_readable_hint() { readable_hint_ = true; }
  5832. private:
  5833. bool ensure_readable();
  5834. socket_t sock_;
  5835. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5836. // thread while a read is in flight -- that is the point of it, for a caller
  5837. // holding one connection and wanting control back to send on it.
  5838. std::atomic<time_t> read_timeout_sec_;
  5839. std::atomic<time_t> read_timeout_usec_;
  5840. time_t write_timeout_sec_;
  5841. time_t write_timeout_usec_;
  5842. time_t max_timeout_msec_;
  5843. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5844. std::function<bool()> read_interrupted_;
  5845. std::vector<char> read_buff_;
  5846. size_t read_buff_off_ = 0;
  5847. size_t read_buff_content_size_ = 0;
  5848. bool readable_hint_ = false;
  5849. static const size_t read_buff_size_ = 1024l * 4;
  5850. };
  5851. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5852. time_t keep_alive_timeout_sec) {
  5853. using namespace std::chrono;
  5854. const auto interval_usec =
  5855. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5856. // Avoid expensive `steady_clock::now()` call for the first time
  5857. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5858. const auto start = steady_clock::now() - microseconds{interval_usec};
  5859. const auto timeout = seconds{keep_alive_timeout_sec};
  5860. while (true) {
  5861. if (svr_sock == INVALID_SOCKET) {
  5862. break; // Server socket is closed
  5863. }
  5864. auto val = select_read(sock, 0, interval_usec);
  5865. if (val < 0) {
  5866. break; // Ssocket error
  5867. } else if (val == 0) {
  5868. if (steady_clock::now() - start > timeout) {
  5869. break; // Timeout
  5870. }
  5871. } else {
  5872. return true; // Ready for read
  5873. }
  5874. }
  5875. return false;
  5876. }
  5877. // `has_buffered_request` reports whether the connection's stream already holds
  5878. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5879. // 9.3.2), so reading one request can pull the start of the next one into the
  5880. // stream's buffer; that request must be served without waiting for the socket
  5881. // to become readable again, since its bytes are no longer on the socket.
  5882. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5883. template <typename P, typename T>
  5884. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5885. socket_t sock,
  5886. size_t keep_alive_max_count,
  5887. time_t keep_alive_timeout_sec,
  5888. P has_buffered_request, T callback) {
  5889. auto ret = false;
  5890. // A keep_alive_max_count of 0 sets no limit.
  5891. for (size_t served = 0;
  5892. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5893. auto socket_readable = false;
  5894. if (!has_buffered_request()) {
  5895. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5896. socket_readable = true;
  5897. }
  5898. auto close_connection = served + 1 == keep_alive_max_count;
  5899. auto connection_closed = false;
  5900. ret = callback(socket_readable, close_connection, connection_closed);
  5901. if (!ret || connection_closed) { break; }
  5902. }
  5903. return ret;
  5904. }
  5905. template <typename T>
  5906. inline bool
  5907. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5908. size_t keep_alive_max_count,
  5909. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5910. time_t read_timeout_usec, time_t write_timeout_sec,
  5911. time_t write_timeout_usec, T callback) {
  5912. // One stream per connection: its read buffer can already hold the start of
  5913. // the next, pipelined request.
  5914. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5915. write_timeout_sec, write_timeout_usec);
  5916. return process_server_socket_core(
  5917. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5918. [&]() { return strm.is_readable(); },
  5919. [&](bool socket_readable, bool close_connection,
  5920. bool &connection_closed) {
  5921. if (socket_readable) { strm.set_readable_hint(); }
  5922. return callback(strm, close_connection, connection_closed);
  5923. });
  5924. }
  5925. inline bool process_client_socket(
  5926. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5927. time_t write_timeout_sec, time_t write_timeout_usec,
  5928. time_t max_timeout_msec,
  5929. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5930. std::function<bool(Stream &)> callback) {
  5931. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5932. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5933. start_time);
  5934. return callback(strm);
  5935. }
  5936. inline int shutdown_socket(socket_t sock) noexcept {
  5937. #ifdef _WIN32
  5938. return shutdown(sock, SD_BOTH);
  5939. #else
  5940. return shutdown(sock, SHUT_RDWR);
  5941. #endif
  5942. }
  5943. // Half-closes the write side and drains any in-flight/queued bytes before
  5944. // the final shutdown+close. Closing with unread data in the receive queue
  5945. // (or bytes arriving after the receive side is closed) makes the stack send
  5946. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5947. // response as a failed read even though it was fully written.
  5948. inline void drain_and_close_socket(socket_t sock) noexcept {
  5949. #ifdef _WIN32
  5950. shutdown(sock, SD_SEND);
  5951. #else
  5952. shutdown(sock, SHUT_WR);
  5953. #endif
  5954. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5955. size_t total = 0;
  5956. const auto deadline = std::chrono::steady_clock::now() +
  5957. std::chrono::milliseconds(100); // bound #1
  5958. while (total < size_t(1024u * 1024u)) { // bound #2
  5959. const auto remaining =
  5960. std::chrono::duration_cast<std::chrono::microseconds>(
  5961. deadline - std::chrono::steady_clock::now())
  5962. .count();
  5963. if (remaining <= 0) { break; }
  5964. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5965. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5966. if (n <= 0) { break; }
  5967. total += static_cast<size_t>(n);
  5968. }
  5969. shutdown_socket(sock);
  5970. close_socket(sock);
  5971. }
  5972. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5973. if (s.size() > 1 && s[0] == '\0') {
  5974. auto ret = s;
  5975. ret[0] = '@';
  5976. return ret;
  5977. }
  5978. return s;
  5979. }
  5980. inline std::string
  5981. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5982. if (s.size() > 1 && s[0] == '@') {
  5983. auto ret = s;
  5984. ret[0] = '\0';
  5985. return ret;
  5986. }
  5987. return s;
  5988. }
  5989. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5990. const struct addrinfo *hints,
  5991. struct addrinfo **res, time_t timeout_sec) {
  5992. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5993. if (timeout_sec <= 0) {
  5994. // No timeout specified, use standard getaddrinfo
  5995. return getaddrinfo(node, service, hints, res);
  5996. }
  5997. #ifdef _WIN32
  5998. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5999. OVERLAPPED overlapped = {};
  6000. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  6001. if (!event) { return EAI_FAIL; }
  6002. overlapped.hEvent = event;
  6003. PADDRINFOEXW result_addrinfo = nullptr;
  6004. HANDLE cancel_handle = nullptr;
  6005. ADDRINFOEXW hints_ex = {};
  6006. if (hints) {
  6007. hints_ex.ai_flags = hints->ai_flags;
  6008. hints_ex.ai_family = hints->ai_family;
  6009. hints_ex.ai_socktype = hints->ai_socktype;
  6010. hints_ex.ai_protocol = hints->ai_protocol;
  6011. }
  6012. auto wnode = u8string_to_wstring(node);
  6013. auto wservice = u8string_to_wstring(service);
  6014. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  6015. hints ? &hints_ex : nullptr, &result_addrinfo,
  6016. nullptr, &overlapped, nullptr, &cancel_handle);
  6017. if (ret == WSA_IO_PENDING) {
  6018. auto wait_result =
  6019. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  6020. if (wait_result == WAIT_TIMEOUT) {
  6021. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  6022. ::CloseHandle(event);
  6023. return EAI_AGAIN;
  6024. }
  6025. DWORD bytes_returned;
  6026. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  6027. &bytes_returned, FALSE)) {
  6028. ::CloseHandle(event);
  6029. return ::WSAGetLastError();
  6030. }
  6031. }
  6032. ::CloseHandle(event);
  6033. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  6034. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  6035. return 0;
  6036. }
  6037. return ret;
  6038. #elif TARGET_OS_MAC && defined(__clang__)
  6039. if (!node) { return EAI_NONAME; }
  6040. // macOS implementation using CFHost API for asynchronous DNS resolution
  6041. CFStringRef hostname_ref = CFStringCreateWithCString(
  6042. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  6043. if (!hostname_ref) { return EAI_MEMORY; }
  6044. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  6045. CFRelease(hostname_ref);
  6046. if (!host_ref) { return EAI_MEMORY; }
  6047. // Set up context for callback
  6048. struct CFHostContext {
  6049. bool completed = false;
  6050. bool success = false;
  6051. CFArrayRef addresses = nullptr;
  6052. std::mutex mutex;
  6053. std::condition_variable cv;
  6054. } context;
  6055. CFHostClientContext client_context;
  6056. memset(&client_context, 0, sizeof(client_context));
  6057. client_context.info = &context;
  6058. // Set callback
  6059. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  6060. const CFStreamError *error, void *info) {
  6061. auto ctx = static_cast<CFHostContext *>(info);
  6062. std::lock_guard<std::mutex> lock(ctx->mutex);
  6063. if (error && error->error != 0) {
  6064. ctx->success = false;
  6065. } else {
  6066. Boolean hasBeenResolved;
  6067. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  6068. if (ctx->addresses && hasBeenResolved) {
  6069. CFRetain(ctx->addresses);
  6070. ctx->success = true;
  6071. } else {
  6072. ctx->success = false;
  6073. }
  6074. }
  6075. ctx->completed = true;
  6076. ctx->cv.notify_one();
  6077. };
  6078. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  6079. CFRelease(host_ref);
  6080. return EAI_SYSTEM;
  6081. }
  6082. // Schedule on run loop
  6083. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  6084. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6085. // Start resolution
  6086. CFStreamError stream_error;
  6087. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  6088. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6089. CFRelease(host_ref);
  6090. return EAI_FAIL;
  6091. }
  6092. // Wait for completion with timeout
  6093. auto timeout_time =
  6094. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  6095. bool timed_out = false;
  6096. {
  6097. std::unique_lock<std::mutex> lock(context.mutex);
  6098. while (!context.completed) {
  6099. auto now = std::chrono::steady_clock::now();
  6100. if (now >= timeout_time) {
  6101. timed_out = true;
  6102. break;
  6103. }
  6104. // Run the runloop for a short time
  6105. lock.unlock();
  6106. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  6107. lock.lock();
  6108. }
  6109. }
  6110. // Clean up
  6111. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  6112. CFHostSetClient(host_ref, nullptr, nullptr);
  6113. if (timed_out || !context.completed) {
  6114. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  6115. CFRelease(host_ref);
  6116. return EAI_AGAIN;
  6117. }
  6118. if (!context.success || !context.addresses) {
  6119. CFRelease(host_ref);
  6120. return EAI_NODATA;
  6121. }
  6122. // Convert CFArray to addrinfo
  6123. CFIndex count = CFArrayGetCount(context.addresses);
  6124. if (count == 0) {
  6125. CFRelease(context.addresses);
  6126. CFRelease(host_ref);
  6127. return EAI_NODATA;
  6128. }
  6129. struct addrinfo *result_addrinfo = nullptr;
  6130. struct addrinfo **current = &result_addrinfo;
  6131. for (CFIndex i = 0; i < count; i++) {
  6132. CFDataRef addr_data =
  6133. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6134. if (!addr_data) continue;
  6135. const struct sockaddr *sockaddr_ptr =
  6136. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6137. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6138. // Allocate addrinfo structure
  6139. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6140. if (!*current) {
  6141. freeaddrinfo(result_addrinfo);
  6142. CFRelease(context.addresses);
  6143. CFRelease(host_ref);
  6144. return EAI_MEMORY;
  6145. }
  6146. memset(*current, 0, sizeof(struct addrinfo));
  6147. // Set up addrinfo fields
  6148. (*current)->ai_family = sockaddr_ptr->sa_family;
  6149. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6150. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6151. (*current)->ai_addrlen = sockaddr_len;
  6152. // Copy sockaddr
  6153. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6154. if (!(*current)->ai_addr) {
  6155. freeaddrinfo(result_addrinfo);
  6156. CFRelease(context.addresses);
  6157. CFRelease(host_ref);
  6158. return EAI_MEMORY;
  6159. }
  6160. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6161. // Set port if service is specified
  6162. if (service && *service) {
  6163. int port = 0;
  6164. if (parse_port(service, strlen(service), port)) {
  6165. if (sockaddr_ptr->sa_family == AF_INET) {
  6166. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6167. ->sin_port = htons(static_cast<uint16_t>(port));
  6168. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6169. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6170. ->sin6_port = htons(static_cast<uint16_t>(port));
  6171. }
  6172. }
  6173. }
  6174. current = &((*current)->ai_next);
  6175. }
  6176. CFRelease(context.addresses);
  6177. CFRelease(host_ref);
  6178. *res = result_addrinfo;
  6179. return 0;
  6180. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6181. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6182. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6183. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6184. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6185. // the resolver worker still references the stack-local gaicb. The cancel
  6186. // path therefore waits (gai_suspend with no timeout) for the worker to
  6187. // actually finish before letting the stack frame go. The trade-off is that
  6188. // a wedged DNS server can hold this thread for the system resolver timeout
  6189. // (~30s by default) past the caller's connection timeout.
  6190. struct gaicb request{};
  6191. struct gaicb *requests[1] = {&request};
  6192. struct sigevent sevp{};
  6193. struct timespec timeout{timeout_sec, 0};
  6194. request.ar_name = node;
  6195. request.ar_service = service;
  6196. request.ar_request = hints;
  6197. sevp.sigev_notify = SIGEV_NONE;
  6198. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6199. if (rc != 0) { return rc; }
  6200. auto cleanup = scope_exit([&] {
  6201. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6202. });
  6203. int wait_result = gai_suspend(requests, 1, &timeout);
  6204. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6205. int gai_result = gai_error(&request);
  6206. if (gai_result == 0) {
  6207. *res = request.ar_result;
  6208. request.ar_result = nullptr;
  6209. return 0;
  6210. }
  6211. return gai_result;
  6212. }
  6213. gai_cancel(&request);
  6214. while (gai_error(&request) == EAI_INPROGRESS) {
  6215. gai_suspend(requests, 1, nullptr);
  6216. }
  6217. return wait_result;
  6218. #else
  6219. // Fallback implementation using thread-based timeout for other Unix systems.
  6220. struct GetAddrInfoState {
  6221. ~GetAddrInfoState() {
  6222. if (info) { freeaddrinfo(info); }
  6223. }
  6224. std::mutex mutex;
  6225. std::condition_variable result_cv;
  6226. bool completed = false;
  6227. int result = EAI_SYSTEM;
  6228. std::string node;
  6229. std::string service;
  6230. struct addrinfo hints;
  6231. struct addrinfo *info = nullptr;
  6232. };
  6233. // Allocate on the heap, so the resolver thread can keep using the data.
  6234. auto state = std::make_shared<GetAddrInfoState>();
  6235. if (node) { state->node = node; }
  6236. state->service = service;
  6237. state->hints = *hints;
  6238. std::thread resolve_thread([state]() {
  6239. auto thread_result =
  6240. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6241. &state->info);
  6242. std::lock_guard<std::mutex> lock(state->mutex);
  6243. state->result = thread_result;
  6244. state->completed = true;
  6245. state->result_cv.notify_one();
  6246. });
  6247. // Wait for completion or timeout
  6248. std::unique_lock<std::mutex> lock(state->mutex);
  6249. auto finished =
  6250. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6251. [&] { return state->completed; });
  6252. if (finished) {
  6253. // Operation completed within timeout
  6254. resolve_thread.join();
  6255. *res = state->info;
  6256. state->info = nullptr; // Pass ownership to caller
  6257. return state->result;
  6258. } else {
  6259. // Timeout occurred
  6260. resolve_thread.detach(); // Let the thread finish in background
  6261. return EAI_AGAIN; // Return timeout error
  6262. }
  6263. #endif
  6264. #else
  6265. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6266. return getaddrinfo(node, service, hints, res);
  6267. #endif
  6268. }
  6269. template <typename BindOrConnect>
  6270. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6271. int address_family, int socket_flags, bool tcp_nodelay,
  6272. bool ipv6_v6only, SocketOptions socket_options,
  6273. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6274. // Get address info
  6275. const char *node = nullptr;
  6276. struct addrinfo hints;
  6277. struct addrinfo *result;
  6278. memset(&hints, 0, sizeof(struct addrinfo));
  6279. hints.ai_socktype = SOCK_STREAM;
  6280. hints.ai_protocol = IPPROTO_IP;
  6281. if (!ip.empty()) {
  6282. node = ip.c_str();
  6283. // Ask getaddrinfo to convert IP in c-string to address
  6284. hints.ai_family = AF_UNSPEC;
  6285. hints.ai_flags = AI_NUMERICHOST;
  6286. } else {
  6287. if (!host.empty()) { node = host.c_str(); }
  6288. hints.ai_family = address_family;
  6289. hints.ai_flags = socket_flags;
  6290. }
  6291. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6292. if (hints.ai_family == AF_UNIX) {
  6293. const auto addrlen = host.length();
  6294. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6295. #ifdef SOCK_CLOEXEC
  6296. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6297. hints.ai_protocol);
  6298. #else
  6299. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6300. #endif
  6301. if (sock != INVALID_SOCKET) {
  6302. sockaddr_un addr{};
  6303. addr.sun_family = AF_UNIX;
  6304. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6305. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6306. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6307. hints.ai_addrlen = static_cast<socklen_t>(
  6308. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6309. #ifndef SOCK_CLOEXEC
  6310. #ifndef _WIN32
  6311. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6312. #endif
  6313. #endif
  6314. if (socket_options) { socket_options(sock); }
  6315. #ifdef _WIN32
  6316. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6317. // remove the option.
  6318. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6319. #endif
  6320. bool dummy;
  6321. if (!bind_or_connect(sock, hints, dummy)) {
  6322. close_socket(sock);
  6323. sock = INVALID_SOCKET;
  6324. }
  6325. }
  6326. return sock;
  6327. }
  6328. #endif
  6329. auto service = std::to_string(port);
  6330. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6331. timeout_sec)) {
  6332. #if defined __linux__ && !defined __ANDROID__
  6333. res_init();
  6334. #endif
  6335. return INVALID_SOCKET;
  6336. }
  6337. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6338. for (auto rp = result; rp; rp = rp->ai_next) {
  6339. // Create a socket
  6340. #ifdef _WIN32
  6341. auto sock =
  6342. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6343. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6344. /**
  6345. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6346. * and above the socket creation fails on older Windows Systems.
  6347. *
  6348. * Let's try to create a socket the old way in this case.
  6349. *
  6350. * Reference:
  6351. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6352. *
  6353. * WSA_FLAG_NO_HANDLE_INHERIT:
  6354. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6355. * SP1, and later
  6356. *
  6357. */
  6358. if (sock == INVALID_SOCKET) {
  6359. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6360. }
  6361. #else
  6362. #ifdef SOCK_CLOEXEC
  6363. auto sock =
  6364. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6365. #else
  6366. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6367. #endif
  6368. #endif
  6369. if (sock == INVALID_SOCKET) { continue; }
  6370. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6371. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6372. close_socket(sock);
  6373. continue;
  6374. }
  6375. #endif
  6376. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6377. if (rp->ai_family == AF_INET6) {
  6378. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6379. }
  6380. if (socket_options) { socket_options(sock); }
  6381. // bind or connect
  6382. auto quit = false;
  6383. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6384. close_socket(sock);
  6385. if (quit) { break; }
  6386. }
  6387. return INVALID_SOCKET;
  6388. }
  6389. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6390. #ifdef _WIN32
  6391. auto flags = nonblocking ? 1UL : 0UL;
  6392. ioctlsocket(sock, FIONBIO, &flags);
  6393. #else
  6394. auto flags = fcntl(sock, F_GETFL, 0);
  6395. fcntl(sock, F_SETFL,
  6396. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6397. #endif
  6398. }
  6399. inline bool is_connection_error() {
  6400. #ifdef _WIN32
  6401. return WSAGetLastError() != WSAEWOULDBLOCK;
  6402. #else
  6403. return errno != EINPROGRESS;
  6404. #endif
  6405. }
  6406. // accept() failed because the process or the network stack is temporarily out
  6407. // of resources. The listening socket is still usable, so back off briefly and
  6408. // try again.
  6409. inline bool is_accept_resource_error() {
  6410. #ifdef _WIN32
  6411. auto err = WSAGetLastError();
  6412. return err == WSAEMFILE || err == WSAENOBUFS;
  6413. #else
  6414. auto err = errno;
  6415. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6416. #endif
  6417. }
  6418. // accept() failed for a reason that says nothing about the listening socket:
  6419. // the pending connection went away before it could be accepted, or the call
  6420. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6421. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6422. // connection that way.
  6423. inline bool is_accept_transient_error() {
  6424. #ifdef _WIN32
  6425. auto err = WSAGetLastError();
  6426. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6427. err == WSAECONNABORTED;
  6428. #else
  6429. auto err = errno;
  6430. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6431. err == ECONNABORTED;
  6432. #endif
  6433. }
  6434. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6435. struct addrinfo hints;
  6436. struct addrinfo *result;
  6437. memset(&hints, 0, sizeof(struct addrinfo));
  6438. hints.ai_family = AF_UNSPEC;
  6439. hints.ai_socktype = SOCK_STREAM;
  6440. hints.ai_protocol = 0;
  6441. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6442. return false;
  6443. }
  6444. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6445. auto ret = false;
  6446. for (auto rp = result; rp; rp = rp->ai_next) {
  6447. const auto &ai = *rp;
  6448. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6449. ret = true;
  6450. break;
  6451. }
  6452. }
  6453. return ret;
  6454. }
  6455. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6456. #define USE_IF2IP
  6457. #endif
  6458. #ifdef USE_IF2IP
  6459. inline std::string if2ip(int address_family, const std::string &ifn) {
  6460. struct ifaddrs *ifap;
  6461. getifaddrs(&ifap);
  6462. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6463. std::string addr_candidate;
  6464. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6465. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6466. (AF_UNSPEC == address_family ||
  6467. ifa->ifa_addr->sa_family == address_family)) {
  6468. if (ifa->ifa_addr->sa_family == AF_INET) {
  6469. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6470. char buf[INET_ADDRSTRLEN];
  6471. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6472. return std::string(buf, INET_ADDRSTRLEN);
  6473. }
  6474. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6475. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6476. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6477. char buf[INET6_ADDRSTRLEN] = {};
  6478. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6479. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6480. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6481. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6482. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6483. } else {
  6484. return std::string(buf, INET6_ADDRSTRLEN);
  6485. }
  6486. }
  6487. }
  6488. }
  6489. }
  6490. }
  6491. return addr_candidate;
  6492. }
  6493. #endif
  6494. inline socket_t create_client_socket(
  6495. const std::string &host, const std::string &ip, int port,
  6496. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6497. SocketOptions socket_options, time_t connection_timeout_sec,
  6498. time_t connection_timeout_usec, time_t read_timeout_sec,
  6499. time_t read_timeout_usec, time_t write_timeout_sec,
  6500. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6501. auto sock = create_socket(
  6502. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6503. std::move(socket_options),
  6504. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6505. if (!intf.empty()) {
  6506. #ifdef USE_IF2IP
  6507. auto ip_from_if = if2ip(address_family, intf);
  6508. if (ip_from_if.empty()) { ip_from_if = intf; }
  6509. if (!bind_ip_address(sock2, ip_from_if)) {
  6510. error = Error::BindIPAddress;
  6511. return false;
  6512. }
  6513. #endif
  6514. }
  6515. set_nonblocking(sock2, true);
  6516. auto ret =
  6517. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6518. if (ret < 0) {
  6519. if (is_connection_error()) {
  6520. error = Error::Connection;
  6521. return false;
  6522. }
  6523. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6524. connection_timeout_usec);
  6525. if (error != Error::Success) {
  6526. if (error == Error::ConnectionTimeout) { quit = true; }
  6527. return false;
  6528. }
  6529. }
  6530. set_nonblocking(sock2, false);
  6531. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6532. read_timeout_usec);
  6533. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6534. write_timeout_usec);
  6535. error = Error::Success;
  6536. return true;
  6537. },
  6538. connection_timeout_sec); // Pass DNS timeout
  6539. if (sock != INVALID_SOCKET) {
  6540. error = Error::Success;
  6541. } else {
  6542. if (error == Error::Success) { error = Error::Connection; }
  6543. }
  6544. return sock;
  6545. }
  6546. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6547. socklen_t addr_len, std::string &ip, int &port) {
  6548. if (addr.ss_family == AF_INET) {
  6549. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6550. } else if (addr.ss_family == AF_INET6) {
  6551. port =
  6552. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6553. } else {
  6554. return false;
  6555. }
  6556. std::array<char, NI_MAXHOST> ipstr{};
  6557. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6558. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6559. 0, NI_NUMERICHOST)) {
  6560. return false;
  6561. }
  6562. ip = ipstr.data();
  6563. return true;
  6564. }
  6565. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6566. struct sockaddr_storage addr;
  6567. socklen_t addr_len = sizeof(addr);
  6568. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6569. &addr_len)) {
  6570. get_ip_and_port(addr, addr_len, ip, port);
  6571. }
  6572. }
  6573. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6574. struct sockaddr_storage addr;
  6575. socklen_t addr_len = sizeof(addr);
  6576. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6577. &addr_len)) {
  6578. #ifndef _WIN32
  6579. if (addr.ss_family == AF_UNIX) {
  6580. #if defined(__linux__)
  6581. struct ucred ucred;
  6582. socklen_t len = sizeof(ucred);
  6583. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6584. port = ucred.pid;
  6585. }
  6586. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6587. pid_t pid;
  6588. socklen_t len = sizeof(pid);
  6589. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6590. port = pid;
  6591. }
  6592. #endif
  6593. return;
  6594. }
  6595. #endif
  6596. get_ip_and_port(addr, addr_len, ip, port);
  6597. }
  6598. }
  6599. inline std::string
  6600. find_content_type(const std::string &path,
  6601. const std::map<std::string, std::string> &user_data,
  6602. const std::string &default_content_type) {
  6603. // Extensions are matched regardless of case, as web servers do
  6604. auto ext = case_ignore::to_lower(file_extension(path));
  6605. auto it = user_data.find(ext);
  6606. if (it != user_data.end()) { return it->second; }
  6607. static const struct {
  6608. const char *ext;
  6609. const char *type;
  6610. } types[] = {
  6611. {"css", "text/css"},
  6612. {"csv", "text/csv"},
  6613. {"htm", "text/html"},
  6614. {"html", "text/html"},
  6615. {"js", "text/javascript"},
  6616. {"mjs", "text/javascript"},
  6617. {"txt", "text/plain"},
  6618. {"vtt", "text/vtt"},
  6619. {"apng", "image/apng"},
  6620. {"avif", "image/avif"},
  6621. {"bmp", "image/bmp"},
  6622. {"gif", "image/gif"},
  6623. {"png", "image/png"},
  6624. {"svg", "image/svg+xml"},
  6625. {"webp", "image/webp"},
  6626. {"ico", "image/x-icon"},
  6627. {"tif", "image/tiff"},
  6628. {"tiff", "image/tiff"},
  6629. {"jpg", "image/jpeg"},
  6630. {"jpeg", "image/jpeg"},
  6631. {"mp4", "video/mp4"},
  6632. {"mpeg", "video/mpeg"},
  6633. {"webm", "video/webm"},
  6634. {"mp3", "audio/mp3"},
  6635. {"mpga", "audio/mpeg"},
  6636. {"weba", "audio/webm"},
  6637. {"wav", "audio/wave"},
  6638. {"otf", "font/otf"},
  6639. {"ttf", "font/ttf"},
  6640. {"woff", "font/woff"},
  6641. {"woff2", "font/woff2"},
  6642. {"7z", "application/x-7z-compressed"},
  6643. {"atom", "application/atom+xml"},
  6644. {"pdf", "application/pdf"},
  6645. {"json", "application/json"},
  6646. {"rss", "application/rss+xml"},
  6647. {"tar", "application/x-tar"},
  6648. {"xht", "application/xhtml+xml"},
  6649. {"xhtml", "application/xhtml+xml"},
  6650. {"xslt", "application/xslt+xml"},
  6651. {"xml", "application/xml"},
  6652. {"gz", "application/gzip"},
  6653. {"zip", "application/zip"},
  6654. {"wasm", "application/wasm"},
  6655. };
  6656. for (const auto &t : types) {
  6657. if (ext == t.ext) { return t.type; }
  6658. }
  6659. return default_content_type;
  6660. }
  6661. inline std::string
  6662. extract_media_type(const std::string &content_type,
  6663. std::map<std::string, std::string> *params = nullptr) {
  6664. // Extract type/subtype from Content-Type value (RFC 2045)
  6665. // e.g. "application/json; charset=utf-8" -> "application/json"
  6666. auto media_type = content_type;
  6667. auto semicolon_pos = media_type.find(';');
  6668. if (semicolon_pos != std::string::npos) {
  6669. auto param_str = media_type.substr(semicolon_pos + 1);
  6670. media_type = media_type.substr(0, semicolon_pos);
  6671. if (params) {
  6672. // Parse parameters: key=value pairs separated by ';'
  6673. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6674. [&](const char *b, const char *e) {
  6675. std::string key;
  6676. std::string val;
  6677. divide_param_pair(b, e, key, val);
  6678. // Parameter names are case-insensitive (RFC 9110
  6679. // §5.6.6)
  6680. if (!key.empty()) {
  6681. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6682. unquote_param(val));
  6683. }
  6684. });
  6685. }
  6686. }
  6687. // Trim whitespace from media type
  6688. return trim_copy(media_type);
  6689. }
  6690. inline bool can_compress_content_type(const std::string &content_type) {
  6691. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6692. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6693. static const char *const compressible[] = {
  6694. "image/svg+xml",
  6695. "application/javascript",
  6696. "application/x-javascript",
  6697. "application/json",
  6698. "application/ld+json",
  6699. "application/xml",
  6700. "application/xhtml+xml",
  6701. "application/rss+xml",
  6702. "application/atom+xml",
  6703. "application/xslt+xml",
  6704. "application/protobuf",
  6705. };
  6706. for (auto type : compressible) {
  6707. if (mime_type == type) { return true; }
  6708. }
  6709. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6710. }
  6711. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6712. double &quality) {
  6713. quality = 1.0;
  6714. token.clear();
  6715. // Split on first ';': left = token name, right = parameters
  6716. const char *params_b = nullptr;
  6717. std::size_t params_len = 0;
  6718. divide(
  6719. b, static_cast<std::size_t>(e - b), ';',
  6720. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6721. auto r = trim(lb, lb + llen, 0, llen);
  6722. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6723. params_b = rb;
  6724. params_len = rlen;
  6725. });
  6726. if (token.empty()) { return false; }
  6727. if (params_len == 0) { return true; }
  6728. // Scan parameters for q= (stops on first match)
  6729. bool invalid = false;
  6730. split_find(params_b, params_b + params_len, ';',
  6731. (std::numeric_limits<size_t>::max)(),
  6732. [&](const char *pb, const char *pe) -> bool {
  6733. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6734. auto len = static_cast<size_t>(pe - pb);
  6735. if (len < 2) { return false; }
  6736. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6737. return false;
  6738. }
  6739. // Trim the value portion
  6740. auto r = trim(pb, pe, 2, len);
  6741. if (r.first >= r.second) {
  6742. invalid = true;
  6743. return true;
  6744. }
  6745. double v = 0.0;
  6746. auto res = from_chars(pb + r.first, pb + r.second, v);
  6747. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6748. v < 0.0 || v > 1.0) {
  6749. invalid = true;
  6750. return true;
  6751. }
  6752. quality = v;
  6753. return true;
  6754. });
  6755. return !invalid;
  6756. }
  6757. inline EncodingType encoding_type(const Request &req,
  6758. const std::string &content_type) {
  6759. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6760. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6761. if (s.empty()) { return EncodingType::None; }
  6762. // Single-pass: iterate tokens and track the best supported encoding.
  6763. // Server preference breaks ties (br > gzip > zstd).
  6764. EncodingType best = EncodingType::None;
  6765. double best_q = 0.0; // q=0 means "not acceptable"
  6766. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6767. auto priority = [](EncodingType t) -> int {
  6768. switch (t) {
  6769. case EncodingType::Brotli: return 0;
  6770. case EncodingType::Gzip: return 1;
  6771. case EncodingType::Zstd: return 2;
  6772. default: return 3;
  6773. }
  6774. };
  6775. std::string name;
  6776. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6777. double quality = 1.0;
  6778. if (!parse_quality(b, e, name, quality)) { return; }
  6779. if (quality <= 0.0) { return; }
  6780. EncodingType type = EncodingType::None;
  6781. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6782. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6783. #endif
  6784. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6785. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6786. type = EncodingType::Gzip;
  6787. }
  6788. #endif
  6789. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6790. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6791. type = EncodingType::Zstd;
  6792. }
  6793. #endif
  6794. if (type == EncodingType::None) { return; }
  6795. // Higher q-value wins; for equal q, server preference breaks ties
  6796. if (quality > best_q ||
  6797. (quality == best_q && priority(type) < priority(best))) {
  6798. best_q = quality;
  6799. best = type;
  6800. }
  6801. });
  6802. return best;
  6803. }
  6804. // `content_type` is taken separately because a file-backed response has not
  6805. // been given one yet when its coding has to be decided.
  6806. inline EncodingType encoding_type(const Request &req, const Response &res,
  6807. const std::string &content_type) {
  6808. // The response already names a content coding of its own: a handler serving
  6809. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6810. // point whose headers name the coding its files are stored in. Applying one
  6811. // on top of that would double-encode the body and append a second
  6812. // `Content-Encoding` field line.
  6813. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6814. return encoding_type(req, content_type);
  6815. }
  6816. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6817. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6818. }
  6819. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6820. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6821. if (type == EncodingType::Gzip) {
  6822. return detail::make_unique<gzip_compressor>();
  6823. }
  6824. #endif
  6825. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6826. if (type == EncodingType::Brotli) {
  6827. return detail::make_unique<brotli_compressor>();
  6828. }
  6829. #endif
  6830. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6831. if (type == EncodingType::Zstd) {
  6832. return detail::make_unique<zstd_compressor>();
  6833. }
  6834. #endif
  6835. (void)type;
  6836. return nullptr;
  6837. }
  6838. inline const char *encoding_name(EncodingType type) {
  6839. switch (type) {
  6840. case EncodingType::Gzip: return "gzip";
  6841. case EncodingType::Brotli: return "br";
  6842. case EncodingType::Zstd: return "zstd";
  6843. default: return "";
  6844. }
  6845. }
  6846. inline bool nocompressor::compress(const char *data, size_t data_length,
  6847. bool /*last*/, Callback callback) {
  6848. if (!data_length) { return true; }
  6849. return callback(data, data_length);
  6850. }
  6851. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6852. inline gzip_compressor::gzip_compressor() {
  6853. std::memset(&strm_, 0, sizeof(strm_));
  6854. strm_.zalloc = Z_NULL;
  6855. strm_.zfree = Z_NULL;
  6856. strm_.opaque = Z_NULL;
  6857. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6858. Z_DEFAULT_STRATEGY) == Z_OK;
  6859. }
  6860. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6861. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6862. bool last, Callback callback) {
  6863. assert(is_valid_);
  6864. do {
  6865. constexpr size_t max_avail_in =
  6866. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6867. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6868. (std::min)(data_length, max_avail_in));
  6869. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6870. data_length -= strm_.avail_in;
  6871. data += strm_.avail_in;
  6872. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6873. auto ret = Z_OK;
  6874. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6875. do {
  6876. strm_.avail_out = static_cast<uInt>(buff.size());
  6877. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6878. ret = deflate(&strm_, flush);
  6879. if (ret == Z_STREAM_ERROR) { return false; }
  6880. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6881. return false;
  6882. }
  6883. } while (strm_.avail_out == 0);
  6884. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6885. (flush == Z_NO_FLUSH && ret == Z_OK));
  6886. assert(strm_.avail_in == 0);
  6887. } while (data_length > 0);
  6888. return true;
  6889. }
  6890. inline gzip_decompressor::gzip_decompressor() {
  6891. std::memset(&strm_, 0, sizeof(strm_));
  6892. strm_.zalloc = Z_NULL;
  6893. strm_.zfree = Z_NULL;
  6894. strm_.opaque = Z_NULL;
  6895. // 15 is the value of wbits, which should be at the maximum possible value
  6896. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6897. // that the stream type should be automatically detected either gzip or
  6898. // deflate.
  6899. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6900. }
  6901. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6902. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6903. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6904. Callback callback) {
  6905. assert(is_valid_);
  6906. auto ret = Z_OK;
  6907. do {
  6908. constexpr size_t max_avail_in =
  6909. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6910. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6911. (std::min)(data_length, max_avail_in));
  6912. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6913. data_length -= strm_.avail_in;
  6914. data += strm_.avail_in;
  6915. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6916. while (strm_.avail_in > 0 && ret == Z_OK) {
  6917. strm_.avail_out = static_cast<uInt>(buff.size());
  6918. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6919. ret = inflate(&strm_, Z_NO_FLUSH);
  6920. assert(ret != Z_STREAM_ERROR);
  6921. switch (ret) {
  6922. case Z_NEED_DICT:
  6923. case Z_DATA_ERROR:
  6924. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6925. }
  6926. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6927. return false;
  6928. }
  6929. }
  6930. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6931. } while (data_length > 0);
  6932. return true;
  6933. }
  6934. #endif
  6935. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6936. inline brotli_compressor::brotli_compressor() {
  6937. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6938. }
  6939. inline brotli_compressor::~brotli_compressor() {
  6940. BrotliEncoderDestroyInstance(state_);
  6941. }
  6942. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6943. bool last, Callback callback) {
  6944. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6945. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6946. auto available_in = data_length;
  6947. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6948. for (;;) {
  6949. if (last) {
  6950. if (BrotliEncoderIsFinished(state_)) { break; }
  6951. } else {
  6952. if (!available_in) { break; }
  6953. }
  6954. auto available_out = buff.size();
  6955. auto next_out = buff.data();
  6956. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6957. &available_out, &next_out, nullptr)) {
  6958. return false;
  6959. }
  6960. auto output_bytes = buff.size() - available_out;
  6961. if (output_bytes) {
  6962. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6963. }
  6964. }
  6965. return true;
  6966. }
  6967. inline brotli_decompressor::brotli_decompressor() {
  6968. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6969. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6970. : BROTLI_DECODER_RESULT_ERROR;
  6971. }
  6972. inline brotli_decompressor::~brotli_decompressor() {
  6973. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6974. }
  6975. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6976. inline bool brotli_decompressor::decompress(const char *data,
  6977. size_t data_length,
  6978. Callback callback) {
  6979. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6980. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6981. return 0;
  6982. }
  6983. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6984. size_t avail_in = data_length;
  6985. size_t total_out;
  6986. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6987. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6988. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6989. char *next_out = buff.data();
  6990. size_t avail_out = buff.size();
  6991. decoder_r = BrotliDecoderDecompressStream(
  6992. decoder_s, &avail_in, &next_in, &avail_out,
  6993. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6994. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6995. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6996. }
  6997. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6998. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6999. }
  7000. #endif
  7001. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7002. inline zstd_compressor::zstd_compressor() {
  7003. ctx_ = ZSTD_createCCtx();
  7004. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  7005. }
  7006. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  7007. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  7008. bool last, Callback callback) {
  7009. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7010. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  7011. ZSTD_inBuffer input = {data, data_length, 0};
  7012. bool finished;
  7013. do {
  7014. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7015. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  7016. if (ZSTD_isError(remaining)) { return false; }
  7017. if (!callback(buff.data(), output.pos)) { return false; }
  7018. finished = last ? (remaining == 0) : (input.pos == input.size);
  7019. } while (!finished);
  7020. return true;
  7021. }
  7022. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  7023. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  7024. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  7025. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  7026. Callback callback) {
  7027. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  7028. ZSTD_inBuffer input = {data, data_length, 0};
  7029. while (input.pos < input.size) {
  7030. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  7031. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  7032. if (ZSTD_isError(remaining)) { return false; }
  7033. if (!callback(buff.data(), output.pos)) { return false; }
  7034. }
  7035. return true;
  7036. }
  7037. #endif
  7038. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  7039. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  7040. // unknown coding, and its payload would be handed back still compressed.
  7041. inline bool is_zlib_encoding(const std::string &encoding) {
  7042. return case_ignore::equal(encoding, "gzip") ||
  7043. case_ignore::equal(encoding, "deflate");
  7044. }
  7045. inline bool is_brotli_encoding(const std::string &encoding) {
  7046. return case_ignore::equal(encoding, "br");
  7047. }
  7048. inline bool is_zstd_encoding(const std::string &encoding) {
  7049. return case_ignore::equal(encoding, "zstd");
  7050. }
  7051. // Returns true if the content coding is one cpp-httplib is able to decompress
  7052. // when the corresponding support is compiled in.
  7053. inline bool is_known_content_encoding(const std::string &encoding) {
  7054. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  7055. is_zstd_encoding(encoding);
  7056. }
  7057. inline std::unique_ptr<decompressor>
  7058. create_decompressor(const std::string &encoding) {
  7059. std::unique_ptr<decompressor> decompressor;
  7060. if (is_zlib_encoding(encoding)) {
  7061. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  7062. decompressor = detail::make_unique<gzip_decompressor>();
  7063. #endif
  7064. } else if (is_brotli_encoding(encoding)) {
  7065. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7066. decompressor = detail::make_unique<brotli_decompressor>();
  7067. #endif
  7068. } else if (is_zstd_encoding(encoding)) {
  7069. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  7070. decompressor = detail::make_unique<zstd_decompressor>();
  7071. #endif
  7072. }
  7073. return decompressor;
  7074. }
  7075. // Returns the best available compressor and its Content-Encoding name.
  7076. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  7077. inline std::pair<std::unique_ptr<compressor>, const char *>
  7078. create_compressor() {
  7079. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  7080. return {detail::make_unique<brotli_compressor>(), "br"};
  7081. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  7082. return {detail::make_unique<gzip_compressor>(), "gzip"};
  7083. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  7084. return {detail::make_unique<zstd_compressor>(), "zstd"};
  7085. #else
  7086. return {nullptr, nullptr};
  7087. #endif
  7088. }
  7089. inline bool is_prohibited_header_name(const std::string &name) {
  7090. // Field names are case-insensitive (RFC 9110 §5.1)
  7091. return case_ignore::equal(name, "REMOTE_ADDR") ||
  7092. case_ignore::equal(name, "REMOTE_PORT") ||
  7093. case_ignore::equal(name, "LOCAL_ADDR") ||
  7094. case_ignore::equal(name, "LOCAL_PORT");
  7095. }
  7096. inline bool has_header(const Headers &headers, const std::string &key) {
  7097. if (is_prohibited_header_name(key)) { return false; }
  7098. return headers.find(key) != headers.end();
  7099. }
  7100. inline const char *get_header_value(const Headers &headers,
  7101. const std::string &key, const char *def,
  7102. size_t id) {
  7103. if (is_prohibited_header_name(key)) {
  7104. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  7105. std::string msg = "Prohibited header name '" + key + "' is specified.";
  7106. throw std::invalid_argument(msg);
  7107. #else
  7108. return "";
  7109. #endif
  7110. }
  7111. auto rng = headers.equal_range(key);
  7112. auto it = bounded_next(rng.first, id, rng.second);
  7113. if (it != rng.second) { return it->second.c_str(); }
  7114. return def;
  7115. }
  7116. inline size_t get_header_value_count(const Headers &headers,
  7117. const std::string &key) {
  7118. return headers.count(key);
  7119. }
  7120. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  7121. // list may be sent as several field lines, and the combined field value is
  7122. // those values joined by commas in the order they were received. Callers that
  7123. // parse such a list must work on the combined value; reading only the first
  7124. // occurrence silently drops whatever the later field lines carry.
  7125. inline std::string get_combined_header_value(const Headers &headers,
  7126. const std::string &key) {
  7127. std::string combined;
  7128. auto rng = headers.equal_range(key);
  7129. for (auto it = rng.first; it != rng.second; ++it) {
  7130. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7131. // elements, so an empty field line must not contribute a bare comma to the
  7132. // combined value.
  7133. if (it->second.empty()) { continue; }
  7134. if (!combined.empty()) { combined += ", "; }
  7135. combined += it->second;
  7136. }
  7137. return combined;
  7138. }
  7139. inline bool has_header_token(const Headers &headers, const std::string &key,
  7140. const std::string &token) {
  7141. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7142. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7143. // several lines. Match complete tokens rather than searching the raw value,
  7144. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7145. auto rng = headers.equal_range(key);
  7146. for (auto it = rng.first; it != rng.second; ++it) {
  7147. const auto &value = it->second;
  7148. if (split_find(value.data(), value.data() + value.size(), ',',
  7149. [&](const char *b, const char *e) {
  7150. return case_ignore::equal(std::string(b, e), token);
  7151. })) {
  7152. return true;
  7153. }
  7154. }
  7155. return false;
  7156. }
  7157. template <typename Map>
  7158. inline typename Map::mapped_type
  7159. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7160. auto rng = m.equal_range(key);
  7161. auto it = bounded_next(rng.first, id, rng.second);
  7162. if (it != rng.second) { return it->second; }
  7163. return typename Map::mapped_type();
  7164. }
  7165. inline void set_header(Headers &headers, const std::string &key,
  7166. const std::string &val) {
  7167. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7168. }
  7169. // Drops the fields set_header() would refuse, from headers an application can
  7170. // fill directly: CR/LF in one would split the message.
  7171. inline void erase_invalid_fields(Headers &headers) {
  7172. for (auto it = headers.begin(); it != headers.end();) {
  7173. if (fields::is_field_valid(it->first, it->second)) {
  7174. ++it;
  7175. } else {
  7176. it = headers.erase(it);
  7177. }
  7178. }
  7179. }
  7180. inline bool read_headers(Stream &strm, Headers &headers) {
  7181. const auto bufsiz = 2048;
  7182. char buf[bufsiz];
  7183. stream_line_reader line_reader(strm, buf, bufsiz);
  7184. size_t header_count = 0;
  7185. for (;;) {
  7186. if (!line_reader.getline()) { return false; }
  7187. // Check if the line ends with CRLF.
  7188. auto line_terminator_len = 2;
  7189. if (line_reader.end_with_crlf()) {
  7190. // Blank line indicates end of headers.
  7191. if (line_reader.size() == 2) { break; }
  7192. } else {
  7193. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7194. // Blank line indicates end of headers.
  7195. if (line_reader.size() == 1) { break; }
  7196. line_terminator_len = 1;
  7197. #else
  7198. continue; // Skip invalid line.
  7199. #endif
  7200. }
  7201. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7202. // Check header count limit
  7203. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7204. // Exclude line terminator
  7205. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7206. if (!parse_header(line_reader.ptr(), end,
  7207. [&](const std::string &key, const std::string &val) {
  7208. headers.emplace(key, val);
  7209. })) {
  7210. return false;
  7211. }
  7212. header_count++;
  7213. }
  7214. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7215. // headers that have different values to prevent request smuggling.
  7216. auto cl_range = headers.equal_range("Content-Length");
  7217. if (cl_range.first != cl_range.second) {
  7218. const auto &first_val = cl_range.first->second;
  7219. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7220. if (it->second != first_val) { return false; }
  7221. }
  7222. }
  7223. return true;
  7224. }
  7225. // Parsed by hand: std::regex_match recurses once per character of the reason
  7226. // phrase, which a server can make as long as a whole line.
  7227. inline bool parse_status_line(const char *line, std::string &version,
  7228. int &status, std::string &reason) {
  7229. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7230. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7231. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7232. !is_ascii_digit(line[11])) {
  7233. return false;
  7234. }
  7235. auto p = line + 12;
  7236. auto reason_begin = p;
  7237. if (*p == ' ') {
  7238. reason_begin = ++p;
  7239. p += std::strcspn(p, "\r\n");
  7240. }
  7241. auto reason_end = p;
  7242. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7243. if (*p == '\r') { p++; }
  7244. #else
  7245. if (*p++ != '\r') { return false; }
  7246. #endif
  7247. if (*p++ != '\n' || *p != '\0') { return false; }
  7248. version.assign(line, 8);
  7249. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7250. reason.assign(reason_begin, reason_end);
  7251. return true;
  7252. }
  7253. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7254. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7255. struct WebSocketUpgradeResponse {
  7256. Error error = Error::Success;
  7257. int status = -1;
  7258. Headers headers;
  7259. std::string selected_subprotocol;
  7260. };
  7261. // Reads a response's status line and headers, leaving any body unread. An
  7262. // unparsable status line is no stream error; it just leaves `status` as is.
  7263. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7264. const auto bufsiz = 2048;
  7265. char buf[bufsiz];
  7266. stream_line_reader line_reader(strm, buf, bufsiz);
  7267. if (!line_reader.getline()) { return false; }
  7268. std::string version;
  7269. std::string reason;
  7270. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7271. return true;
  7272. }
  7273. return read_headers(strm, headers);
  7274. }
  7275. inline bool
  7276. read_websocket_upgrade_response(Stream &strm,
  7277. const std::string &expected_accept,
  7278. const std::string &offered_subprotocols,
  7279. WebSocketUpgradeResponse &upgrade) {
  7280. // The headers of a rejection are kept so the caller can see why the server
  7281. // refused the upgrade.
  7282. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7283. upgrade.error = Error::Read;
  7284. return false;
  7285. }
  7286. const auto &headers = upgrade.headers;
  7287. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7288. upgrade.error = Error::WebSocketHandshake;
  7289. return false;
  7290. }
  7291. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7292. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7293. upgrade.error = Error::WebSocketHandshake;
  7294. return false;
  7295. }
  7296. // Verify Connection: Upgrade
  7297. if (!has_header_token(headers, "Connection", "upgrade")) {
  7298. upgrade.error = Error::WebSocketHandshake;
  7299. return false;
  7300. }
  7301. // Verify Sec-WebSocket-Accept header value
  7302. auto it = headers.find("Sec-WebSocket-Accept");
  7303. if (it == headers.end() || it->second != expected_accept) {
  7304. upgrade.error = Error::WebSocketHandshake;
  7305. return false;
  7306. }
  7307. // Extract negotiated subprotocol
  7308. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7309. if (proto_it != headers.end()) {
  7310. upgrade.selected_subprotocol = proto_it->second;
  7311. }
  7312. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7313. if (!upgrade.selected_subprotocol.empty()) {
  7314. auto was_offered = false;
  7315. split(offered_subprotocols.data(),
  7316. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7317. [&](const char *b, const char *e) {
  7318. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7319. was_offered = true;
  7320. }
  7321. });
  7322. if (!was_offered) {
  7323. upgrade.error = Error::WebSocketHandshake;
  7324. return false;
  7325. }
  7326. }
  7327. return true;
  7328. }
  7329. enum class ReadContentResult {
  7330. Success, // Successfully read the content
  7331. PayloadTooLarge, // The content exceeds the specified payload limit
  7332. Error // An error occurred while reading the content
  7333. };
  7334. inline ReadContentResult read_content_with_length(
  7335. Stream &strm, size_t len, DownloadProgress progress,
  7336. ContentReceiverWithProgress out,
  7337. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7338. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7339. detail::BodyReader br;
  7340. br.stream = &strm;
  7341. br.has_content_length = true;
  7342. br.content_length = len;
  7343. br.payload_max_length = payload_max_length;
  7344. br.chunked = false;
  7345. br.bytes_read = 0;
  7346. br.last_error = Error::Success;
  7347. size_t r = 0;
  7348. while (r < len) {
  7349. auto read_len = static_cast<size_t>(len - r);
  7350. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7351. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7352. if (n <= 0) {
  7353. // Check if it was a payload size error
  7354. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7355. return ReadContentResult::PayloadTooLarge;
  7356. }
  7357. return ReadContentResult::Error;
  7358. }
  7359. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7360. return ReadContentResult::Error;
  7361. }
  7362. r += static_cast<size_t>(n);
  7363. if (progress) {
  7364. if (!progress(r, len)) { return ReadContentResult::Error; }
  7365. }
  7366. }
  7367. return ReadContentResult::Success;
  7368. }
  7369. inline ReadContentResult
  7370. read_content_without_length(Stream &strm, size_t payload_max_length,
  7371. ContentReceiverWithProgress out) {
  7372. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7373. size_t r = 0;
  7374. for (;;) {
  7375. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7376. if (n == 0) { return ReadContentResult::Success; }
  7377. if (n < 0) { return ReadContentResult::Error; }
  7378. // Check if adding this data would exceed the payload limit
  7379. if (payload_max_length > 0 &&
  7380. (r > payload_max_length ||
  7381. payload_max_length - r < static_cast<size_t>(n))) {
  7382. return ReadContentResult::PayloadTooLarge;
  7383. }
  7384. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7385. return ReadContentResult::Error;
  7386. }
  7387. r += static_cast<size_t>(n);
  7388. }
  7389. return ReadContentResult::Success;
  7390. }
  7391. template <typename T>
  7392. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7393. size_t payload_max_length,
  7394. ContentReceiverWithProgress out) {
  7395. detail::ChunkedDecoder dec(strm);
  7396. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7397. size_t total_len = 0;
  7398. for (;;) {
  7399. size_t chunk_offset = 0;
  7400. size_t chunk_total = 0;
  7401. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7402. if (n < 0) { return ReadContentResult::Error; }
  7403. if (n == 0) {
  7404. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7405. return ReadContentResult::Error;
  7406. }
  7407. return ReadContentResult::Success;
  7408. }
  7409. if (payload_max_length > 0 &&
  7410. (total_len > payload_max_length ||
  7411. payload_max_length - total_len < static_cast<size_t>(n))) {
  7412. return ReadContentResult::PayloadTooLarge;
  7413. }
  7414. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7415. return ReadContentResult::Error;
  7416. }
  7417. total_len += static_cast<size_t>(n);
  7418. }
  7419. }
  7420. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7421. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7422. // is the final transfer coding. A single field value may list several
  7423. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7424. // several Transfer-Encoding lines, which combine into one comma-separated
  7425. // list in the order the lines were received. Headers preserves that order,
  7426. // so the final coding is the last token of the last line. Match it
  7427. // case-insensitively rather than comparing the whole value against
  7428. // "chunked".
  7429. //
  7430. // Security: reading a chunked message as unframed leaves its body in the
  7431. // socket, where a keep-alive connection parses it as a smuggled request.
  7432. // Server::process_request() answers 400 and closes when the final coding is
  7433. // not chunked, so a request whose framing cannot be determined never
  7434. // reaches the "no body" path.
  7435. auto rng = headers.equal_range("Transfer-Encoding");
  7436. if (rng.first == rng.second) { return false; }
  7437. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7438. // combined list ending in nothing rather than inheriting the line before it.
  7439. std::string last_coding;
  7440. for (auto it = rng.first; it != rng.second; ++it) {
  7441. const auto &value = it->second;
  7442. last_coding.clear();
  7443. split(value.data(), value.data() + value.size(), ',',
  7444. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7445. }
  7446. return case_ignore::equal(last_coding, "chunked");
  7447. }
  7448. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7449. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7450. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7451. return msg.has_header("Transfer-Encoding") &&
  7452. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7453. }
  7454. inline bool has_conflicting_content_length(const Headers &headers) {
  7455. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7456. // Content-Length is framed ambiguously. The body readers here delimit it by
  7457. // the transfer coding and drop Content-Length, while an intermediary may do
  7458. // the reverse, so the two disagree on where the body ends and a reused
  7459. // connection is desynchronised (request/response smuggling). Content-Length:
  7460. // 0 is tolerated for compatibility with existing peers.
  7461. return has_header(headers, "Transfer-Encoding") &&
  7462. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7463. }
  7464. template <typename T, typename U>
  7465. bool prepare_content_receiver(T &x, int &status,
  7466. ContentReceiverWithProgress receiver,
  7467. bool decompress, size_t payload_max_length,
  7468. bool &exceed_payload_max_length, U callback) {
  7469. if (decompress) {
  7470. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7471. std::unique_ptr<decompressor> decompressor;
  7472. if (!encoding.empty()) {
  7473. // A coding we know about but were not built with is an error. An
  7474. // unrecognized coding (including "identity") is left alone and the
  7475. // payload is passed through as-is, since some servers misuse the header,
  7476. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7477. decompressor = detail::create_decompressor(encoding);
  7478. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7479. status = StatusCode::UnsupportedMediaType_415;
  7480. return false;
  7481. }
  7482. }
  7483. if (decompressor) {
  7484. if (decompressor->is_valid()) {
  7485. size_t decompressed_size = 0;
  7486. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7487. size_t off, size_t len) {
  7488. return decompressor->decompress(
  7489. buf, n, [&](const char *buf2, size_t n2) {
  7490. // Guard against zip-bomb: check
  7491. // decompressed size against limit.
  7492. if (payload_max_length > 0 &&
  7493. (decompressed_size >= payload_max_length ||
  7494. n2 > payload_max_length - decompressed_size)) {
  7495. exceed_payload_max_length = true;
  7496. return false;
  7497. }
  7498. decompressed_size += n2;
  7499. return receiver(buf2, n2, off, len);
  7500. });
  7501. };
  7502. return callback(std::move(out));
  7503. } else {
  7504. status = StatusCode::InternalServerError_500;
  7505. return false;
  7506. }
  7507. }
  7508. }
  7509. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7510. size_t len) {
  7511. return receiver(buf, n, off, len);
  7512. };
  7513. return callback(std::move(out));
  7514. }
  7515. template <typename T>
  7516. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7517. DownloadProgress progress,
  7518. ContentReceiverWithProgress receiver, bool decompress) {
  7519. bool exceed_payload_max_length = false;
  7520. return prepare_content_receiver(
  7521. x, status, std::move(receiver), decompress, payload_max_length,
  7522. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7523. auto ret = true;
  7524. // Note: exceed_payload_max_length may also be set by the decompressor
  7525. // wrapper in prepare_content_receiver when the decompressed payload
  7526. // size exceeds the limit.
  7527. if (is_chunked_transfer_encoding(x.headers)) {
  7528. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7529. if (result == ReadContentResult::Success) {
  7530. ret = true;
  7531. } else if (result == ReadContentResult::PayloadTooLarge) {
  7532. exceed_payload_max_length = true;
  7533. ret = false;
  7534. } else {
  7535. ret = false;
  7536. }
  7537. } else if (!has_header(x.headers, "Content-Length")) {
  7538. auto result =
  7539. read_content_without_length(strm, payload_max_length, out);
  7540. if (result == ReadContentResult::Success) {
  7541. ret = true;
  7542. } else if (result == ReadContentResult::PayloadTooLarge) {
  7543. exceed_payload_max_length = true;
  7544. ret = false;
  7545. } else {
  7546. ret = false;
  7547. }
  7548. } else {
  7549. auto is_invalid_value = false;
  7550. auto len = get_header_value_u64(x.headers, "Content-Length",
  7551. (std::numeric_limits<size_t>::max)(),
  7552. 0, is_invalid_value);
  7553. if (is_invalid_value) {
  7554. ret = false;
  7555. } else if (len > 0) {
  7556. auto result = read_content_with_length(
  7557. strm, len, std::move(progress), out, payload_max_length);
  7558. ret = (result == ReadContentResult::Success);
  7559. if (result == ReadContentResult::PayloadTooLarge) {
  7560. exceed_payload_max_length = true;
  7561. }
  7562. }
  7563. }
  7564. if (!ret) {
  7565. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7566. : StatusCode::BadRequest_400;
  7567. }
  7568. return ret;
  7569. });
  7570. }
  7571. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7572. const std::string &path) {
  7573. // Neither the method nor the request target may carry CR/LF, SP or other
  7574. // control octets; otherwise a value smuggled into either splits the request
  7575. // line and injects headers or a whole request.
  7576. if (!fields::is_token(method)) { return -1; }
  7577. if (!fields::is_request_target(path)) { return -1; }
  7578. std::string s = method;
  7579. s += ' ';
  7580. s += path;
  7581. s += " HTTP/1.1\r\n";
  7582. return strm.write(s.data(), s.size());
  7583. }
  7584. inline ssize_t write_response_line(Stream &strm, int status) {
  7585. std::string s = "HTTP/1.1 ";
  7586. s += std::to_string(status);
  7587. s += ' ';
  7588. s += httplib::status_message(status);
  7589. s += "\r\n";
  7590. return strm.write(s.data(), s.size());
  7591. }
  7592. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7593. ssize_t write_len = 0;
  7594. for (const auto &x : headers) {
  7595. std::string s;
  7596. s = x.first;
  7597. s += ": ";
  7598. s += x.second;
  7599. s += "\r\n";
  7600. auto len = strm.write(s.data(), s.size());
  7601. if (len < 0) { return len; }
  7602. write_len += len;
  7603. }
  7604. auto len = strm.write("\r\n");
  7605. if (len < 0) { return len; }
  7606. write_len += len;
  7607. return write_len;
  7608. }
  7609. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7610. size_t offset = 0;
  7611. while (offset < l) {
  7612. auto length = strm.write(d + offset, l - offset);
  7613. if (length < 0) { return false; }
  7614. offset += static_cast<size_t>(length);
  7615. }
  7616. return true;
  7617. }
  7618. template <typename T>
  7619. inline bool write_content_with_progress(Stream &strm,
  7620. const ContentProvider &content_provider,
  7621. size_t offset, size_t length,
  7622. T is_shutting_down,
  7623. const UploadProgress &upload_progress,
  7624. Error &error) {
  7625. size_t end_offset = offset + length;
  7626. size_t start_offset = offset;
  7627. auto ok = true;
  7628. auto finished = false;
  7629. DataSink data_sink;
  7630. data_sink.write = [&](const char *d, size_t l) -> bool {
  7631. if (ok) {
  7632. // Bytes past `length` would follow the framed body, where the peer reads
  7633. // them as the next message. Write only what fits and fail the rest.
  7634. if (l > end_offset - offset) {
  7635. l = end_offset - offset;
  7636. ok = false;
  7637. }
  7638. if (write_data(strm, d, l)) {
  7639. offset += l;
  7640. if (upload_progress && length > 0) {
  7641. size_t current_written = offset - start_offset;
  7642. if (!upload_progress(current_written, length)) {
  7643. ok = false;
  7644. return false;
  7645. }
  7646. }
  7647. } else {
  7648. ok = false;
  7649. }
  7650. }
  7651. return ok;
  7652. };
  7653. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7654. // The body is framed by `length`, so a provider that reports itself done
  7655. // early has truncated it. Record that and let the short-body check below
  7656. // fail the write, rather than calling the provider again forever.
  7657. data_sink.done = [&]() { finished = true; };
  7658. while (offset < end_offset && !finished && !is_shutting_down()) {
  7659. auto last_offset = offset;
  7660. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7661. error = Error::Write;
  7662. return false;
  7663. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7664. error = Error::Canceled;
  7665. return false;
  7666. } else if (!ok) {
  7667. error = Error::Write;
  7668. return false;
  7669. }
  7670. // A provider that reports success without writing anything and without
  7671. // reporting itself done gets handed the same offset and length again on
  7672. // the next pass, so it would spin here for as long as the peer stays
  7673. // connected. Treat making no progress as a short body, like done() early.
  7674. if (!finished && offset == last_offset) {
  7675. error = Error::Write;
  7676. return false;
  7677. }
  7678. }
  7679. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7680. error = Error::Write;
  7681. return false;
  7682. }
  7683. error = Error::Success;
  7684. return true;
  7685. }
  7686. template <typename T>
  7687. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7688. size_t offset, size_t length, T is_shutting_down,
  7689. Error &error) {
  7690. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7691. is_shutting_down, nullptr, error);
  7692. }
  7693. template <typename T>
  7694. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7695. size_t offset, size_t length,
  7696. const T &is_shutting_down) {
  7697. auto error = Error::Success;
  7698. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7699. error);
  7700. }
  7701. template <typename T>
  7702. inline bool
  7703. write_content_without_length(Stream &strm,
  7704. const ContentProvider &content_provider,
  7705. const T &is_shutting_down) {
  7706. size_t offset = 0;
  7707. auto data_available = true;
  7708. auto ok = true;
  7709. DataSink data_sink;
  7710. data_sink.write = [&](const char *d, size_t l) -> bool {
  7711. if (ok) {
  7712. offset += l;
  7713. if (!write_data(strm, d, l)) { ok = false; }
  7714. }
  7715. return ok;
  7716. };
  7717. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7718. data_sink.done = [&](void) { data_available = false; };
  7719. while (data_available && !is_shutting_down()) {
  7720. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7721. return false;
  7722. } else if (!content_provider(offset, 0, data_sink)) {
  7723. return false;
  7724. } else if (!ok) {
  7725. return false;
  7726. }
  7727. }
  7728. return !data_available; // true only if done() was called, false if shutting
  7729. // down
  7730. }
  7731. // Runs a known-length content provider to completion and compresses what it
  7732. // writes into `out`, chunk by chunk, without holding the identity form.
  7733. inline bool compress_content_provider(const ContentProvider &content_provider,
  7734. size_t length, compressor &cmp,
  7735. std::string &out) {
  7736. size_t offset = 0;
  7737. auto ok = true;
  7738. auto finished = false;
  7739. DataSink data_sink;
  7740. auto append = [&](const char *data, size_t data_len) {
  7741. out.append(data, data_len);
  7742. return true;
  7743. };
  7744. data_sink.write = [&](const char *d, size_t l) -> bool {
  7745. if (!ok) { return false; }
  7746. offset += l;
  7747. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7748. return ok;
  7749. };
  7750. // The body is framed by `length`, so a provider that reports itself done
  7751. // early has truncated it; the short-body check below turns that into a
  7752. // failure rather than calling the provider again forever.
  7753. data_sink.done = [&]() { finished = true; };
  7754. while (offset < length && !finished) {
  7755. auto prev_offset = offset;
  7756. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7757. return false;
  7758. }
  7759. // No Stream to block on here, so a provider that keeps returning true
  7760. // without writing would spin. Treat a pass that made no progress as a
  7761. // failure.
  7762. if (offset == prev_offset) { return false; }
  7763. }
  7764. if (offset != length) { return false; }
  7765. return cmp.compress(nullptr, 0, true, append);
  7766. }
  7767. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7768. // and the file flag, so recording them has to come after; keeping all of it
  7769. // here means a third file-serving path cannot get that order wrong.
  7770. inline void set_file_content_provider(Response &res,
  7771. const std::shared_ptr<mmap> &m,
  7772. const std::string &content_type,
  7773. EncodingType encoding) {
  7774. // One read and one write move up to this much of the file at a time.
  7775. auto buf = std::make_shared<std::vector<char>>(
  7776. (std::min)(m->size(), size_t(256 * 1024)));
  7777. res.set_content_provider(
  7778. m->size(), content_type,
  7779. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7780. // Never read past the file, which ends the response early if it has
  7781. // shrunk since it was opened.
  7782. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7783. if (n == 0) { return false; }
  7784. sink.write(buf->data(), n);
  7785. return true;
  7786. });
  7787. res.is_file_content_provider_ = true;
  7788. res.content_coding_ = encoding;
  7789. }
  7790. template <typename T, typename U>
  7791. inline bool
  7792. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7793. const T &is_shutting_down, U &compressor, Error &error) {
  7794. size_t offset = 0;
  7795. auto data_available = true;
  7796. auto ok = true;
  7797. DataSink data_sink;
  7798. data_sink.write = [&](const char *d, size_t l) -> bool {
  7799. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7800. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7801. // zero-length chunk is the terminator, so it must not be emitted here.
  7802. if (ok && l > 0) {
  7803. offset += l;
  7804. std::string payload;
  7805. if (compressor.compress(d, l, false,
  7806. [&](const char *data, size_t data_len) {
  7807. payload.append(data, data_len);
  7808. return true;
  7809. })) {
  7810. if (!payload.empty()) {
  7811. // Emit chunked response header and footer for each chunk
  7812. auto chunk =
  7813. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7814. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7815. }
  7816. } else {
  7817. ok = false;
  7818. }
  7819. }
  7820. return ok;
  7821. };
  7822. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7823. auto done_with_trailer = [&](const Headers *trailer) {
  7824. if (!ok) { return; }
  7825. data_available = false;
  7826. std::string payload;
  7827. if (!compressor.compress(nullptr, 0, true,
  7828. [&](const char *data, size_t data_len) {
  7829. payload.append(data, data_len);
  7830. return true;
  7831. })) {
  7832. ok = false;
  7833. return;
  7834. }
  7835. if (!payload.empty()) {
  7836. // Emit chunked response header and footer for each chunk
  7837. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7838. if (!write_data(strm, chunk.data(), chunk.size())) {
  7839. ok = false;
  7840. return;
  7841. }
  7842. }
  7843. constexpr const char done_marker[] = "0\r\n";
  7844. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7845. // Trailer
  7846. if (trailer) {
  7847. for (const auto &kv : *trailer) {
  7848. // Skip fields with invalid names or values to prevent response
  7849. // splitting via CR/LF injection, matching set_header().
  7850. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7851. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7852. if (!write_data(strm, field_line.data(), field_line.size())) {
  7853. ok = false;
  7854. }
  7855. }
  7856. }
  7857. constexpr const char crlf[] = "\r\n";
  7858. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7859. };
  7860. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7861. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7862. done_with_trailer(&trailer);
  7863. };
  7864. while (data_available && !is_shutting_down()) {
  7865. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7866. error = Error::Write;
  7867. return false;
  7868. } else if (!content_provider(offset, 0, data_sink)) {
  7869. error = Error::Canceled;
  7870. return false;
  7871. } else if (!ok) {
  7872. error = Error::Write;
  7873. return false;
  7874. }
  7875. }
  7876. if (data_available) { // exited due to is_shutting_down(), not done()
  7877. error = Error::Write;
  7878. return false;
  7879. }
  7880. error = Error::Success;
  7881. return true;
  7882. }
  7883. template <typename T, typename U>
  7884. inline bool write_content_chunked(Stream &strm,
  7885. const ContentProvider &content_provider,
  7886. const T &is_shutting_down, U &compressor) {
  7887. auto error = Error::Success;
  7888. return write_content_chunked(strm, content_provider, is_shutting_down,
  7889. compressor, error);
  7890. }
  7891. template <typename T>
  7892. inline bool redirect(T &cli, Request &req, Response &res,
  7893. const std::string &path, const std::string &location,
  7894. Error &error) {
  7895. Request new_req = req;
  7896. new_req.path = path;
  7897. new_req.params.clear();
  7898. new_req.redirect_count_ -= 1;
  7899. if (res.status == StatusCode::SeeOther_303 &&
  7900. (req.method != "GET" && req.method != "HEAD")) {
  7901. new_req.method = "GET";
  7902. new_req.body.clear();
  7903. new_req.headers.clear();
  7904. new_req.content_length_ = 0;
  7905. new_req.content_provider_ = nullptr;
  7906. new_req.is_chunked_content_provider_ = false;
  7907. }
  7908. Response new_res;
  7909. auto ret = cli.send(new_req, new_res, error);
  7910. if (ret) {
  7911. req = std::move(new_req);
  7912. res = std::move(new_res);
  7913. if (res.location.empty()) { res.location = location; }
  7914. }
  7915. return ret;
  7916. }
  7917. inline std::string params_to_query_str(const Params &params) {
  7918. std::string query;
  7919. for (auto it = params.begin(); it != params.end(); ++it) {
  7920. if (it != params.begin()) { query += '&'; }
  7921. query += encode_query_component(it->first);
  7922. query += '=';
  7923. query += encode_query_component(it->second);
  7924. }
  7925. return query;
  7926. }
  7927. // Splits one "key=value" span of a query string at its first '='. A span with
  7928. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7929. // "?flag" keeps its name.
  7930. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7931. std::string &val) {
  7932. divide(b, static_cast<std::size_t>(e - b), '=',
  7933. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7934. std::size_t rhs_size) {
  7935. key.assign(lhs_data, lhs_size);
  7936. val.assign(rhs_data, rhs_size);
  7937. });
  7938. }
  7939. inline void parse_query_text(const char *data, std::size_t size,
  7940. Params &params) {
  7941. std::set<std::string> cache;
  7942. split(data, data + size, '&', [&](const char *b, const char *e) {
  7943. std::string kv(b, e);
  7944. if (cache.find(kv) != cache.end()) { return; }
  7945. cache.insert(std::move(kv));
  7946. std::string key;
  7947. std::string val;
  7948. divide_query_pair(b, e, key, val);
  7949. if (!key.empty()) {
  7950. params.emplace(decode_query_component(key), decode_query_component(val));
  7951. }
  7952. });
  7953. }
  7954. inline void parse_query_text(const std::string &s, Params &params) {
  7955. parse_query_text(s.data(), s.size(), params);
  7956. }
  7957. // Normalize a query string by decoding and re-encoding each key/value pair
  7958. // while preserving the original parameter order. This avoids double-encoding
  7959. // and ensures consistent encoding. It works on the raw string rather than
  7960. // parsing into Params and re-serializing, because that round trip cannot
  7961. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7962. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7963. // duplicated pairs.
  7964. inline std::string normalize_query_string(const std::string &query) {
  7965. std::string result;
  7966. split(query.data(), query.data() + query.size(), '&',
  7967. [&](const char *b, const char *e) {
  7968. std::string key;
  7969. std::string val;
  7970. divide_query_pair(b, e, key, val);
  7971. if (!key.empty()) {
  7972. auto dec_key = decode_query_component(key);
  7973. auto dec_val = decode_query_component(val);
  7974. if (!result.empty()) { result += '&'; }
  7975. result += encode_query_component(dec_key);
  7976. if (!val.empty() || std::find(b, e, '=') != e) {
  7977. result += '=';
  7978. result += encode_query_component(dec_val);
  7979. }
  7980. }
  7981. });
  7982. return result;
  7983. }
  7984. // The query of a client's path: what follows '?', up to the fragment.
  7985. inline std::string query_of(const std::string &path) {
  7986. auto fragment_pos = path.find('#');
  7987. auto query_pos = path.find('?');
  7988. return query_pos < fragment_pos
  7989. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7990. : std::string();
  7991. }
  7992. // Build the request target that goes on the wire from a caller-supplied path.
  7993. // Shared by the buffered send path and the streaming API so that both put the
  7994. // same bytes in the request line for the same input.
  7995. inline std::string encode_request_target(const std::string &uri,
  7996. bool path_encode) {
  7997. // The fragment stays with the client (RFC 9110 §7.1).
  7998. auto target = uri.substr(0, uri.find('#'));
  7999. // `substr(0, npos)` yields the whole string, which is what the no-query
  8000. // case needs.
  8001. auto query_pos = target.find('?');
  8002. auto path_part = target.substr(0, query_pos);
  8003. std::string query_part;
  8004. if (query_pos != std::string::npos) {
  8005. query_part = target.substr(query_pos + 1);
  8006. }
  8007. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  8008. if (!query_part.empty()) {
  8009. // When path encoding is disabled the caller has supplied an already-encoded
  8010. // target and expects the exact bytes to be sent on the wire, so skip
  8011. // normalization for the query too. Normalizing would decode-then-re-encode
  8012. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  8013. // which a strict RFC 3986 server decodes back as `+`, not a space).
  8014. if (path_encode) {
  8015. auto normalized = normalize_query_string(query_part);
  8016. if (!normalized.empty()) {
  8017. result += '?';
  8018. result += normalized;
  8019. }
  8020. } else {
  8021. result += '?';
  8022. result += query_part;
  8023. }
  8024. }
  8025. return result;
  8026. }
  8027. inline bool parse_multipart_boundary(const std::string &content_type,
  8028. std::string &boundary) {
  8029. std::map<std::string, std::string> params;
  8030. extract_media_type(content_type, &params);
  8031. auto it = params.find("boundary");
  8032. if (it == params.end()) { return false; }
  8033. boundary = it->second;
  8034. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  8035. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  8036. // bytes costs a nearly full comparison at nearly every position: the
  8037. // boundary's length multiplies the worst-case cost of scanning a body.
  8038. return !boundary.empty() && boundary.size() <= 70;
  8039. }
  8040. inline void parse_disposition_params(const std::string &s, Params &params) {
  8041. std::set<std::string> cache;
  8042. split_unquoted(
  8043. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  8044. std::string kv(b, e);
  8045. if (cache.find(kv) != cache.end()) { return; }
  8046. cache.insert(kv);
  8047. std::string key;
  8048. std::string val;
  8049. divide_param_pair(b, e, key, val);
  8050. if (!key.empty()) {
  8051. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  8052. }
  8053. });
  8054. }
  8055. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8056. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  8057. #else
  8058. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  8059. #endif
  8060. auto is_valid = [](const std::string &str) {
  8061. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  8062. };
  8063. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  8064. const auto pos = static_cast<size_t>(6);
  8065. const auto len = static_cast<size_t>(s.size() - 6);
  8066. auto all_valid_ranges = true;
  8067. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  8068. if (!all_valid_ranges) { return; }
  8069. const auto it = std::find(b, e, '-');
  8070. if (it == e) {
  8071. all_valid_ranges = false;
  8072. return;
  8073. }
  8074. const auto lhs = std::string(b, it);
  8075. const auto rhs = std::string(it + 1, e);
  8076. if (!is_valid(lhs) || !is_valid(rhs)) {
  8077. all_valid_ranges = false;
  8078. return;
  8079. }
  8080. ssize_t first = -1;
  8081. if (!lhs.empty()) {
  8082. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  8083. // would turn the range into a suffix range.
  8084. auto res =
  8085. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  8086. if (res.ec != std::errc{}) {
  8087. all_valid_ranges = false;
  8088. return;
  8089. }
  8090. }
  8091. ssize_t last = -1;
  8092. if (!rhs.empty()) {
  8093. // An overflowing last-byte-pos is past any content length, so keeping
  8094. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  8095. ssize_t v;
  8096. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  8097. if (res.ec == std::errc{}) { last = v; }
  8098. }
  8099. if ((first == -1 && last == -1) ||
  8100. (first != -1 && last != -1 && first > last)) {
  8101. all_valid_ranges = false;
  8102. return;
  8103. }
  8104. ranges.emplace_back(first, last);
  8105. });
  8106. return all_valid_ranges && !ranges.empty();
  8107. }
  8108. return false;
  8109. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  8110. }
  8111. #else
  8112. } catch (...) { return false; }
  8113. #endif
  8114. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  8115. inline std::string remove_quoted_strings(const std::string &s) {
  8116. std::string out;
  8117. auto in_quotes = false;
  8118. for (size_t i = 0; i < s.size(); i++) {
  8119. if (s[i] == '"') {
  8120. in_quotes = !in_quotes;
  8121. } else if (!in_quotes) {
  8122. out += s[i];
  8123. } else if (s[i] == '\\') {
  8124. i++;
  8125. }
  8126. }
  8127. return out;
  8128. }
  8129. inline bool parse_accept_header(const std::string &s,
  8130. std::vector<std::string> &content_types) {
  8131. // Parameter values are not used here, so a quoted-string is dropped rather
  8132. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8133. if (s.find('"') != std::string::npos) {
  8134. return parse_accept_header(remove_quoted_strings(s), content_types);
  8135. }
  8136. content_types.clear();
  8137. // Empty string is considered valid (no preference)
  8138. if (s.empty()) { return true; }
  8139. struct AcceptEntry {
  8140. std::string media_type;
  8141. double quality;
  8142. int order;
  8143. };
  8144. std::vector<AcceptEntry> entries;
  8145. int order = 0;
  8146. bool has_invalid_entry = false;
  8147. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8148. // has to parse and ignore empty list elements, so a leading, trailing or
  8149. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8150. // split() skips them, and the header length limit bounds how many a sender
  8151. // can send, so ignoring all of them cannot be used as a denial-of-service
  8152. // vector.
  8153. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8154. std::string entry(b, e);
  8155. entry = trim_copy(entry);
  8156. AcceptEntry accept_entry;
  8157. accept_entry.order = order++;
  8158. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8159. accept_entry.media_type, accept_entry.quality)) {
  8160. has_invalid_entry = true;
  8161. return;
  8162. }
  8163. // Remove additional parameters from media type
  8164. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8165. // Basic validation of media type format
  8166. if (accept_entry.media_type.empty()) {
  8167. has_invalid_entry = true;
  8168. return;
  8169. }
  8170. // Check for basic media type format (should contain '/' or be '*')
  8171. if (accept_entry.media_type != "*" &&
  8172. accept_entry.media_type.find('/') == std::string::npos) {
  8173. has_invalid_entry = true;
  8174. return;
  8175. }
  8176. entries.push_back(std::move(accept_entry));
  8177. });
  8178. // Return false if any invalid entry was found
  8179. if (has_invalid_entry) { return false; }
  8180. // Sort by quality (descending), then by original order (ascending)
  8181. std::sort(entries.begin(), entries.end(),
  8182. [](const AcceptEntry &a, const AcceptEntry &b) {
  8183. if (a.quality != b.quality) {
  8184. return a.quality > b.quality; // Higher quality first
  8185. }
  8186. return a.order < b.order; // Earlier order first for same quality
  8187. });
  8188. // Extract sorted media types
  8189. content_types.reserve(entries.size());
  8190. for (auto &entry : entries) {
  8191. content_types.push_back(std::move(entry.media_type));
  8192. }
  8193. return true;
  8194. }
  8195. class FormDataParser {
  8196. public:
  8197. FormDataParser() = default;
  8198. void set_boundary(std::string &&boundary) {
  8199. boundary_ = std::move(boundary);
  8200. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8201. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8202. }
  8203. bool is_valid() const { return is_valid_; }
  8204. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8205. const ContentReceiver &content_callback) {
  8206. // Once the close delimiter has been seen the rest of the body is epilogue
  8207. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8208. // spread across reads is not copied in only to be erased right away.
  8209. if (state_ == 5) { return true; }
  8210. buf_append(buf, n);
  8211. while (buf_size() > 0) {
  8212. switch (state_) {
  8213. case 0: { // Initial boundary
  8214. auto pos = buf_find(dash_boundary_crlf_);
  8215. if (pos == buf_size()) {
  8216. // Not found yet: keep only a possible partial boundary at the tail so
  8217. // that a body which never contains the boundary cannot grow the
  8218. // buffer (and get rescanned from the start) without bound.
  8219. auto keep = dash_boundary_crlf_.size() - 1;
  8220. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8221. return true;
  8222. }
  8223. buf_erase(pos + dash_boundary_crlf_.size());
  8224. state_ = 1;
  8225. break;
  8226. }
  8227. case 1: { // New entry
  8228. clear_file_info();
  8229. header_searched_ = 0;
  8230. state_ = 2;
  8231. break;
  8232. }
  8233. case 2: { // Headers
  8234. // Resume where the last call stopped looking, so that a line arriving
  8235. // a few bytes at a time is not searched from its start each time.
  8236. auto pos = buf_find(crlf_, header_searched_);
  8237. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8238. while (pos < buf_size()) {
  8239. // Empty line
  8240. if (pos == 0) {
  8241. if (!header_callback(file_)) {
  8242. is_valid_ = false;
  8243. return false;
  8244. }
  8245. buf_erase(crlf_.size());
  8246. state_ = 3;
  8247. break;
  8248. }
  8249. // Check header count limit
  8250. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8251. is_valid_ = false;
  8252. return false;
  8253. }
  8254. header_count_++;
  8255. const auto header = buf_head(pos);
  8256. if (!parse_header(header.data(), header.data() + header.size(),
  8257. [&](const std::string &, const std::string &) {})) {
  8258. is_valid_ = false;
  8259. return false;
  8260. }
  8261. // Parse and emplace space trimmed headers into a map
  8262. if (!parse_header(
  8263. header.data(), header.data() + header.size(),
  8264. [&](const std::string &key, const std::string &val) {
  8265. file_.headers.emplace(key, val);
  8266. })) {
  8267. is_valid_ = false;
  8268. return false;
  8269. }
  8270. constexpr const char header_content_type[] = "Content-Type:";
  8271. if (start_with_case_ignore(header, header_content_type)) {
  8272. file_.content_type =
  8273. trim_copy(header.substr(str_len(header_content_type)));
  8274. } else {
  8275. std::string disposition_params;
  8276. if (parse_content_disposition(header, disposition_params)) {
  8277. Params params;
  8278. parse_disposition_params(disposition_params, params);
  8279. auto it = params.find("name");
  8280. if (it != params.end()) {
  8281. file_.name = it->second;
  8282. } else {
  8283. is_valid_ = false;
  8284. return false;
  8285. }
  8286. it = params.find("filename");
  8287. if (it != params.end()) { file_.filename = it->second; }
  8288. it = params.find("filename*");
  8289. if (it != params.end()) {
  8290. // RFC 5987: only UTF-8 encoding is allowed
  8291. const auto &val = it->second;
  8292. constexpr const char utf8_prefix[] = "UTF-8''";
  8293. constexpr size_t prefix_len = str_len(utf8_prefix);
  8294. if (val.size() > prefix_len &&
  8295. start_with_case_ignore(val, utf8_prefix)) {
  8296. file_.filename = decode_path_component(
  8297. val.substr(prefix_len)); // override...
  8298. } else {
  8299. is_valid_ = false;
  8300. return false;
  8301. }
  8302. }
  8303. }
  8304. }
  8305. buf_erase(pos + crlf_.size());
  8306. pos = buf_find(crlf_);
  8307. }
  8308. if (state_ != 3) {
  8309. // The CR of the CRLF may be the last byte so far.
  8310. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8311. return true;
  8312. }
  8313. break;
  8314. }
  8315. case 3: { // Body
  8316. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8317. auto pos = buf_find(crlf_dash_boundary_);
  8318. if (pos < buf_size()) {
  8319. if (!content_callback(buf_data(), pos)) {
  8320. is_valid_ = false;
  8321. return false;
  8322. }
  8323. buf_erase(pos + crlf_dash_boundary_.size());
  8324. state_ = 4;
  8325. } else {
  8326. auto len = buf_size() - crlf_dash_boundary_.size();
  8327. if (len > 0) {
  8328. if (!content_callback(buf_data(), len)) {
  8329. is_valid_ = false;
  8330. return false;
  8331. }
  8332. buf_erase(len);
  8333. }
  8334. return true;
  8335. }
  8336. break;
  8337. }
  8338. case 4: { // Boundary
  8339. if (crlf_.size() > buf_size()) { return true; }
  8340. if (buf_start_with(crlf_)) {
  8341. buf_erase(crlf_.size());
  8342. state_ = 1;
  8343. } else if (buf_start_with(dash_)) {
  8344. buf_erase(dash_.size());
  8345. is_valid_ = true;
  8346. state_ = 5;
  8347. } else {
  8348. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8349. // accepted after a boundary; RFC 2046 allows transport-padding in
  8350. // between, but this parser has never supported it. Either way the
  8351. // body is already destined to be rejected, so fail now instead of
  8352. // buffering the rest of it. Both are two bytes, so the check above
  8353. // already guarantees enough buffered data to decide.
  8354. is_valid_ = false;
  8355. return false;
  8356. }
  8357. break;
  8358. }
  8359. case 5: { // Epilogue
  8360. buf_erase(buf_size());
  8361. break;
  8362. }
  8363. }
  8364. }
  8365. return true;
  8366. }
  8367. private:
  8368. void clear_file_info() {
  8369. file_.name.clear();
  8370. file_.filename.clear();
  8371. file_.content_type.clear();
  8372. file_.headers.clear();
  8373. header_count_ = 0;
  8374. }
  8375. bool start_with_case_ignore(const std::string &a, const char *b,
  8376. size_t offset = 0) const {
  8377. const auto b_len = strlen(b);
  8378. if (a.size() < offset + b_len) { return false; }
  8379. for (size_t i = 0; i < b_len; i++) {
  8380. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8381. return false;
  8382. }
  8383. }
  8384. return true;
  8385. }
  8386. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8387. // Returns true if header matches, with the params portion in `params_out`.
  8388. bool parse_content_disposition(const std::string &header,
  8389. std::string &params_out) const {
  8390. constexpr const char prefix[] = "Content-Disposition:";
  8391. constexpr size_t prefix_len = str_len(prefix);
  8392. if (!start_with_case_ignore(header, prefix)) { return false; }
  8393. // Skip whitespace after "Content-Disposition:"
  8394. auto pos = prefix_len;
  8395. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8396. pos++;
  8397. }
  8398. // Match "form-data;" (case-insensitive)
  8399. constexpr const char form_data[] = "form-data;";
  8400. constexpr size_t form_data_len = str_len(form_data);
  8401. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8402. pos += form_data_len;
  8403. // Skip whitespace after "form-data;"
  8404. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8405. pos++;
  8406. }
  8407. params_out = header.substr(pos);
  8408. return true;
  8409. }
  8410. const std::string dash_ = "--";
  8411. const std::string crlf_ = "\r\n";
  8412. std::string boundary_;
  8413. std::string dash_boundary_crlf_;
  8414. std::string crlf_dash_boundary_;
  8415. size_t state_ = 0;
  8416. bool is_valid_ = false;
  8417. FormData file_;
  8418. size_t header_count_ = 0;
  8419. size_t header_searched_ = 0;
  8420. // Buffer
  8421. bool start_with(const std::string &a, size_t spos, size_t epos,
  8422. const std::string &b) const {
  8423. if (epos - spos < b.size()) { return false; }
  8424. for (size_t i = 0; i < b.size(); i++) {
  8425. if (a[i + spos] != b[i]) { return false; }
  8426. }
  8427. return true;
  8428. }
  8429. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8430. const char *buf_data() const { return &buf_[buf_spos_]; }
  8431. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8432. bool buf_start_with(const std::string &s) const {
  8433. return start_with(buf_, buf_spos_, buf_epos_, s);
  8434. }
  8435. size_t buf_find(const std::string &s, size_t from = 0) const {
  8436. auto c = s.front();
  8437. size_t off = buf_spos_ + from;
  8438. while (off < buf_epos_) {
  8439. auto pos = off;
  8440. while (true) {
  8441. if (pos == buf_epos_) { return buf_size(); }
  8442. if (buf_[pos] == c) { break; }
  8443. pos++;
  8444. }
  8445. auto remaining_size = buf_epos_ - pos;
  8446. if (s.size() > remaining_size) { return buf_size(); }
  8447. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8448. off = pos + 1;
  8449. }
  8450. return buf_size();
  8451. }
  8452. void buf_append(const char *data, size_t n) {
  8453. auto remaining_size = buf_size();
  8454. if (remaining_size > 0 && buf_spos_ > 0) {
  8455. for (size_t i = 0; i < remaining_size; i++) {
  8456. buf_[i] = buf_[buf_spos_ + i];
  8457. }
  8458. }
  8459. buf_spos_ = 0;
  8460. buf_epos_ = remaining_size;
  8461. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8462. for (size_t i = 0; i < n; i++) {
  8463. buf_[buf_epos_ + i] = data[i];
  8464. }
  8465. buf_epos_ += n;
  8466. }
  8467. void buf_erase(size_t size) { buf_spos_ += size; }
  8468. std::string buf_;
  8469. size_t buf_spos_ = 0;
  8470. size_t buf_epos_ = 0;
  8471. };
  8472. inline std::string random_string(size_t length) {
  8473. constexpr const char data[] =
  8474. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8475. std::string result(length, '\0');
  8476. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8477. for (auto &c : result) {
  8478. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8479. }
  8480. return result;
  8481. }
  8482. inline std::string make_multipart_data_boundary() {
  8483. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8484. }
  8485. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8486. auto valid = true;
  8487. for (size_t i = 0; i < boundary.size(); i++) {
  8488. auto c = boundary[i];
  8489. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8490. valid = false;
  8491. break;
  8492. }
  8493. }
  8494. return valid;
  8495. }
  8496. // Escape a multipart field name/filename following the WHATWG HTML standard
  8497. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8498. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8499. // With quoted = false, only CR and LF are escaped; this is for header values
  8500. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8501. inline std::string escape_multipart_field(const std::string &s,
  8502. bool quoted = true) {
  8503. std::string result;
  8504. result.reserve(s.size());
  8505. for (auto c : s) {
  8506. switch (c) {
  8507. case '"':
  8508. if (quoted) {
  8509. result += "%22";
  8510. } else {
  8511. result += c;
  8512. }
  8513. break;
  8514. case '\\':
  8515. // A lone backslash would escape the character after it (RFC 9110
  8516. // 5.6.4).
  8517. if (quoted) { result += '\\'; }
  8518. result += c;
  8519. break;
  8520. case '\r': result += "%0D"; break;
  8521. case '\n': result += "%0A"; break;
  8522. default: result += c; break;
  8523. }
  8524. }
  8525. return result;
  8526. }
  8527. template <typename T>
  8528. inline std::string
  8529. serialize_multipart_formdata_item_begin(const T &item,
  8530. const std::string &boundary) {
  8531. std::string body = "--" + boundary + "\r\n";
  8532. body += "Content-Disposition: form-data; name=\"" +
  8533. escape_multipart_field(item.name) + "\"";
  8534. if (!item.filename.empty()) {
  8535. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8536. }
  8537. body += "\r\n";
  8538. if (!item.content_type.empty()) {
  8539. body +=
  8540. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8541. "\r\n";
  8542. }
  8543. body += "\r\n";
  8544. return body;
  8545. }
  8546. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8547. inline std::string
  8548. serialize_multipart_formdata_finish(const std::string &boundary) {
  8549. return "--" + boundary + "--\r\n";
  8550. }
  8551. inline std::string
  8552. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8553. return "multipart/form-data; boundary=" + boundary;
  8554. }
  8555. inline std::string
  8556. serialize_multipart_formdata(const UploadFormDataItems &items,
  8557. const std::string &boundary, bool finish = true) {
  8558. std::string body;
  8559. for (const auto &item : items) {
  8560. body += serialize_multipart_formdata_item_begin(item, boundary);
  8561. body += item.content + serialize_multipart_formdata_item_end();
  8562. }
  8563. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8564. return body;
  8565. }
  8566. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8567. const std::string &boundary) {
  8568. size_t total = 0;
  8569. for (const auto &item : items) {
  8570. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8571. total += item.content.size();
  8572. total += serialize_multipart_formdata_item_end().size();
  8573. }
  8574. total += serialize_multipart_formdata_finish(boundary).size();
  8575. return total;
  8576. }
  8577. struct MultipartSegment {
  8578. const char *data;
  8579. size_t size;
  8580. };
  8581. // NOTE: items must outlive the returned ContentProvider
  8582. // (safe for synchronous use inside Post/Put/Patch)
  8583. inline ContentProvider
  8584. make_multipart_content_provider(const UploadFormDataItems &items,
  8585. const std::string &boundary) {
  8586. // Own the per-item header strings and the finish string
  8587. std::vector<std::string> owned;
  8588. owned.reserve(items.size() + 1);
  8589. for (const auto &item : items)
  8590. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8591. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8592. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8593. std::vector<MultipartSegment> segs;
  8594. segs.reserve(items.size() * 3 + 1);
  8595. static const char crlf[] = "\r\n";
  8596. for (size_t i = 0; i < items.size(); i++) {
  8597. segs.push_back({owned[i].data(), owned[i].size()});
  8598. segs.push_back({items[i].content.data(), items[i].content.size()});
  8599. segs.push_back({crlf, 2});
  8600. }
  8601. segs.push_back({owned.back().data(), owned.back().size()});
  8602. struct MultipartState {
  8603. std::vector<std::string> owned;
  8604. std::vector<MultipartSegment> segs;
  8605. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8606. };
  8607. auto state = std::make_shared<MultipartState>();
  8608. state->owned = std::move(owned);
  8609. // `segs` holds raw pointers into owned strings; std::string move preserves
  8610. // the data pointer, so these pointers remain valid after the move above.
  8611. state->segs = std::move(segs);
  8612. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8613. // Buffer multiple small segments into fewer, larger writes to avoid
  8614. // excessive TCP packets when there are many form data items (#2410)
  8615. auto &buf = state->buf;
  8616. auto buf_size = buf.size();
  8617. size_t buf_len = 0;
  8618. size_t remaining = length;
  8619. // Find the first segment containing 'offset'
  8620. size_t pos = 0;
  8621. size_t seg_idx = 0;
  8622. for (; seg_idx < state->segs.size(); seg_idx++) {
  8623. const auto &seg = state->segs[seg_idx];
  8624. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8625. pos += seg.size;
  8626. }
  8627. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8628. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8629. const auto &seg = state->segs[seg_idx];
  8630. size_t available = seg.size - seg_offset;
  8631. size_t to_copy = (std::min)(available, remaining);
  8632. const char *src = seg.data + seg_offset;
  8633. seg_offset = 0; // only the first segment has a non-zero offset
  8634. while (to_copy > 0) {
  8635. size_t space = buf_size - buf_len;
  8636. size_t chunk = (std::min)(to_copy, space);
  8637. std::memcpy(buf.data() + buf_len, src, chunk);
  8638. buf_len += chunk;
  8639. src += chunk;
  8640. to_copy -= chunk;
  8641. remaining -= chunk;
  8642. if (buf_len == buf_size) {
  8643. if (!sink.write(buf.data(), buf_len)) { return false; }
  8644. buf_len = 0;
  8645. }
  8646. }
  8647. }
  8648. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8649. return true;
  8650. };
  8651. }
  8652. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8653. if (ranges.size() <= 1) return;
  8654. // Sort ranges by start position
  8655. std::sort(ranges.begin(), ranges.end(),
  8656. [](const Range &a, const Range &b) { return a.first < b.first; });
  8657. Ranges coalesced;
  8658. coalesced.reserve(ranges.size());
  8659. for (auto &r : ranges) {
  8660. auto first_pos = r.first;
  8661. auto last_pos = r.second;
  8662. // Handle special cases like in range_error
  8663. if (first_pos == -1 && last_pos == -1) {
  8664. first_pos = 0;
  8665. last_pos = static_cast<ssize_t>(content_length);
  8666. }
  8667. if (first_pos == -1) {
  8668. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8669. last_pos = static_cast<ssize_t>(content_length) - 1;
  8670. }
  8671. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8672. last_pos = static_cast<ssize_t>(content_length) - 1;
  8673. }
  8674. // Skip invalid ranges
  8675. if (!(0 <= first_pos && first_pos <= last_pos &&
  8676. last_pos < static_cast<ssize_t>(content_length))) {
  8677. continue;
  8678. }
  8679. // Coalesce with previous range if overlapping or adjacent (but not
  8680. // identical)
  8681. if (!coalesced.empty()) {
  8682. auto &prev = coalesced.back();
  8683. // Check if current range overlaps or is adjacent to previous range
  8684. // but don't coalesce identical ranges (allow duplicates)
  8685. if (first_pos <= prev.second + 1 &&
  8686. !(first_pos == prev.first && last_pos == prev.second)) {
  8687. // Extend the previous range
  8688. prev.second = (std::max)(prev.second, last_pos);
  8689. continue;
  8690. }
  8691. }
  8692. // Add new range
  8693. coalesced.emplace_back(first_pos, last_pos);
  8694. }
  8695. ranges = std::move(coalesced);
  8696. }
  8697. inline bool range_error(Request &req, Response &res) {
  8698. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8699. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8700. req.ranges.clear();
  8701. if (res.status == StatusCode::PartialContent_206) {
  8702. res.status = StatusCode::OK_200;
  8703. }
  8704. return false;
  8705. }
  8706. ssize_t content_len = static_cast<ssize_t>(
  8707. res.content_length_ ? res.content_length_ : res.body.size());
  8708. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8709. size_t overwrapping_count = 0;
  8710. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8711. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8712. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8713. // Too many ranges
  8714. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8715. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8716. return true;
  8717. }
  8718. for (auto &r : req.ranges) {
  8719. auto &first_pos = r.first;
  8720. auto &last_pos = r.second;
  8721. if (first_pos == -1 && last_pos == -1) {
  8722. first_pos = 0;
  8723. last_pos = content_len;
  8724. }
  8725. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8726. // selects the entire representation.
  8727. if (first_pos == -1) {
  8728. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8729. last_pos = content_len - 1;
  8730. }
  8731. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8732. // A client can limit the number of bytes requested without knowing the
  8733. // size of the selected representation. If the last-pos value is absent,
  8734. // or if the value is greater than or equal to the current length of the
  8735. // representation data, the byte range is interpreted as the remainder of
  8736. // the representation (i.e., the server replaces the value of last-pos
  8737. // with a value that is one less than the current length of the selected
  8738. // representation).
  8739. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8740. if (last_pos == -1 || last_pos >= content_len) {
  8741. last_pos = content_len - 1;
  8742. }
  8743. // Range must be within content length
  8744. if (!(0 <= first_pos && first_pos <= last_pos &&
  8745. last_pos <= content_len - 1)) {
  8746. return true;
  8747. }
  8748. // Request must not have more than two overlapping ranges
  8749. for (const auto &processed_range : processed_ranges) {
  8750. if (!(last_pos < processed_range.first ||
  8751. first_pos > processed_range.second)) {
  8752. overwrapping_count++;
  8753. if (overwrapping_count > 2) { return true; }
  8754. break; // Only count once per range
  8755. }
  8756. }
  8757. processed_ranges.emplace_back(first_pos, last_pos);
  8758. }
  8759. // After validation, coalesce overlapping ranges as per RFC 9110
  8760. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8761. }
  8762. return false;
  8763. }
  8764. inline std::pair<size_t, size_t>
  8765. get_range_offset_and_length(Range r, size_t content_length) {
  8766. assert(r.first != -1 && r.second != -1);
  8767. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8768. assert(r.first <= r.second &&
  8769. r.second < static_cast<ssize_t>(content_length));
  8770. (void)(content_length);
  8771. return std::make_pair(static_cast<size_t>(r.first),
  8772. static_cast<size_t>(r.second - r.first) + 1);
  8773. }
  8774. inline std::string make_content_range_header_field(
  8775. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8776. auto st = offset_and_length.first;
  8777. auto ed = st + offset_and_length.second - 1;
  8778. std::string field = "bytes ";
  8779. field += std::to_string(st);
  8780. field += '-';
  8781. field += std::to_string(ed);
  8782. field += '/';
  8783. field += std::to_string(content_length);
  8784. return field;
  8785. }
  8786. template <typename SToken, typename CToken, typename Content>
  8787. bool process_multipart_ranges_data(const Request &req,
  8788. const std::string &boundary,
  8789. const std::string &content_type,
  8790. size_t content_length, SToken stoken,
  8791. CToken ctoken, Content content) {
  8792. for (size_t i = 0; i < req.ranges.size(); i++) {
  8793. ctoken("--");
  8794. stoken(boundary);
  8795. ctoken("\r\n");
  8796. if (!content_type.empty()) {
  8797. ctoken("Content-Type: ");
  8798. stoken(content_type);
  8799. ctoken("\r\n");
  8800. }
  8801. auto offset_and_length =
  8802. get_range_offset_and_length(req.ranges[i], content_length);
  8803. ctoken("Content-Range: ");
  8804. stoken(make_content_range_header_field(offset_and_length, content_length));
  8805. ctoken("\r\n");
  8806. ctoken("\r\n");
  8807. if (!content(offset_and_length.first, offset_and_length.second)) {
  8808. return false;
  8809. }
  8810. ctoken("\r\n");
  8811. }
  8812. ctoken("--");
  8813. stoken(boundary);
  8814. ctoken("--");
  8815. return true;
  8816. }
  8817. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8818. const std::string &boundary,
  8819. const std::string &content_type,
  8820. size_t content_length,
  8821. std::string &data) {
  8822. process_multipart_ranges_data(
  8823. req, boundary, content_type, content_length,
  8824. [&](const std::string &token) { data += token; },
  8825. [&](const std::string &token) { data += token; },
  8826. [&](size_t offset, size_t length) {
  8827. assert(offset + length <= content_length);
  8828. data += res.body.substr(offset, length);
  8829. return true;
  8830. });
  8831. }
  8832. inline size_t get_multipart_ranges_data_length(const Request &req,
  8833. const std::string &boundary,
  8834. const std::string &content_type,
  8835. size_t content_length) {
  8836. size_t data_length = 0;
  8837. process_multipart_ranges_data(
  8838. req, boundary, content_type, content_length,
  8839. [&](const std::string &token) { data_length += token.size(); },
  8840. [&](const std::string &token) { data_length += token.size(); },
  8841. [&](size_t /*offset*/, size_t length) {
  8842. data_length += length;
  8843. return true;
  8844. });
  8845. return data_length;
  8846. }
  8847. template <typename T>
  8848. inline bool
  8849. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8850. const std::string &boundary,
  8851. const std::string &content_type,
  8852. size_t content_length, const T &is_shutting_down) {
  8853. return process_multipart_ranges_data(
  8854. req, boundary, content_type, content_length,
  8855. [&](const std::string &token) { strm.write(token); },
  8856. [&](const std::string &token) { strm.write(token); },
  8857. [&](size_t offset, size_t length) {
  8858. return write_content(strm, res.content_provider_, offset, length,
  8859. is_shutting_down);
  8860. });
  8861. }
  8862. inline bool has_framed_body(const Request &req) {
  8863. return is_chunked_transfer_encoding(req.headers) ||
  8864. req.get_header_value_u64("Content-Length") > 0;
  8865. }
  8866. inline bool expect_content(const Request &req) {
  8867. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8868. req.method == "DELETE") {
  8869. return true;
  8870. }
  8871. return has_framed_body(req);
  8872. }
  8873. #ifdef _WIN32
  8874. class WSInit {
  8875. public:
  8876. WSInit() {
  8877. WSADATA wsaData;
  8878. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8879. }
  8880. ~WSInit() {
  8881. if (is_valid_) WSACleanup();
  8882. }
  8883. bool is_valid_ = false;
  8884. };
  8885. static WSInit wsinit_;
  8886. #endif
  8887. inline std::string unescape_quoted_pairs(const std::string &s) {
  8888. std::string out;
  8889. out.reserve(s.size());
  8890. for (size_t i = 0; i < s.size(); i++) {
  8891. if (s[i] == '\\' && i + 1 < s.size()) {
  8892. out += s[++i];
  8893. } else {
  8894. out += s[i];
  8895. }
  8896. }
  8897. return out;
  8898. }
  8899. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8900. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8901. // quoted-pair, so the recipient recovers the original value.
  8902. inline std::string escape_quoted_pairs(const std::string &s) {
  8903. std::string out;
  8904. out.reserve(s.size());
  8905. for (auto c : s) {
  8906. if (c == '\\' || c == '"') { out += '\\'; }
  8907. out += c;
  8908. }
  8909. return out;
  8910. }
  8911. // RFC 9110 Section 11.6.1 defines a challenge list as
  8912. // WWW-Authenticate = #challenge
  8913. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8914. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8915. // so a server may offer several schemes, each with its own comma-separated
  8916. // auth-param list, in either order and either as separate field lines or
  8917. // packed into one. Splitting on every comma would break apart a challenge's
  8918. // own param list; splitting only on the first space would miss a Digest
  8919. // challenge that isn't first. Split on commas that aren't inside a
  8920. // quoted-string instead (split_unquoted), then track which scheme each
  8921. // resulting segment belongs to: a segment whose text before "=" contains
  8922. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8923. // leading token.
  8924. inline bool parse_www_authenticate(const Response &res,
  8925. std::map<std::string, std::string> &auth,
  8926. bool is_proxy) {
  8927. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8928. auto combined = get_combined_header_value(res.headers, auth_key);
  8929. if (combined.empty()) { return false; }
  8930. auto found_digest = false;
  8931. auto in_digest_challenge = false;
  8932. split_unquoted(
  8933. combined.data(), combined.data() + combined.size(), ',',
  8934. [&](const char *b, const char *e) {
  8935. std::string segment(b, e);
  8936. auto eq_pos = segment.find('=');
  8937. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8938. // for the first segment of a challenge, "<scheme> <key>") must be
  8939. // trimmed before its boundaries are inspected.
  8940. auto key_part = trim_copy(
  8941. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8942. auto space_pos = key_part.find_last_of(" \t");
  8943. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8944. // "<scheme>[ <key>]" starts a new challenge.
  8945. auto scheme_end =
  8946. space_pos == std::string::npos ? key_part.size() : space_pos;
  8947. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8948. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8949. // from one challenge is never paired with another's algorithm.
  8950. in_digest_challenge =
  8951. !found_digest &&
  8952. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8953. if (in_digest_challenge) { found_digest = true; }
  8954. if (space_pos == std::string::npos) {
  8955. // Bare scheme (or a token68), no auth-param on this segment.
  8956. return;
  8957. }
  8958. key_part = key_part.substr(space_pos + 1);
  8959. }
  8960. if (!in_digest_challenge) { return; }
  8961. auto val = trim_copy(segment.substr(eq_pos + 1));
  8962. auto unquoted = trim_double_quotes_copy(val);
  8963. if (unquoted.size() != val.size()) {
  8964. unquoted = unescape_quoted_pairs(unquoted);
  8965. }
  8966. auth[std::move(key_part)] = std::move(unquoted);
  8967. });
  8968. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8969. // make_digest_authentication_header() dereferences both unconditionally, so
  8970. // a challenge missing either can't produce a usable Authorization header.
  8971. // Treat it the same as no Digest challenge at all.
  8972. return found_digest && auth.find("realm") != auth.end() &&
  8973. auth.find("nonce") != auth.end();
  8974. }
  8975. class ContentProviderAdapter {
  8976. public:
  8977. explicit ContentProviderAdapter(
  8978. ContentProviderWithoutLength &&content_provider)
  8979. : content_provider_(std::move(content_provider)) {}
  8980. bool operator()(size_t offset, size_t, DataSink &sink) {
  8981. return content_provider_(offset, sink);
  8982. }
  8983. private:
  8984. ContentProviderWithoutLength content_provider_;
  8985. };
  8986. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8987. namespace fields {
  8988. inline bool is_token_char(char c) {
  8989. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8990. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8991. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8992. }
  8993. inline bool is_token(const std::string &s) {
  8994. if (s.empty()) { return false; }
  8995. for (auto c : s) {
  8996. if (!is_token_char(c)) { return false; }
  8997. }
  8998. return true;
  8999. }
  9000. inline bool is_field_name(const std::string &s) { return is_token(s); }
  9001. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  9002. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  9003. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  9004. inline bool is_field_content(const std::string &s) {
  9005. if (s.empty()) { return true; }
  9006. if (s.size() == 1) {
  9007. return is_field_vchar(s[0]);
  9008. } else if (s.size() == 2) {
  9009. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  9010. } else {
  9011. size_t i = 0;
  9012. if (!is_field_vchar(s[i])) { return false; }
  9013. i++;
  9014. while (i < s.size() - 1) {
  9015. auto c = s[i++];
  9016. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  9017. } else {
  9018. return false;
  9019. }
  9020. }
  9021. return is_field_vchar(s[i]);
  9022. }
  9023. }
  9024. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  9025. inline bool is_field_valid(const std::string &name, const std::string &value) {
  9026. return is_field_name(name) && is_field_value(value);
  9027. }
  9028. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  9029. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  9030. inline bool is_request_target(const std::string &s) {
  9031. return std::all_of(s.begin(), s.end(), is_field_vchar);
  9032. }
  9033. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  9034. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  9035. inline bool is_host(const std::string &s) {
  9036. return std::all_of(s.begin(), s.end(), [](char c) {
  9037. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  9038. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9039. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9040. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  9041. });
  9042. }
  9043. } // namespace fields
  9044. // Built in memory first, like ClientImpl::write_request, so a rejected header
  9045. // never leaves a partial request on the wire.
  9046. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  9047. BufferStream bstrm;
  9048. if (write_request_line(bstrm, req.method, req.path) < 0) {
  9049. error = Error::Write;
  9050. return false;
  9051. }
  9052. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  9053. return false;
  9054. }
  9055. const auto &data = bstrm.get_buffer();
  9056. if (!write_data(strm, data.data(), data.size())) {
  9057. error = Error::Write;
  9058. return false;
  9059. }
  9060. return true;
  9061. }
  9062. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  9063. WebSocketUpgradeResponse &upgrade) {
  9064. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  9065. std::string key_bytes(16, '\0');
  9066. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  9067. key_bytes.size());
  9068. auto client_key = base64_encode(key_bytes);
  9069. req.headers.erase("Upgrade");
  9070. req.headers.erase("Connection");
  9071. req.headers.erase("Sec-WebSocket-Key");
  9072. req.headers.erase("Sec-WebSocket-Version");
  9073. req.headers.emplace("Upgrade", "websocket");
  9074. req.headers.emplace("Connection", "Upgrade");
  9075. req.headers.emplace("Sec-WebSocket-Key", client_key);
  9076. req.headers.emplace("Sec-WebSocket-Version", "13");
  9077. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  9078. // Verify 101 response and Sec-WebSocket-Accept header
  9079. auto expected_accept = websocket_accept_key(client_key);
  9080. auto offered_subprotocols =
  9081. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  9082. return read_websocket_upgrade_response(strm, expected_accept,
  9083. offered_subprotocols, upgrade);
  9084. }
  9085. inline bool is_ip_address(const std::string &host) {
  9086. struct in_addr addr4;
  9087. struct in6_addr addr6;
  9088. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  9089. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  9090. }
  9091. // One spelling for an IPv6 address, and the IPv4 one for an IPv4-mapped IPv6
  9092. // address, which is how a dual-stack socket reports an IPv4 peer. Anything
  9093. // else, including an address with a zone ID, is returned as it is.
  9094. inline std::string canonical_ip(const std::string &addr) {
  9095. struct in6_addr addr6;
  9096. if (addr.find('%') != std::string::npos ||
  9097. inet_pton(AF_INET6, addr.c_str(), &addr6) != 1) {
  9098. return addr;
  9099. }
  9100. char buf[INET6_ADDRSTRLEN];
  9101. if (IN6_IS_ADDR_V4MAPPED(&addr6)) {
  9102. return inet_ntop(AF_INET, &addr6.s6_addr[12], buf, sizeof(buf)) ? buf
  9103. : addr;
  9104. }
  9105. return inet_ntop(AF_INET6, &addr6, buf, sizeof(buf)) ? buf : addr;
  9106. }
  9107. // `trusted_proxies` holds canonical_ip() spellings.
  9108. inline bool is_trusted_proxy(const std::string &addr,
  9109. const std::vector<std::string> &trusted_proxies) {
  9110. if (trusted_proxies.empty()) { return false; }
  9111. return std::find(trusted_proxies.begin(), trusted_proxies.end(),
  9112. canonical_ip(addr)) != trusted_proxies.end();
  9113. }
  9114. // Resolve where a client should connect for `host`, honoring a user-supplied
  9115. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  9116. // supplying the Host header and SNI; only the connection target changes.
  9117. //
  9118. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  9119. // path. Anything else goes to `connect_host`, which create_socket resolves as
  9120. // a name, or uses as the socket path when the address family is AF_UNIX. An
  9121. // absent or empty mapping leaves `host` as the connection target; without the
  9122. // empty check the value would reach getaddrinfo as a null node and silently
  9123. // resolve to loopback.
  9124. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  9125. const std::string &host, std::string &connect_host,
  9126. std::string &ip) {
  9127. connect_host = host;
  9128. ip.clear();
  9129. auto it = addr_map.find(host);
  9130. if (it == addr_map.end() || it->second.empty()) { return; }
  9131. if (is_ip_address(it->second)) {
  9132. ip = it->second;
  9133. } else {
  9134. connect_host = it->second;
  9135. }
  9136. }
  9137. } // namespace detail
  9138. /*
  9139. * Group 2: detail namespace - SSL common utilities
  9140. */
  9141. #ifdef CPPHTTPLIB_SSL_ENABLED
  9142. namespace detail {
  9143. class SSLSocketStream final : public Stream {
  9144. public:
  9145. SSLSocketStream(
  9146. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9147. time_t read_timeout_usec, time_t write_timeout_sec,
  9148. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9149. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9150. (std::chrono::steady_clock::time_point::min)());
  9151. ~SSLSocketStream() override;
  9152. bool is_readable() const override;
  9153. bool wait_readable() const override;
  9154. bool wait_writable() const override;
  9155. bool is_peer_alive() const override;
  9156. ssize_t read(char *ptr, size_t size) override;
  9157. ssize_t write(const char *ptr, size_t size) override;
  9158. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9159. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9160. socket_t socket() const override;
  9161. time_t duration() const override;
  9162. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9163. void set_max_timeout(time_t msec) override;
  9164. void set_read_interrupt(std::function<bool()> interrupted) override;
  9165. // See SocketStream::set_readable_hint().
  9166. void set_readable_hint() { readable_hint_ = true; }
  9167. // The error from the last read() or write() that failed in the TLS layer,
  9168. // with code Success if none did
  9169. const tls::TlsError &tls_error() const { return tls_error_; }
  9170. private:
  9171. bool ensure_readable();
  9172. socket_t sock_;
  9173. tls::session_t session_;
  9174. time_t read_timeout_sec_;
  9175. time_t read_timeout_usec_;
  9176. time_t write_timeout_sec_;
  9177. time_t write_timeout_usec_;
  9178. time_t max_timeout_msec_;
  9179. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9180. std::function<bool()> read_interrupted_;
  9181. bool readable_hint_ = false;
  9182. tls::TlsError tls_error_;
  9183. };
  9184. // A TLS stream for WebSocket connections, where the receive path and the
  9185. // send path (application send() plus the heartbeat ping thread) run on
  9186. // different threads. A single TLS session must never be entered
  9187. // concurrently, so every call into the session is serialized by one mutex.
  9188. //
  9189. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9190. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9191. // call under the lock, then waits for readiness with select() outside the
  9192. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9193. // blocked waiting for data never stalls a concurrent sender.
  9194. //
  9195. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9196. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9197. class WebSocketSSLStream final : public Stream {
  9198. public:
  9199. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9200. time_t read_timeout_sec, time_t read_timeout_usec,
  9201. time_t write_timeout_sec, time_t write_timeout_usec);
  9202. ~WebSocketSSLStream() override;
  9203. bool is_readable() const override;
  9204. bool wait_readable() const override;
  9205. bool wait_writable() const override;
  9206. ssize_t read(char *ptr, size_t size) override;
  9207. ssize_t write(const char *ptr, size_t size) override;
  9208. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9209. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9210. socket_t socket() const override;
  9211. time_t duration() const override;
  9212. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9213. void set_read_interrupt(std::function<bool()> interrupted) override;
  9214. private:
  9215. mutable std::mutex session_mutex_;
  9216. socket_t sock_;
  9217. tls::session_t session_;
  9218. // WebSocket::close() shortens the read timeout from the closing thread
  9219. // while the receive thread is inside wait_readable(), so these two are read
  9220. // and written concurrently. The write timeouts are never mutated.
  9221. std::atomic<time_t> read_timeout_sec_;
  9222. std::atomic<time_t> read_timeout_usec_;
  9223. time_t write_timeout_sec_;
  9224. time_t write_timeout_usec_;
  9225. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9226. std::function<bool()> read_interrupted_;
  9227. };
  9228. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9229. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9230. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9231. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9232. unsigned int hash_length = 0;
  9233. unsigned char hash[EVP_MAX_MD_SIZE];
  9234. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9235. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9236. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9237. std::stringstream ss;
  9238. for (auto i = 0u; i < hash_length; ++i) {
  9239. ss << std::hex << std::setw(2) << std::setfill('0')
  9240. << static_cast<unsigned int>(hash[i]);
  9241. }
  9242. return ss.str();
  9243. }
  9244. inline std::string MD5(const std::string &s) {
  9245. return message_digest(s, EVP_md5());
  9246. }
  9247. inline std::string SHA_256(const std::string &s) {
  9248. return message_digest(s, EVP_sha256());
  9249. }
  9250. inline std::string SHA_512(const std::string &s) {
  9251. return message_digest(s, EVP_sha512());
  9252. }
  9253. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9254. namespace {
  9255. template <size_t N>
  9256. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9257. std::stringstream ss;
  9258. for (size_t i = 0; i < N; ++i) {
  9259. ss << std::hex << std::setw(2) << std::setfill('0')
  9260. << static_cast<unsigned int>(hash[i]);
  9261. }
  9262. return ss.str();
  9263. }
  9264. } // namespace
  9265. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9266. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9267. // initialized once. PSA state is process-global; do not free it.
  9268. inline bool ensure_mbedtls_psa_crypto() {
  9269. static std::once_flag once;
  9270. static bool ok = false;
  9271. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9272. return ok;
  9273. }
  9274. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9275. unsigned char *out, size_t out_size) {
  9276. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9277. size_t olen = 0;
  9278. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9279. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9280. olen == out_size;
  9281. }
  9282. #endif
  9283. inline std::string MD5(const std::string &s) {
  9284. unsigned char hash[16];
  9285. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9286. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9287. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9288. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9289. hash);
  9290. #else
  9291. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9292. hash);
  9293. #endif
  9294. return hash_to_hex(hash);
  9295. }
  9296. inline std::string SHA_256(const std::string &s) {
  9297. unsigned char hash[32];
  9298. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9299. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9300. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9301. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9302. hash, 0);
  9303. #else
  9304. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9305. s.size(), hash, 0);
  9306. #endif
  9307. return hash_to_hex(hash);
  9308. }
  9309. inline std::string SHA_512(const std::string &s) {
  9310. unsigned char hash[64];
  9311. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9312. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9313. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9314. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9315. hash, 0);
  9316. #else
  9317. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9318. s.size(), hash, 0);
  9319. #endif
  9320. return hash_to_hex(hash);
  9321. }
  9322. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9323. namespace {
  9324. template <size_t N>
  9325. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9326. std::stringstream ss;
  9327. for (size_t i = 0; i < N; ++i) {
  9328. ss << std::hex << std::setw(2) << std::setfill('0')
  9329. << static_cast<unsigned int>(hash[i]);
  9330. }
  9331. return ss.str();
  9332. }
  9333. } // namespace
  9334. inline std::string MD5(const std::string &s) {
  9335. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9336. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9337. static_cast<word32>(s.size()), hash);
  9338. return hash_to_hex(hash);
  9339. }
  9340. inline std::string SHA_256(const std::string &s) {
  9341. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9342. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9343. static_cast<word32>(s.size()), hash);
  9344. return hash_to_hex(hash);
  9345. }
  9346. inline std::string SHA_512(const std::string &s) {
  9347. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9348. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9349. static_cast<word32>(s.size()), hash);
  9350. return hash_to_hex(hash);
  9351. }
  9352. #endif
  9353. template <typename T>
  9354. inline bool process_server_socket_ssl(
  9355. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9356. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9357. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9358. time_t write_timeout_usec, T callback) {
  9359. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9360. // of a pipelined request, which keep_alive() cannot see on the socket.
  9361. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9362. write_timeout_sec, write_timeout_usec);
  9363. return process_server_socket_core(
  9364. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9365. [&]() { return strm.is_readable(); },
  9366. [&](bool socket_readable, bool close_connection,
  9367. bool &connection_closed) {
  9368. if (socket_readable) { strm.set_readable_hint(); }
  9369. return callback(strm, close_connection, connection_closed);
  9370. });
  9371. }
  9372. template <typename T>
  9373. inline bool process_client_socket_ssl(
  9374. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9375. time_t read_timeout_usec, time_t write_timeout_sec,
  9376. time_t write_timeout_usec, time_t max_timeout_msec,
  9377. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9378. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9379. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9380. start_time);
  9381. return callback(strm);
  9382. }
  9383. // `uri` is req's request-target in origin form, as curl sends it, also when
  9384. // the request line carries the absolute form for a proxy.
  9385. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9386. const Request &req, const std::string &uri,
  9387. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9388. const std::string &cnonce, const std::string &username,
  9389. const std::string &password, bool is_proxy = false) {
  9390. std::string nc;
  9391. {
  9392. std::stringstream ss;
  9393. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9394. nc = ss.str();
  9395. }
  9396. std::string qop;
  9397. if (auth.find("qop") != auth.end()) {
  9398. qop = auth.at("qop");
  9399. if (qop.find("auth-int") != std::string::npos) {
  9400. qop = "auth-int";
  9401. } else if (qop.find("auth") != std::string::npos) {
  9402. qop = "auth";
  9403. } else {
  9404. qop.clear();
  9405. }
  9406. }
  9407. std::string algo = "MD5";
  9408. if (auth.find("algorithm") != auth.end()) {
  9409. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9410. // not a token would otherwise be emitted verbatim and could carry commas
  9411. // or quotes that inject further auth-params into the header below.
  9412. const auto &a = auth.at("algorithm");
  9413. if (fields::is_token(a)) { algo = a; }
  9414. }
  9415. std::string response;
  9416. {
  9417. auto H = algo == "SHA-256" ? detail::SHA_256
  9418. : algo == "SHA-512" ? detail::SHA_512
  9419. : detail::MD5;
  9420. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9421. auto A2 = req.method + ":" + uri;
  9422. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9423. if (qop.empty()) {
  9424. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9425. } else {
  9426. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9427. ":" + qop + ":" + H(A2));
  9428. }
  9429. }
  9430. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9431. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9432. // close the string early. realm, nonce and opaque come straight from the
  9433. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9434. // without this a crafted challenge injects extra auth-params into the header.
  9435. auto field =
  9436. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9437. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9438. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9439. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9440. "\", algorithm=" + algo +
  9441. (qop.empty() ? ", response=\""
  9442. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9443. "\", response=\"") +
  9444. response + "\"" +
  9445. (opaque.empty()
  9446. ? ""
  9447. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9448. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9449. return std::make_pair(key, field);
  9450. }
  9451. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9452. // backend accepts the same names.
  9453. inline bool match_hostname(const std::string &pattern,
  9454. const std::string &hostname) {
  9455. // A trailing dot on the host is ignored
  9456. auto host = hostname;
  9457. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9458. // Exact match (case-insensitive)
  9459. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9460. // Split both pattern and hostname into components by '.', keeping any empty
  9461. // one, which no name may have
  9462. auto labels = [](const std::string &s) {
  9463. std::vector<std::string> v;
  9464. size_t b = 0;
  9465. while (true) {
  9466. auto e = s.find('.', b);
  9467. v.push_back(s.substr(b, e - b));
  9468. if (e == std::string::npos) { return v; }
  9469. b = e + 1;
  9470. }
  9471. };
  9472. auto pattern_components = labels(pattern);
  9473. auto host_components = labels(host);
  9474. auto has_empty_label = [](const std::vector<std::string> &v) {
  9475. return std::any_of(v.begin(), v.end(),
  9476. [](const std::string &l) { return l.empty(); });
  9477. };
  9478. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9479. return false;
  9480. }
  9481. // Component count must match
  9482. if (host_components.size() != pattern_components.size()) { return false; }
  9483. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9484. // and an IDNA label may not have one
  9485. const auto &leftmost = pattern_components.front();
  9486. if (leftmost.find('*') != std::string::npos &&
  9487. (pattern_components.size() < 3 ||
  9488. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9489. return false;
  9490. }
  9491. // Compare each component with wildcard support
  9492. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9493. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9494. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9495. auto itr = pattern_components.begin();
  9496. for (const auto &h : host_components) {
  9497. auto &p = *itr;
  9498. auto is_leftmost = itr == pattern_components.begin();
  9499. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9500. bool partial_match = false;
  9501. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9502. const auto prefix_length = p.size() - 1;
  9503. if (prefix_length == 0) {
  9504. partial_match = true;
  9505. } else if (h.size() >= prefix_length) {
  9506. partial_match =
  9507. std::equal(p.begin(),
  9508. p.begin() + static_cast<std::string::difference_type>(
  9509. prefix_length),
  9510. h.begin(), [](const char ca, const char cb) {
  9511. return detail::case_ignore::to_lower(ca) ==
  9512. detail::case_ignore::to_lower(cb);
  9513. });
  9514. }
  9515. }
  9516. if (!partial_match) { return false; }
  9517. }
  9518. ++itr;
  9519. }
  9520. return true;
  9521. }
  9522. #ifdef _WIN32
  9523. // Verify certificate using Windows CertGetCertificateChain API.
  9524. // This provides real-time certificate validation with Windows Update
  9525. // integration, independent of the TLS backend.
  9526. inline bool verify_cert_with_windows_schannel(
  9527. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9528. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9529. if (der_cert.empty()) { return false; }
  9530. out_error = 0;
  9531. // Create Windows certificate context from DER data
  9532. auto cert_context = CertCreateCertificateContext(
  9533. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9534. static_cast<DWORD>(der_cert.size()));
  9535. if (!cert_context) {
  9536. out_error = GetLastError();
  9537. return false;
  9538. }
  9539. auto cert_guard =
  9540. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9541. // Give CryptoAPI the certificates the server sent. Without them it follows
  9542. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9543. std::vector<tls::cert_t> peer_certs;
  9544. tls::get_peer_certs(session, peer_certs);
  9545. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9546. auto store_guard = scope_exit([&] {
  9547. for (auto cert : peer_certs) {
  9548. tls::free_cert(cert);
  9549. }
  9550. if (store) { CertCloseStore(store, 0); }
  9551. });
  9552. for (auto cert : peer_certs) {
  9553. std::vector<unsigned char> der;
  9554. if (store && tls::get_cert_der(cert, der)) {
  9555. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9556. static_cast<DWORD>(der.size()),
  9557. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9558. }
  9559. }
  9560. // Setup chain parameters
  9561. CERT_CHAIN_PARA chain_para = {};
  9562. chain_para.cbSize = sizeof(chain_para);
  9563. // Require the server authentication usage along the chain, which also
  9564. // rejects roots that Windows trusts only for other purposes.
  9565. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9566. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9567. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9568. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9569. // Build certificate chain with revocation checking
  9570. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9571. auto chain_result = CertGetCertificateChain(
  9572. nullptr, cert_context, nullptr, store, &chain_para,
  9573. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9574. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9575. nullptr, &chain_context);
  9576. if (!chain_result || !chain_context) {
  9577. out_error = GetLastError();
  9578. return false;
  9579. }
  9580. auto chain_guard =
  9581. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9582. // Verify SSL policy
  9583. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9584. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9585. #ifdef AUTHTYPE_SERVER
  9586. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9587. #endif
  9588. std::wstring whost;
  9589. if (verify_hostname) {
  9590. whost = u8string_to_wstring(hostname.c_str());
  9591. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9592. }
  9593. CERT_CHAIN_POLICY_PARA policy_para = {};
  9594. policy_para.cbSize = sizeof(policy_para);
  9595. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9596. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9597. #else
  9598. policy_para.dwFlags = 0;
  9599. #endif
  9600. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9601. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9602. policy_status.cbSize = sizeof(policy_status);
  9603. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9604. &policy_para, &policy_status)) {
  9605. out_error = GetLastError();
  9606. return false;
  9607. }
  9608. if (policy_status.dwError != 0) {
  9609. out_error = policy_status.dwError;
  9610. return false;
  9611. }
  9612. return true;
  9613. }
  9614. #endif // _WIN32
  9615. // Loads CA file/dir configuration and applies the system CA policy to a
  9616. // client TLS context. PEM data and native stores are applied to the context
  9617. // directly at set time; has_custom_store reflects them for the Auto policy
  9618. // decision.
  9619. inline bool load_client_ca_config(tls::ctx_t ctx,
  9620. const std::string &ca_cert_file_path,
  9621. const std::string &ca_cert_dir_path,
  9622. bool has_custom_store, SystemCAMode mode,
  9623. uint64_t &backend_error) {
  9624. auto ret = true;
  9625. if (!ca_cert_file_path.empty()) {
  9626. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9627. backend_error = tls::get_error();
  9628. ret = false;
  9629. }
  9630. } else if (!ca_cert_dir_path.empty()) {
  9631. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9632. backend_error = tls::get_error();
  9633. ret = false;
  9634. }
  9635. }
  9636. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9637. !ca_cert_dir_path.empty() || has_custom_store;
  9638. if (mode == SystemCAMode::Enabled ||
  9639. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9640. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9641. }
  9642. return ret;
  9643. }
  9644. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9645. // loaded into another context.
  9646. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9647. std::string pem;
  9648. std::vector<tls::cert_t> certs;
  9649. tls::get_ca_certs(ctx, certs);
  9650. for (auto cert : certs) {
  9651. std::vector<unsigned char> der;
  9652. if (tls::get_cert_der(cert, der)) {
  9653. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9654. pem += "-----BEGIN CERTIFICATE-----\n";
  9655. for (size_t i = 0; i < b64.size(); i += 64) {
  9656. pem += b64.substr(i, 64);
  9657. pem += '\n';
  9658. }
  9659. pem += "-----END CERTIFICATE-----\n";
  9660. }
  9661. tls::free_cert(cert);
  9662. }
  9663. return pem;
  9664. }
  9665. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9666. // copied to buf, or pem itself when len is 0.
  9667. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9668. if (!pem || len == 0) { return pem; }
  9669. buf.assign(pem, len);
  9670. return buf.c_str();
  9671. }
  9672. // The parts of session setup that only SSLClient needs, plus the handful
  9673. // WebSocketClient also exposes; everything else takes the defaults, which is
  9674. // what keeps the two clients on one implementation.
  9675. struct ClientTlsSessionOptions {
  9676. // Both SSLClient and WebSocketClient expose this independently of
  9677. // certificate verification.
  9678. bool server_hostname_verification = true;
  9679. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9680. // When non-null, guards session creation against concurrent use of the
  9681. // context. A WebSocketClient is not safe to use from several threads to
  9682. // begin with, so it passes nothing.
  9683. std::mutex *ctx_mutex = nullptr;
  9684. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9685. // The caller decides whether Schannel has anything to say about this
  9686. // connection; see SSLClient::initialize_ssl().
  9687. bool windows_cert_verification = false;
  9688. // A server certificate verifier works on the backend's chain verification,
  9689. // so the backend keeps deciding and Schannel only adds its own check.
  9690. bool server_certificate_verifier_set = false;
  9691. #endif
  9692. };
  9693. // Filled in on failure for callers that report error details.
  9694. struct ClientTlsSessionError {
  9695. Error error = Error::Success;
  9696. int ssl_error = 0;
  9697. uint64_t backend_error = 0;
  9698. };
  9699. // Establishes a client TLS session on an already connected socket. On failure
  9700. // the session is left for the caller to free: SSLClient frees it right away,
  9701. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9702. inline bool setup_client_tls_session(
  9703. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9704. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9705. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9706. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9707. using namespace tls;
  9708. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9709. if (out_error) {
  9710. out_error->error = error;
  9711. out_error->ssl_error = ssl_error;
  9712. out_error->backend_error = backend_error;
  9713. }
  9714. return false;
  9715. };
  9716. // A TLS failure, whose verification codes name the Error too
  9717. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  9718. auto error = Error::SSLConnection;
  9719. if (code == ErrorCode::CertVerifyFailed) {
  9720. error = Error::SSLServerVerification;
  9721. } else if (code == ErrorCode::HostnameMismatch) {
  9722. error = Error::SSLServerHostnameVerification;
  9723. }
  9724. return fail(error, static_cast<int>(code), backend_error);
  9725. };
  9726. if (!ctx) {
  9727. session = nullptr;
  9728. return fail(Error::SSLConnection, 0, 0);
  9729. }
  9730. // With Windows verification on and no server certificate verifier set,
  9731. // Schannel is the only chain verifier. The backend's trust store is a
  9732. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9733. // demand, so the backend's verdict is not used.
  9734. auto windows_verifies_chain = false;
  9735. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9736. windows_verifies_chain = options.windows_cert_verification &&
  9737. !options.server_certificate_verifier_set;
  9738. #endif
  9739. // The chain, and a host name, are verified during the handshake, so that a
  9740. // server failing them never gets to see a client certificate. Unless
  9741. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  9742. // identity is checked after the handshake by verify_hostname().
  9743. auto verify_in_handshake =
  9744. server_certificate_verification && !windows_verifies_chain;
  9745. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9746. // A session verifier may accept a certificate the built-in check rejects,
  9747. // and runs only after the handshake
  9748. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  9749. #endif
  9750. {
  9751. std::unique_lock<std::mutex> guard;
  9752. if (options.ctx_mutex) {
  9753. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9754. }
  9755. // The mode is set on the context, so under the same lock
  9756. set_verify_client(ctx, verify_in_handshake);
  9757. session = create_session(ctx, sock);
  9758. }
  9759. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9760. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9761. // their identity is checked post-handshake below instead.
  9762. if (!is_ip_address(host)) {
  9763. if (!set_sni(session, host.c_str(),
  9764. verify_in_handshake && options.server_hostname_verification)) {
  9765. return fail(Error::SSLConnection, 0, get_error());
  9766. }
  9767. }
  9768. TlsError tls_err;
  9769. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9770. &tls_err)) {
  9771. return fail_tls(tls_err.code, tls_err.backend_code);
  9772. }
  9773. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9774. if (options.session_verifier) {
  9775. verification_status = options.session_verifier(session);
  9776. }
  9777. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9778. return fail(Error::SSLServerVerification, 0, get_error());
  9779. }
  9780. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9781. server_certificate_verification) {
  9782. if (!windows_verifies_chain) {
  9783. auto verify_result = get_verify_result(session);
  9784. if (verify_result != 0) {
  9785. return fail_tls(ErrorCode::CertVerifyFailed,
  9786. static_cast<uint64_t>(verify_result));
  9787. }
  9788. }
  9789. auto server_cert = get_peer_cert(session);
  9790. if (!server_cert) {
  9791. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  9792. }
  9793. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9794. // Identity check against the peer certificate, post-handshake for all
  9795. // backends. For IP hosts this is the only identity verification, since no
  9796. // hostname is bound during the handshake.
  9797. if (options.server_hostname_verification) {
  9798. if (!verify_hostname(server_cert, host.c_str())) {
  9799. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  9800. }
  9801. }
  9802. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9803. // Windows Schannel verification, which lets Windows fetch missing roots
  9804. // and intermediates on demand. It must not be skipped: unless a server
  9805. // certificate verifier is set, it is the only chain check.
  9806. if (options.windows_cert_verification) {
  9807. std::vector<unsigned char> der;
  9808. uint64_t wincrypt_error = 0;
  9809. if (!get_cert_der(server_cert, der) ||
  9810. !verify_cert_with_windows_schannel(
  9811. der, host, options.server_hostname_verification, wincrypt_error,
  9812. session)) {
  9813. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  9814. }
  9815. }
  9816. #endif
  9817. }
  9818. return true;
  9819. }
  9820. } // namespace detail
  9821. #endif // CPPHTTPLIB_SSL_ENABLED
  9822. /*
  9823. * Group 3: httplib namespace - Non-SSL public API implementations
  9824. */
  9825. inline void default_socket_options(socket_t sock) {
  9826. set_socket_opt(sock, SOL_SOCKET,
  9827. #ifdef SO_REUSEPORT
  9828. SO_REUSEPORT,
  9829. #else
  9830. SO_REUSEADDR,
  9831. #endif
  9832. 1);
  9833. }
  9834. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9835. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9836. sizeof(optval));
  9837. }
  9838. inline std::string get_bearer_token_auth(const Request &req) {
  9839. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9840. // than the prefix carries no token.
  9841. constexpr const char bearer_prefix[] = "Bearer ";
  9842. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9843. auto value = req.get_header_value("Authorization");
  9844. if (value.size() >= bearer_prefix_len &&
  9845. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9846. bearer_prefix)) {
  9847. return value.substr(bearer_prefix_len);
  9848. }
  9849. return "";
  9850. }
  9851. inline const char *status_message(int status) {
  9852. switch (status) {
  9853. case StatusCode::Continue_100: return "Continue";
  9854. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9855. case StatusCode::Processing_102: return "Processing";
  9856. case StatusCode::EarlyHints_103: return "Early Hints";
  9857. case StatusCode::OK_200: return "OK";
  9858. case StatusCode::Created_201: return "Created";
  9859. case StatusCode::Accepted_202: return "Accepted";
  9860. case StatusCode::NonAuthoritativeInformation_203:
  9861. return "Non-Authoritative Information";
  9862. case StatusCode::NoContent_204: return "No Content";
  9863. case StatusCode::ResetContent_205: return "Reset Content";
  9864. case StatusCode::PartialContent_206: return "Partial Content";
  9865. case StatusCode::MultiStatus_207: return "Multi-Status";
  9866. case StatusCode::AlreadyReported_208: return "Already Reported";
  9867. case StatusCode::IMUsed_226: return "IM Used";
  9868. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9869. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9870. case StatusCode::Found_302: return "Found";
  9871. case StatusCode::SeeOther_303: return "See Other";
  9872. case StatusCode::NotModified_304: return "Not Modified";
  9873. case StatusCode::UseProxy_305: return "Use Proxy";
  9874. case StatusCode::unused_306: return "unused";
  9875. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9876. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9877. case StatusCode::BadRequest_400: return "Bad Request";
  9878. case StatusCode::Unauthorized_401: return "Unauthorized";
  9879. case StatusCode::PaymentRequired_402: return "Payment Required";
  9880. case StatusCode::Forbidden_403: return "Forbidden";
  9881. case StatusCode::NotFound_404: return "Not Found";
  9882. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9883. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9884. case StatusCode::ProxyAuthenticationRequired_407:
  9885. return "Proxy Authentication Required";
  9886. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9887. case StatusCode::Conflict_409: return "Conflict";
  9888. case StatusCode::Gone_410: return "Gone";
  9889. case StatusCode::LengthRequired_411: return "Length Required";
  9890. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9891. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9892. case StatusCode::UriTooLong_414: return "URI Too Long";
  9893. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9894. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9895. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9896. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9897. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9898. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9899. case StatusCode::Locked_423: return "Locked";
  9900. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9901. case StatusCode::TooEarly_425: return "Too Early";
  9902. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9903. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9904. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9905. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9906. return "Request Header Fields Too Large";
  9907. case StatusCode::UnavailableForLegalReasons_451:
  9908. return "Unavailable For Legal Reasons";
  9909. case StatusCode::NotImplemented_501: return "Not Implemented";
  9910. case StatusCode::BadGateway_502: return "Bad Gateway";
  9911. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9912. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9913. case StatusCode::HttpVersionNotSupported_505:
  9914. return "HTTP Version Not Supported";
  9915. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9916. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9917. case StatusCode::LoopDetected_508: return "Loop Detected";
  9918. case StatusCode::NotExtended_510: return "Not Extended";
  9919. case StatusCode::NetworkAuthenticationRequired_511:
  9920. return "Network Authentication Required";
  9921. default:
  9922. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9923. }
  9924. }
  9925. inline std::string to_string(const Error error) {
  9926. switch (error) {
  9927. case Error::Success: return "Success (no error)";
  9928. case Error::Unknown: return "Unknown";
  9929. case Error::Connection: return "Could not establish connection";
  9930. case Error::BindIPAddress: return "Failed to bind IP address";
  9931. case Error::Read: return "Failed to read connection";
  9932. case Error::Write: return "Failed to write connection";
  9933. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9934. case Error::Canceled: return "Connection handling canceled";
  9935. case Error::SSLConnection: return "SSL connection failed";
  9936. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9937. case Error::SSLServerVerification: return "SSL server verification failed";
  9938. case Error::SSLServerHostnameVerification:
  9939. return "SSL server hostname verification failed";
  9940. case Error::UnsupportedMultipartBoundaryChars:
  9941. return "Unsupported HTTP multipart boundary characters";
  9942. case Error::Compression: return "Compression failed";
  9943. case Error::ConnectionTimeout: return "Connection timed out";
  9944. case Error::ProxyConnection: return "Proxy connection failed";
  9945. case Error::ConnectionClosed: return "Connection closed by server";
  9946. case Error::Timeout: return "Read timeout";
  9947. case Error::ResourceExhaustion: return "Resource exhaustion";
  9948. case Error::TooManyFormDataFiles: return "Too many form data files";
  9949. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9950. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9951. case Error::ExceedMaxSocketDescriptorCount:
  9952. return "Exceeded maximum socket descriptor count";
  9953. case Error::InvalidRequestLine: return "Invalid request line";
  9954. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9955. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9956. case Error::InvalidHeaders: return "Invalid headers";
  9957. case Error::MultipartParsing: return "Multipart parsing failed";
  9958. case Error::OpenFile: return "Failed to open file";
  9959. case Error::Listen: return "Failed to listen on socket";
  9960. case Error::GetSockName: return "Failed to get socket name";
  9961. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9962. case Error::HTTPParsing: return "HTTP parsing failed";
  9963. case Error::InvalidRangeHeader: return "Invalid Range header";
  9964. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9965. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9966. case Error::UserCallbackException: return "User callback threw an exception";
  9967. default: break;
  9968. }
  9969. return "Invalid";
  9970. }
  9971. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9972. os << to_string(obj);
  9973. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9974. return os;
  9975. }
  9976. inline std::string hosted_at(const std::string &hostname) {
  9977. std::vector<std::string> addrs;
  9978. hosted_at(hostname, addrs);
  9979. if (addrs.empty()) { return std::string(); }
  9980. return addrs[0];
  9981. }
  9982. inline void hosted_at(const std::string &hostname,
  9983. std::vector<std::string> &addrs) {
  9984. struct addrinfo hints;
  9985. struct addrinfo *result;
  9986. memset(&hints, 0, sizeof(struct addrinfo));
  9987. hints.ai_family = AF_UNSPEC;
  9988. hints.ai_socktype = SOCK_STREAM;
  9989. hints.ai_protocol = 0;
  9990. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9991. &result, 0)) {
  9992. #if defined __linux__ && !defined __ANDROID__
  9993. res_init();
  9994. #endif
  9995. return;
  9996. }
  9997. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9998. for (auto rp = result; rp; rp = rp->ai_next) {
  9999. const auto &addr =
  10000. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  10001. std::string ip;
  10002. auto dummy = -1;
  10003. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  10004. dummy)) {
  10005. addrs.emplace_back(std::move(ip));
  10006. }
  10007. }
  10008. }
  10009. inline std::string encode_uri_component(const std::string &value) {
  10010. std::ostringstream escaped;
  10011. escaped.fill('0');
  10012. escaped << std::hex;
  10013. for (auto c : value) {
  10014. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10015. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  10016. escaped << c;
  10017. } else {
  10018. escaped << std::uppercase;
  10019. escaped << '%' << std::setw(2)
  10020. << static_cast<int>(static_cast<unsigned char>(c));
  10021. escaped << std::nouppercase;
  10022. }
  10023. }
  10024. return escaped.str();
  10025. }
  10026. inline std::string encode_uri(const std::string &value) {
  10027. std::ostringstream escaped;
  10028. escaped.fill('0');
  10029. escaped << std::hex;
  10030. for (auto c : value) {
  10031. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  10032. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  10033. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  10034. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  10035. escaped << c;
  10036. } else {
  10037. escaped << std::uppercase;
  10038. escaped << '%' << std::setw(2)
  10039. << static_cast<int>(static_cast<unsigned char>(c));
  10040. escaped << std::nouppercase;
  10041. }
  10042. }
  10043. return escaped.str();
  10044. }
  10045. inline std::string decode_uri_component(const std::string &value) {
  10046. std::string result;
  10047. for (size_t i = 0; i < value.size(); i++) {
  10048. if (value[i] == '%' && i + 2 < value.size()) {
  10049. auto val = 0;
  10050. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10051. result += static_cast<char>(val);
  10052. i += 2;
  10053. } else {
  10054. result += value[i];
  10055. }
  10056. } else {
  10057. result += value[i];
  10058. }
  10059. }
  10060. return result;
  10061. }
  10062. inline std::string decode_uri(const std::string &value) {
  10063. std::string result;
  10064. for (size_t i = 0; i < value.size(); i++) {
  10065. if (value[i] == '%' && i + 2 < value.size()) {
  10066. auto val = 0;
  10067. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  10068. auto c = static_cast<char>(val);
  10069. // Keep escapes of the reserved characters that encode_uri leaves
  10070. // literal, so decode_uri is the inverse of encode_uri and an escaped
  10071. // delimiter is not promoted into a real one (as with JS decodeURI).
  10072. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  10073. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  10074. c == '#') {
  10075. result += value[i];
  10076. result += value[i + 1];
  10077. result += value[i + 2];
  10078. } else {
  10079. result += c;
  10080. }
  10081. i += 2;
  10082. } else {
  10083. result += value[i];
  10084. }
  10085. } else {
  10086. result += value[i];
  10087. }
  10088. }
  10089. return result;
  10090. }
  10091. inline std::string encode_path_component(const std::string &component) {
  10092. std::string result;
  10093. result.reserve(component.size() * 3);
  10094. for (size_t i = 0; i < component.size(); i++) {
  10095. auto c = static_cast<unsigned char>(component[i]);
  10096. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  10097. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10098. c == '_' || c == '~') {
  10099. result += static_cast<char>(c);
  10100. }
  10101. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  10102. // "," / ";" / "="
  10103. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  10104. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  10105. c == '=') {
  10106. result += static_cast<char>(c);
  10107. }
  10108. // Colon is allowed in path segments except first segment
  10109. else if (c == ':') {
  10110. result += static_cast<char>(c);
  10111. }
  10112. // @ is allowed in path
  10113. else if (c == '@') {
  10114. result += static_cast<char>(c);
  10115. } else {
  10116. result += '%';
  10117. char hex[3];
  10118. snprintf(hex, sizeof(hex), "%02X", c);
  10119. result.append(hex, 2);
  10120. }
  10121. }
  10122. return result;
  10123. }
  10124. inline std::string decode_path_component(const std::string &component) {
  10125. std::string result;
  10126. result.reserve(component.size());
  10127. for (size_t i = 0; i < component.size(); i++) {
  10128. if (component[i] == '%' && i + 1 < component.size()) {
  10129. if (component[i + 1] == 'u') {
  10130. // Unicode %uXXXX encoding
  10131. auto val = 0;
  10132. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  10133. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  10134. char buff[4];
  10135. size_t len = 0;
  10136. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  10137. (len = detail::to_utf8(val, buff)) > 0) {
  10138. result.append(buff, len);
  10139. i += 5; // 'u0000'
  10140. } else {
  10141. // Not 4 hex digits, or a surrogate, which is no character: the
  10142. // escape is kept as it is rather than joining its neighbours
  10143. result += component[i];
  10144. }
  10145. } else {
  10146. // Standard %XX encoding
  10147. auto val = 0;
  10148. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10149. // 2 digits hex codes
  10150. result += static_cast<char>(val);
  10151. i += 2; // 'XX'
  10152. } else {
  10153. result += component[i];
  10154. }
  10155. }
  10156. } else {
  10157. result += component[i];
  10158. }
  10159. }
  10160. return result;
  10161. }
  10162. inline std::string encode_query_component(const std::string &component,
  10163. bool space_as_plus) {
  10164. std::string result;
  10165. result.reserve(component.size() * 3);
  10166. for (size_t i = 0; i < component.size(); i++) {
  10167. auto c = static_cast<unsigned char>(component[i]);
  10168. // Unreserved characters per RFC 3986
  10169. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10170. c == '_' || c == '~') {
  10171. result += static_cast<char>(c);
  10172. }
  10173. // Space handling
  10174. else if (c == ' ') {
  10175. if (space_as_plus) {
  10176. result += '+';
  10177. } else {
  10178. result += "%20";
  10179. }
  10180. }
  10181. // Plus sign handling
  10182. else if (c == '+') {
  10183. if (space_as_plus) {
  10184. result += "%2B";
  10185. } else {
  10186. result += static_cast<char>(c);
  10187. }
  10188. }
  10189. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10190. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10191. c == '*' || c == ',' || c == ';') {
  10192. result += static_cast<char>(c);
  10193. }
  10194. // Colon and @ are allowed in query
  10195. else if (c == ':' || c == '@') {
  10196. result += static_cast<char>(c);
  10197. }
  10198. // Forward slash is allowed in query values
  10199. else if (c == '/') {
  10200. result += static_cast<char>(c);
  10201. }
  10202. // Question mark is allowed in query values (after first ?)
  10203. else if (c == '?') {
  10204. result += static_cast<char>(c);
  10205. } else {
  10206. result += '%';
  10207. char hex[3];
  10208. snprintf(hex, sizeof(hex), "%02X", c);
  10209. result.append(hex, 2);
  10210. }
  10211. }
  10212. return result;
  10213. }
  10214. inline std::string decode_query_component(const std::string &component,
  10215. bool plus_as_space) {
  10216. std::string result;
  10217. result.reserve(component.size());
  10218. for (size_t i = 0; i < component.size(); i++) {
  10219. if (component[i] == '%' && i + 2 < component.size()) {
  10220. auto val = 0;
  10221. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10222. result += static_cast<char>(val);
  10223. i += 2;
  10224. } else {
  10225. result += component[i];
  10226. }
  10227. } else if (component[i] == '+' && plus_as_space) {
  10228. result += ' '; // + becomes space in form-urlencoded
  10229. } else {
  10230. result += component[i];
  10231. }
  10232. }
  10233. return result;
  10234. }
  10235. inline std::string sanitize_filename(const std::string &filename) {
  10236. // Extract basename: find the last path separator (/ or \) and, on Windows,
  10237. // ':', which ends a drive prefix ("C:..") or names an NTFS stream ("a:b")
  10238. #ifdef _WIN32
  10239. auto pos = filename.find_last_of("/\\:");
  10240. #else
  10241. auto pos = filename.find_last_of("/\\");
  10242. #endif
  10243. auto result =
  10244. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10245. // Strip null bytes
  10246. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10247. // Trim whitespace
  10248. {
  10249. auto start = result.find_first_not_of(" \t");
  10250. auto end = result.find_last_not_of(" \t");
  10251. result = (start == std::string::npos)
  10252. ? ""
  10253. : result.substr(start, end - start + 1);
  10254. }
  10255. // Reject . and ..
  10256. if (result == "." || result == "..") { return ""; }
  10257. return result;
  10258. }
  10259. inline std::string append_query_params(const std::string &path,
  10260. const Params &params) {
  10261. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10262. auto fragment_pos = path.find('#');
  10263. auto path_with_query = path.substr(0, fragment_pos);
  10264. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10265. path_with_query += detail::params_to_query_str(params);
  10266. if (fragment_pos != std::string::npos) {
  10267. path_with_query.append(path, fragment_pos, std::string::npos);
  10268. }
  10269. return path_with_query;
  10270. }
  10271. // Header utilities
  10272. inline std::pair<std::string, std::string>
  10273. make_range_header(const Ranges &ranges) {
  10274. std::string field = "bytes=";
  10275. auto i = 0;
  10276. for (const auto &r : ranges) {
  10277. if (i != 0) { field += ", "; }
  10278. if (r.first != -1) { field += std::to_string(r.first); }
  10279. field += '-';
  10280. if (r.second != -1) { field += std::to_string(r.second); }
  10281. i++;
  10282. }
  10283. return std::make_pair("Range", std::move(field));
  10284. }
  10285. inline std::pair<std::string, std::string>
  10286. make_basic_authentication_header(const std::string &username,
  10287. const std::string &password, bool is_proxy) {
  10288. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10289. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10290. return std::make_pair(key, std::move(field));
  10291. }
  10292. inline std::pair<std::string, std::string>
  10293. make_bearer_token_authentication_header(const std::string &token,
  10294. bool is_proxy = false) {
  10295. auto field = "Bearer " + token;
  10296. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10297. return std::make_pair(key, std::move(field));
  10298. }
  10299. namespace detail {
  10300. // Basic auth when a username or password is set, otherwise a bearer token,
  10301. // unless the request already carries the header.
  10302. inline void add_authorization_header(Request &req, const std::string &username,
  10303. const std::string &password,
  10304. const std::string &token, bool is_proxy) {
  10305. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10306. return;
  10307. }
  10308. if (!username.empty() || !password.empty()) {
  10309. req.headers.insert(
  10310. make_basic_authentication_header(username, password, is_proxy));
  10311. } else if (!token.empty()) {
  10312. req.headers.insert(
  10313. make_bearer_token_authentication_header(token, is_proxy));
  10314. }
  10315. }
  10316. } // namespace detail
  10317. // Request implementation
  10318. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10319. size_t id) const {
  10320. return detail::get_header_value_u64(headers, key, def, id);
  10321. }
  10322. inline bool Request::has_header(const std::string &key) const {
  10323. return detail::has_header(headers, key);
  10324. }
  10325. inline std::string Request::get_header_value(const std::string &key,
  10326. const char *def, size_t id) const {
  10327. return detail::get_header_value(headers, key, def, id);
  10328. }
  10329. inline size_t Request::get_header_value_count(const std::string &key) const {
  10330. return detail::get_header_value_count(headers, key);
  10331. }
  10332. inline void Request::set_header(const std::string &key,
  10333. const std::string &val) {
  10334. detail::set_header(headers, key, val);
  10335. }
  10336. inline bool Request::has_trailer(const std::string &key) const {
  10337. return trailers.find(key) != trailers.end();
  10338. }
  10339. inline std::string Request::get_trailer_value(const std::string &key,
  10340. size_t id) const {
  10341. return detail::get_multimap_value(trailers, key, id);
  10342. }
  10343. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10344. return trailers.count(key);
  10345. }
  10346. inline bool Request::has_param(const std::string &key) const {
  10347. return params.find(key) != params.end();
  10348. }
  10349. inline std::string Request::get_param_value(const std::string &key,
  10350. size_t id) const {
  10351. return detail::get_multimap_value(params, key, id);
  10352. }
  10353. inline std::vector<std::string>
  10354. Request::get_param_values(const std::string &key) const {
  10355. auto rng = params.equal_range(key);
  10356. std::vector<std::string> values;
  10357. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10358. for (auto it = rng.first; it != rng.second; ++it) {
  10359. values.push_back(it->second);
  10360. }
  10361. return values;
  10362. }
  10363. inline size_t Request::get_param_value_count(const std::string &key) const {
  10364. return params.count(key);
  10365. }
  10366. inline bool Request::is_multipart_form_data() const {
  10367. const auto &content_type = get_header_value("Content-Type");
  10368. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10369. "multipart/form-data");
  10370. }
  10371. // Multipart FormData implementation
  10372. inline std::string MultipartFormData::get_field(const std::string &key,
  10373. size_t id) const {
  10374. auto rng = fields.equal_range(key);
  10375. auto it = detail::bounded_next(rng.first, id, rng.second);
  10376. if (it != rng.second) { return it->second.content; }
  10377. return std::string();
  10378. }
  10379. inline std::vector<std::string>
  10380. MultipartFormData::get_fields(const std::string &key) const {
  10381. std::vector<std::string> values;
  10382. auto rng = fields.equal_range(key);
  10383. for (auto it = rng.first; it != rng.second; it++) {
  10384. values.push_back(it->second.content);
  10385. }
  10386. return values;
  10387. }
  10388. inline bool MultipartFormData::has_field(const std::string &key) const {
  10389. return fields.find(key) != fields.end();
  10390. }
  10391. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10392. return fields.count(key);
  10393. }
  10394. inline FormData MultipartFormData::get_file(const std::string &key,
  10395. size_t id) const {
  10396. return detail::get_multimap_value(files, key, id);
  10397. }
  10398. inline std::vector<FormData>
  10399. MultipartFormData::get_files(const std::string &key) const {
  10400. std::vector<FormData> values;
  10401. auto rng = files.equal_range(key);
  10402. for (auto it = rng.first; it != rng.second; it++) {
  10403. values.push_back(it->second);
  10404. }
  10405. return values;
  10406. }
  10407. inline bool MultipartFormData::has_file(const std::string &key) const {
  10408. return files.find(key) != files.end();
  10409. }
  10410. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10411. return files.count(key);
  10412. }
  10413. // Multipart FormData writer implementation
  10414. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10415. return detail::is_multipart_boundary_chars_valid(boundary);
  10416. }
  10417. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10418. : boundary_(detail::make_multipart_data_boundary()) {}
  10419. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10420. : boundary_(std::move(boundary)) {}
  10421. inline const std::string &MultipartFormDataWriter::boundary() const {
  10422. return boundary_;
  10423. }
  10424. inline std::string MultipartFormDataWriter::content_type() const {
  10425. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10426. }
  10427. inline std::string
  10428. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10429. return detail::serialize_multipart_formdata(items, boundary_);
  10430. }
  10431. inline size_t MultipartFormDataWriter::content_length(
  10432. const UploadFormDataItems &items) const {
  10433. return detail::get_multipart_content_length(items, boundary_);
  10434. }
  10435. inline std::string
  10436. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10437. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10438. }
  10439. inline std::string MultipartFormDataWriter::item_end() {
  10440. return detail::serialize_multipart_formdata_item_end();
  10441. }
  10442. inline std::string MultipartFormDataWriter::finish() const {
  10443. return detail::serialize_multipart_formdata_finish(boundary_);
  10444. }
  10445. // Response implementation
  10446. namespace detail {
  10447. // A response has one content source: `body`, a content provider, or a file.
  10448. // Each content setter calls this so that the one called last wins.
  10449. inline void clear_content_provider(Response &res) {
  10450. auto releaser = std::move(res.content_provider_resource_releaser_);
  10451. auto success = res.content_provider_success_;
  10452. res.content_length_ = 0;
  10453. res.content_provider_ = nullptr;
  10454. res.content_provider_resource_releaser_ = nullptr;
  10455. res.is_chunked_content_provider_ = false;
  10456. res.is_file_content_provider_ = false;
  10457. res.content_provider_success_ = false;
  10458. res.content_coding_ = EncodingType::None;
  10459. res.file_content_path_.clear();
  10460. res.file_content_content_type_.clear();
  10461. if (releaser) { releaser(success); }
  10462. }
  10463. inline void clear_content(Response &res) {
  10464. res.body.clear();
  10465. clear_content_provider(res);
  10466. }
  10467. // The Content-Type of the old content goes with it.
  10468. inline void set_content_type(Response &res, const std::string &content_type) {
  10469. res.headers.erase("Content-Type");
  10470. res.set_header("Content-Type", content_type);
  10471. }
  10472. // `body` is public, so it can be assigned directly after a provider or a file
  10473. // was set. It came last, so it wins.
  10474. inline void prefer_assigned_body(Response &res) {
  10475. if (!res.body.empty() &&
  10476. (res.content_provider_ || !res.file_content_path_.empty())) {
  10477. clear_content_provider(res);
  10478. }
  10479. }
  10480. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10481. inline bool body_allowed_for_status(int status) {
  10482. return status >= 200 && status != StatusCode::NoContent_204 &&
  10483. status != StatusCode::NotModified_304;
  10484. }
  10485. // Only a 206 response is served as a partial representation. range_error()
  10486. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10487. // status would start from an unchecked offset.
  10488. inline bool is_partial_content(const Request &req, const Response &res) {
  10489. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10490. }
  10491. // Sets the Content-Length or Transfer-Encoding framing the body that
  10492. // Server::write_response_core() writes, or closes the connection after a body
  10493. // that has neither. Only the library sets them: one from a handler would go
  10494. // out next to it, or describe some other body.
  10495. inline void set_framing_headers(const Request &req, Response &res,
  10496. const std::string &boundary,
  10497. const std::string &content_type) {
  10498. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10499. auto head_length = req.method == "HEAD"
  10500. ? res.get_header_value("Content-Length")
  10501. : std::string();
  10502. res.headers.erase("Content-Length");
  10503. res.headers.erase("Transfer-Encoding");
  10504. if (!body_allowed_for_status(res.status)) { return; }
  10505. if (res.content_provider_) {
  10506. if (res.content_length_ == 0) {
  10507. if (res.is_chunked_content_provider_) {
  10508. res.set_header("Transfer-Encoding", "chunked");
  10509. } else if (req.method != "HEAD") {
  10510. // RFC 9112 6.3: a body with neither ends where the connection does.
  10511. res.headers.erase("Keep-Alive");
  10512. if (!has_header_token(res.headers, "Connection", "close")) {
  10513. res.set_header("Connection", "close");
  10514. }
  10515. }
  10516. return;
  10517. }
  10518. // The part Server::write_content_with_provider() writes.
  10519. auto length = res.content_length_;
  10520. if (is_partial_content(req, res)) {
  10521. length = req.ranges.size() == 1
  10522. ? get_range_offset_and_length(req.ranges[0], length).second
  10523. : get_multipart_ranges_data_length(req, boundary,
  10524. content_type, length);
  10525. }
  10526. res.set_header("Content-Length", std::to_string(length));
  10527. } else if (!res.body.empty()) {
  10528. res.set_header("Content-Length", std::to_string(res.body.size()));
  10529. } else {
  10530. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10531. }
  10532. }
  10533. } // namespace detail
  10534. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10535. size_t id) const {
  10536. return detail::get_header_value_u64(headers, key, def, id);
  10537. }
  10538. inline bool Response::has_header(const std::string &key) const {
  10539. return headers.find(key) != headers.end();
  10540. }
  10541. inline std::string Response::get_header_value(const std::string &key,
  10542. const char *def,
  10543. size_t id) const {
  10544. return detail::get_header_value(headers, key, def, id);
  10545. }
  10546. inline size_t Response::get_header_value_count(const std::string &key) const {
  10547. return detail::get_header_value_count(headers, key);
  10548. }
  10549. inline void Response::set_header(const std::string &key,
  10550. const std::string &val) {
  10551. detail::set_header(headers, key, val);
  10552. }
  10553. inline bool Response::has_trailer(const std::string &key) const {
  10554. return trailers.find(key) != trailers.end();
  10555. }
  10556. inline std::string Response::get_trailer_value(const std::string &key,
  10557. size_t id) const {
  10558. return detail::get_multimap_value(trailers, key, id);
  10559. }
  10560. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10561. return trailers.count(key);
  10562. }
  10563. inline void Response::set_redirect(const std::string &url, int stat) {
  10564. if (detail::fields::is_field_value(url)) {
  10565. set_header("Location", url);
  10566. if (300 <= stat && stat < 400) {
  10567. this->status = stat;
  10568. } else {
  10569. this->status = StatusCode::Found_302;
  10570. }
  10571. }
  10572. }
  10573. inline void Response::set_content(const char *s, size_t n,
  10574. const std::string &content_type) {
  10575. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10576. detail::clear_content_provider(*this);
  10577. detail::set_content_type(*this, content_type);
  10578. }
  10579. inline void Response::set_content(const std::string &s,
  10580. const std::string &content_type) {
  10581. set_content(s.data(), s.size(), content_type);
  10582. }
  10583. inline void Response::set_content(std::string &&s,
  10584. const std::string &content_type) {
  10585. body = std::move(s);
  10586. detail::clear_content_provider(*this);
  10587. detail::set_content_type(*this, content_type);
  10588. }
  10589. inline void Response::set_content_provider(
  10590. size_t in_length, const std::string &content_type, ContentProvider provider,
  10591. ContentProviderResourceReleaser resource_releaser) {
  10592. detail::clear_content(*this);
  10593. detail::set_content_type(*this, content_type);
  10594. content_length_ = in_length;
  10595. if (in_length > 0) { content_provider_ = std::move(provider); }
  10596. content_provider_resource_releaser_ = std::move(resource_releaser);
  10597. }
  10598. inline void Response::set_content_provider(
  10599. const std::string &content_type, ContentProviderWithoutLength provider,
  10600. ContentProviderResourceReleaser resource_releaser) {
  10601. detail::clear_content(*this);
  10602. detail::set_content_type(*this, content_type);
  10603. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10604. content_provider_resource_releaser_ = std::move(resource_releaser);
  10605. }
  10606. inline void Response::set_chunked_content_provider(
  10607. const std::string &content_type, ContentProviderWithoutLength provider,
  10608. ContentProviderResourceReleaser resource_releaser) {
  10609. set_content_provider(content_type, std::move(provider),
  10610. std::move(resource_releaser));
  10611. is_chunked_content_provider_ = true;
  10612. }
  10613. inline void Response::set_file_content(const std::string &path,
  10614. const std::string &content_type) {
  10615. detail::clear_content(*this);
  10616. headers.erase("Content-Type");
  10617. file_content_path_ = path;
  10618. file_content_content_type_ = content_type;
  10619. }
  10620. inline void Response::set_file_content(const std::string &path) {
  10621. set_file_content(path, std::string());
  10622. }
  10623. // Result implementation
  10624. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10625. size_t def,
  10626. size_t id) const {
  10627. return detail::get_header_value_u64(request_headers_, key, def, id);
  10628. }
  10629. inline bool Result::has_request_header(const std::string &key) const {
  10630. return request_headers_.find(key) != request_headers_.end();
  10631. }
  10632. inline std::string Result::get_request_header_value(const std::string &key,
  10633. const char *def,
  10634. size_t id) const {
  10635. return detail::get_header_value(request_headers_, key, def, id);
  10636. }
  10637. inline size_t
  10638. Result::get_request_header_value_count(const std::string &key) const {
  10639. return request_headers_.count(key);
  10640. }
  10641. // Stream implementation
  10642. inline ssize_t Stream::write(const char *ptr) {
  10643. return write(ptr, strlen(ptr));
  10644. }
  10645. inline ssize_t Stream::write(const std::string &s) {
  10646. return write(s.data(), s.size());
  10647. }
  10648. // BodyReader implementation
  10649. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10650. if (!stream) {
  10651. last_error = Error::Connection;
  10652. return -1;
  10653. }
  10654. if (eof) { return 0; }
  10655. if (!chunked) {
  10656. // Content-Length based reading
  10657. if (has_content_length && bytes_read >= content_length) {
  10658. eof = true;
  10659. return 0;
  10660. }
  10661. auto to_read = len;
  10662. if (has_content_length) {
  10663. auto remaining = content_length - bytes_read;
  10664. to_read = (std::min)(len, remaining);
  10665. }
  10666. auto n = stream->read(buf, to_read);
  10667. // Without Content-Length the body ends when the connection closes
  10668. // (RFC 9112 §6.3); with one, an EOF here came too early
  10669. if (n < 0 || (n == 0 && has_content_length)) {
  10670. last_error = stream->get_error();
  10671. if (last_error == Error::Success) { last_error = Error::Read; }
  10672. }
  10673. if (n <= 0) {
  10674. eof = true;
  10675. return n;
  10676. }
  10677. bytes_read += static_cast<size_t>(n);
  10678. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10679. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10680. last_error = Error::ExceedMaxPayloadSize;
  10681. eof = true;
  10682. return -1;
  10683. }
  10684. return n;
  10685. }
  10686. // Chunked transfer encoding: delegate to shared decoder instance.
  10687. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10688. size_t chunk_offset = 0;
  10689. size_t chunk_total = 0;
  10690. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10691. if (n < 0) {
  10692. last_error = stream->get_error();
  10693. if (last_error == Error::Success) { last_error = Error::Read; }
  10694. eof = true;
  10695. return n;
  10696. }
  10697. if (n == 0) {
  10698. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10699. eof = true;
  10700. return 0;
  10701. }
  10702. bytes_read += static_cast<size_t>(n);
  10703. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10704. last_error = Error::ExceedMaxPayloadSize;
  10705. eof = true;
  10706. return -1;
  10707. }
  10708. return n;
  10709. }
  10710. // ThreadPool implementation
  10711. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10712. time_t idle_timeout_sec)
  10713. : base_thread_count_(n), max_queued_requests_(mqr),
  10714. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10715. shutdown_(false) {
  10716. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10717. if (max_n != 0 && max_n < n) {
  10718. std::string msg = "max_threads must be >= base_threads";
  10719. throw std::invalid_argument(msg);
  10720. }
  10721. #endif
  10722. max_thread_count_ = max_n == 0 ? n : max_n;
  10723. threads_.reserve(base_thread_count_);
  10724. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10725. try {
  10726. #endif
  10727. for (size_t i = 0; i < base_thread_count_; i++) {
  10728. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10729. }
  10730. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10731. } catch (...) {
  10732. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10733. // signal the workers we already spawned to exit and join them so the
  10734. // vector destructor does not see joinable threads (which would call
  10735. // std::terminate). Then rethrow so the caller learns of the failure.
  10736. {
  10737. std::unique_lock<std::mutex> lock(mutex_);
  10738. shutdown_ = true;
  10739. }
  10740. cond_.notify_all();
  10741. for (auto &t : threads_) {
  10742. if (t.joinable()) { t.join(); }
  10743. }
  10744. throw;
  10745. }
  10746. #endif
  10747. }
  10748. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10749. {
  10750. std::unique_lock<std::mutex> lock(mutex_);
  10751. if (shutdown_) { return false; }
  10752. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10753. return false;
  10754. }
  10755. jobs_.push_back(std::move(fn));
  10756. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10757. if (jobs_.size() > idle_thread_count_ &&
  10758. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10759. cleanup_finished_threads();
  10760. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10761. try {
  10762. #endif
  10763. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10764. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10765. } catch (const std::system_error &) {
  10766. // No thread budget left: keep the job queued for an existing worker
  10767. // instead of letting the exception escape the accept loop.
  10768. }
  10769. #endif
  10770. }
  10771. }
  10772. cond_.notify_one();
  10773. return true;
  10774. }
  10775. inline void ThreadPool::shutdown() {
  10776. {
  10777. std::unique_lock<std::mutex> lock(mutex_);
  10778. shutdown_ = true;
  10779. }
  10780. cond_.notify_all();
  10781. for (auto &t : threads_) {
  10782. if (t.joinable()) { t.join(); }
  10783. }
  10784. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10785. // with worker threads that call move_to_finished() concurrently.
  10786. std::list<std::thread> remaining_dynamic;
  10787. {
  10788. std::unique_lock<std::mutex> lock(mutex_);
  10789. remaining_dynamic = std::move(dynamic_threads_);
  10790. }
  10791. for (auto &t : remaining_dynamic) {
  10792. if (t.joinable()) { t.join(); }
  10793. }
  10794. std::unique_lock<std::mutex> lock(mutex_);
  10795. cleanup_finished_threads();
  10796. }
  10797. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10798. // Must be called with mutex_ held
  10799. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10800. if (it->get_id() == id) {
  10801. finished_threads_.push_back(std::move(*it));
  10802. dynamic_threads_.erase(it);
  10803. return;
  10804. }
  10805. }
  10806. }
  10807. inline void ThreadPool::cleanup_finished_threads() {
  10808. // Must be called with mutex_ held
  10809. for (auto &t : finished_threads_) {
  10810. if (t.joinable()) { t.join(); }
  10811. }
  10812. finished_threads_.clear();
  10813. }
  10814. inline void ThreadPool::worker(bool is_dynamic) {
  10815. for (;;) {
  10816. std::function<void()> fn;
  10817. {
  10818. std::unique_lock<std::mutex> lock(mutex_);
  10819. idle_thread_count_++;
  10820. if (is_dynamic) {
  10821. auto has_work =
  10822. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10823. [&] { return !jobs_.empty() || shutdown_; });
  10824. if (!has_work) {
  10825. // Timed out with no work - exit this dynamic thread
  10826. idle_thread_count_--;
  10827. move_to_finished(std::this_thread::get_id());
  10828. break;
  10829. }
  10830. } else {
  10831. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10832. }
  10833. idle_thread_count_--;
  10834. if (shutdown_ && jobs_.empty()) { break; }
  10835. fn = std::move(jobs_.front());
  10836. jobs_.pop_front();
  10837. }
  10838. assert(true == static_cast<bool>(fn));
  10839. fn();
  10840. }
  10841. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10842. !defined(LIBRESSL_VERSION_NUMBER)
  10843. OPENSSL_thread_stop();
  10844. #endif
  10845. }
  10846. /*
  10847. * Group 1 (continued): detail namespace - Stream implementations
  10848. */
  10849. namespace detail {
  10850. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10851. time_t timeout_sec, time_t timeout_usec,
  10852. time_t &actual_timeout_sec,
  10853. time_t &actual_timeout_usec) {
  10854. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10855. auto actual_timeout_msec =
  10856. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10857. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10858. actual_timeout_sec = actual_timeout_msec / 1000;
  10859. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10860. }
  10861. // Socket stream implementation
  10862. inline SocketStream::SocketStream(
  10863. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10864. time_t write_timeout_sec, time_t write_timeout_usec,
  10865. time_t max_timeout_msec,
  10866. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10867. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10868. read_timeout_usec_(read_timeout_usec),
  10869. write_timeout_sec_(write_timeout_sec),
  10870. write_timeout_usec_(write_timeout_usec),
  10871. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10872. read_buff_(read_buff_size_, 0) {}
  10873. inline SocketStream::~SocketStream() = default;
  10874. inline bool SocketStream::is_readable() const {
  10875. return read_buff_off_ < read_buff_content_size_;
  10876. }
  10877. inline bool SocketStream::wait_readable() const {
  10878. if (max_timeout_msec_ <= 0) {
  10879. return select_read_interruptible(sock_, read_timeout_sec_,
  10880. read_timeout_usec_, read_interrupted_) > 0;
  10881. }
  10882. time_t read_timeout_sec;
  10883. time_t read_timeout_usec;
  10884. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10885. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10886. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10887. read_interrupted_) > 0;
  10888. }
  10889. inline bool SocketStream::wait_writable() const {
  10890. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10891. }
  10892. inline bool SocketStream::ensure_readable() {
  10893. if (readable_hint_) {
  10894. readable_hint_ = false;
  10895. return true;
  10896. }
  10897. return wait_readable();
  10898. }
  10899. inline const char *SocketStream::buffered_data(size_t &size) const {
  10900. size = read_buff_content_size_ - read_buff_off_;
  10901. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10902. }
  10903. inline void SocketStream::consume_buffered(size_t size) {
  10904. assert(size <= read_buff_content_size_ - read_buff_off_);
  10905. read_buff_off_ += size;
  10906. }
  10907. inline bool SocketStream::is_peer_alive() const {
  10908. return detail::is_socket_alive(sock_);
  10909. }
  10910. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10911. #ifdef _WIN32
  10912. size =
  10913. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10914. #else
  10915. size = (std::min)(size,
  10916. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10917. #endif
  10918. if (read_buff_off_ < read_buff_content_size_) {
  10919. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10920. if (size <= remaining_size) {
  10921. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10922. read_buff_off_ += size;
  10923. return static_cast<ssize_t>(size);
  10924. } else {
  10925. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10926. read_buff_off_ += remaining_size;
  10927. return static_cast<ssize_t>(remaining_size);
  10928. }
  10929. }
  10930. if (!ensure_readable()) {
  10931. error_ = Error::Timeout;
  10932. return -1;
  10933. }
  10934. read_buff_off_ = 0;
  10935. read_buff_content_size_ = 0;
  10936. if (size < read_buff_size_) {
  10937. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10938. CPPHTTPLIB_RECV_FLAGS);
  10939. if (n <= 0) {
  10940. if (n == 0) {
  10941. error_ = Error::ConnectionClosed;
  10942. } else {
  10943. error_ = Error::Read;
  10944. }
  10945. return n;
  10946. } else if (n <= static_cast<ssize_t>(size)) {
  10947. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10948. return n;
  10949. } else {
  10950. memcpy(ptr, read_buff_.data(), size);
  10951. read_buff_off_ = size;
  10952. read_buff_content_size_ = static_cast<size_t>(n);
  10953. return static_cast<ssize_t>(size);
  10954. }
  10955. } else {
  10956. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10957. if (n <= 0) {
  10958. if (n == 0) {
  10959. error_ = Error::ConnectionClosed;
  10960. } else {
  10961. error_ = Error::Read;
  10962. }
  10963. }
  10964. return n;
  10965. }
  10966. }
  10967. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10968. if (!wait_writable()) { return -1; }
  10969. // Winsock's send() takes an int length, even on 64-bit Windows
  10970. #ifdef _WIN32
  10971. size =
  10972. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10973. #endif
  10974. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10975. }
  10976. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10977. int &port) const {
  10978. return detail::get_remote_ip_and_port(sock_, ip, port);
  10979. }
  10980. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10981. int &port) const {
  10982. return detail::get_local_ip_and_port(sock_, ip, port);
  10983. }
  10984. inline socket_t SocketStream::socket() const { return sock_; }
  10985. inline time_t SocketStream::duration() const {
  10986. return static_cast<time_t>(
  10987. std::chrono::duration_cast<std::chrono::milliseconds>(
  10988. std::chrono::steady_clock::now() - start_time_)
  10989. .count());
  10990. }
  10991. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10992. read_timeout_sec_ = sec;
  10993. read_timeout_usec_ = usec;
  10994. }
  10995. inline void SocketStream::set_max_timeout(time_t msec) {
  10996. max_timeout_msec_ = msec;
  10997. start_time_ = std::chrono::steady_clock::now();
  10998. }
  10999. inline void
  11000. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11001. read_interrupted_ = std::move(interrupted);
  11002. }
  11003. // Buffer stream implementation
  11004. inline bool BufferStream::is_readable() const { return true; }
  11005. inline bool BufferStream::wait_readable() const { return true; }
  11006. inline bool BufferStream::wait_writable() const { return true; }
  11007. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  11008. #if defined(_MSC_VER) && _MSC_VER < 1910
  11009. auto len_read = buffer._Copy_s(ptr, size, size, position);
  11010. #else
  11011. auto len_read = buffer.copy(ptr, size, position);
  11012. #endif
  11013. position += static_cast<size_t>(len_read);
  11014. return static_cast<ssize_t>(len_read);
  11015. }
  11016. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  11017. buffer.append(ptr, size);
  11018. return static_cast<ssize_t>(size);
  11019. }
  11020. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  11021. int & /*port*/) const {}
  11022. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  11023. int & /*port*/) const {}
  11024. inline socket_t BufferStream::socket() const { return 0; }
  11025. inline time_t BufferStream::duration() const { return 0; }
  11026. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  11027. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  11028. : MatcherBase(pattern) {
  11029. constexpr const char marker[] = "/:";
  11030. // One past the last ending position of a path param substring
  11031. std::size_t last_param_end = 0;
  11032. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11033. // Needed to ensure that parameter names are unique during matcher
  11034. // construction
  11035. // If exceptions are disabled, only last duplicate path
  11036. // parameter will be set
  11037. std::unordered_set<std::string> param_name_set;
  11038. #endif
  11039. while (true) {
  11040. const auto marker_pos = pattern.find(
  11041. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  11042. if (marker_pos == std::string::npos) { break; }
  11043. static_fragments_.push_back(
  11044. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  11045. const auto param_name_start = marker_pos + str_len(marker);
  11046. auto sep_pos = pattern.find(separator, param_name_start);
  11047. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  11048. auto param_name =
  11049. pattern.substr(param_name_start, sep_pos - param_name_start);
  11050. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  11051. if (param_name_set.find(param_name) != param_name_set.cend()) {
  11052. std::string msg = "Encountered path parameter '" + param_name +
  11053. "' multiple times in route pattern '" + pattern + "'.";
  11054. throw std::invalid_argument(msg);
  11055. }
  11056. #endif
  11057. param_names_.push_back(std::move(param_name));
  11058. last_param_end = sep_pos + 1;
  11059. }
  11060. if (last_param_end < pattern.length()) {
  11061. static_fragments_.push_back(pattern.substr(last_param_end));
  11062. }
  11063. }
  11064. inline bool PathParamsMatcher::match(Request &request) const {
  11065. request.matches = std::smatch();
  11066. request.path_params.clear();
  11067. // A pattern without parameters is just a literal path to compare against
  11068. if (param_names_.empty()) { return request.path == pattern(); }
  11069. request.path_params.reserve(param_names_.size());
  11070. // One past the position at which the path matched the pattern last time
  11071. std::size_t starting_pos = 0;
  11072. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  11073. const auto &fragment = static_fragments_[i];
  11074. if (starting_pos + fragment.length() > request.path.length()) {
  11075. return false;
  11076. }
  11077. // Avoid unnecessary allocation by using strncmp instead of substr +
  11078. // comparison
  11079. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  11080. fragment.length()) != 0) {
  11081. return false;
  11082. }
  11083. starting_pos += fragment.length();
  11084. // Should only happen when we have a static fragment after a param
  11085. // Example: '/users/:id/subscriptions'
  11086. // The 'subscriptions' fragment here does not have a corresponding param
  11087. if (i >= param_names_.size()) { continue; }
  11088. auto sep_pos = request.path.find(separator, starting_pos);
  11089. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  11090. const auto &param_name = param_names_[i];
  11091. request.path_params.emplace(
  11092. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  11093. // Mark everything up to '/' as matched
  11094. starting_pos = sep_pos + 1;
  11095. }
  11096. // Returns false if the path is longer than the pattern
  11097. return starting_pos >= request.path.length();
  11098. }
  11099. inline bool RegexMatcher::match(Request &request) const {
  11100. request.path_params.clear();
  11101. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  11102. // a non-match rather than risking a stack overflow in std::regex_match.
  11103. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  11104. return false;
  11105. }
  11106. return std::regex_match(request.path, request.matches, regex_);
  11107. }
  11108. // Enclose IPv6 address in brackets if needed
  11109. inline std::string prepare_host_string(const std::string &host) {
  11110. // Enclose IPv6 address in brackets (but not if already enclosed)
  11111. if (host.find(':') == std::string::npos ||
  11112. (!host.empty() && host[0] == '[')) {
  11113. // IPv4, hostname, or already bracketed IPv6
  11114. return host;
  11115. } else {
  11116. // IPv6 address without brackets
  11117. return "[" + host + "]";
  11118. }
  11119. }
  11120. inline std::string make_host_and_port_string(const std::string &host, int port,
  11121. bool is_ssl) {
  11122. auto result = prepare_host_string(host);
  11123. // Append port if not default
  11124. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  11125. ; // do nothing
  11126. } else {
  11127. result += ":" + std::to_string(port);
  11128. }
  11129. return result;
  11130. }
  11131. // Create "host:port" string always including port number (for CONNECT method)
  11132. inline std::string
  11133. make_host_and_port_string_always_port(const std::string &host, int port) {
  11134. return prepare_host_string(host) + ":" + std::to_string(port);
  11135. }
  11136. // Where a client connects for `host`, as one string: the mapped address or
  11137. // name, or `host` itself.
  11138. inline std::string
  11139. addr_map_target(const std::map<std::string, std::string> &addr_map,
  11140. const std::string &host) {
  11141. std::string connect_host;
  11142. std::string ip;
  11143. apply_addr_map(addr_map, host, connect_host, ip);
  11144. return ip.empty() ? connect_host : ip;
  11145. }
  11146. // Request target of a CONNECT for `host`, with `addr_map` applied.
  11147. inline std::string
  11148. make_connect_request_target(const std::map<std::string, std::string> &addr_map,
  11149. const std::string &host, int port) {
  11150. return make_host_and_port_string_always_port(addr_map_target(addr_map, host),
  11151. port);
  11152. }
  11153. // Value for the Host header a client sends when the caller supplied none.
  11154. // Only the value: callers decide where in their header list it goes.
  11155. inline std::string make_default_host_header_value(const std::string &host,
  11156. int port, bool is_ssl,
  11157. int address_family) {
  11158. if (address_family == AF_UNIX) { return "localhost"; }
  11159. return make_host_and_port_string(host, port, is_ssl);
  11160. }
  11161. inline void add_default_user_agent_header(Request &req) {
  11162. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  11163. if (!req.has_header("User-Agent")) {
  11164. req.set_header("User-Agent",
  11165. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  11166. }
  11167. #else
  11168. (void)req;
  11169. #endif
  11170. }
  11171. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  11172. NormalizedTarget normalize_target(const std::string &host);
  11173. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11174. bool host_matches_no_proxy(const NormalizedTarget &target,
  11175. const std::vector<NoProxyEntry> &entries);
  11176. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11177. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11178. if (prefix_bits == 0) { return true; }
  11179. int full_bytes = prefix_bits / 8;
  11180. int rem_bits = prefix_bits % 8;
  11181. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11182. static_cast<size_t>(full_bytes)) != 0) {
  11183. return false;
  11184. }
  11185. if (rem_bits == 0) { return true; }
  11186. auto i = static_cast<size_t>(full_bytes);
  11187. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11188. return (ip[i] & mask) == (net[i] & mask);
  11189. }
  11190. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11191. if (token.empty()) { return false; }
  11192. if (token == "*") {
  11193. out.kind = NoProxyKind::Wildcard;
  11194. return true;
  11195. }
  11196. auto slash = token.find('/');
  11197. std::string addr_part =
  11198. (slash == std::string::npos) ? token : token.substr(0, slash);
  11199. std::string prefix_part =
  11200. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11201. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11202. // don't silently treat it as a /32 (or /128).
  11203. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11204. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11205. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11206. // when brackets are present.
  11207. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11208. addr_part.back() == ']';
  11209. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11210. if (!bracketed) {
  11211. struct in_addr v4;
  11212. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11213. int prefix = 32;
  11214. if (!prefix_part.empty() &&
  11215. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11216. prefix)) {
  11217. return false;
  11218. }
  11219. out.kind = NoProxyKind::IPv4Cidr;
  11220. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11221. out.prefix_bits = prefix;
  11222. return true;
  11223. }
  11224. }
  11225. struct in6_addr v6;
  11226. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11227. int prefix = 128;
  11228. if (!prefix_part.empty() &&
  11229. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11230. prefix)) {
  11231. return false;
  11232. }
  11233. out.kind = NoProxyKind::IPv6Cidr;
  11234. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11235. out.prefix_bits = prefix;
  11236. return true;
  11237. }
  11238. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11239. // the entry is malformed — don't fall through to the hostname branch.
  11240. if (bracketed) { return false; }
  11241. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11242. if (slash != std::string::npos) { return false; }
  11243. // Port-specific entries (host:port) are not supported.
  11244. if (token.find(':') != std::string::npos) { return false; }
  11245. std::string hostname = case_ignore::to_lower(token);
  11246. while (!hostname.empty() && hostname.front() == '.') {
  11247. hostname.erase(hostname.begin());
  11248. }
  11249. while (!hostname.empty() && hostname.back() == '.') {
  11250. hostname.pop_back();
  11251. }
  11252. if (hostname.empty()) { return false; }
  11253. out.kind = NoProxyKind::HostnameSuffix;
  11254. out.hostname_pattern = std::move(hostname);
  11255. return true;
  11256. }
  11257. inline std::vector<NoProxyEntry>
  11258. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11259. std::vector<NoProxyEntry> entries;
  11260. entries.reserve(patterns.size());
  11261. for (const auto &p : patterns) {
  11262. auto trimmed = trim_copy(p);
  11263. if (trimmed.empty()) { continue; }
  11264. NoProxyEntry entry;
  11265. if (parse_no_proxy_entry(trimmed, entry)) {
  11266. entries.push_back(std::move(entry));
  11267. }
  11268. }
  11269. return entries;
  11270. }
  11271. inline NormalizedTarget normalize_target(const std::string &host) {
  11272. NormalizedTarget t;
  11273. std::string h = host;
  11274. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11275. h = h.substr(1, h.size() - 2);
  11276. }
  11277. // Strip a single trailing dot so "example.com." canonicalizes to
  11278. // "example.com".
  11279. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11280. t.hostname = case_ignore::to_lower(h);
  11281. if (!t.hostname.empty()) {
  11282. struct in_addr v4;
  11283. struct in6_addr v6;
  11284. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11285. t.is_ipv4 = true;
  11286. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11287. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11288. t.is_ipv6 = true;
  11289. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11290. }
  11291. }
  11292. return t;
  11293. }
  11294. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11295. const std::vector<NoProxyEntry> &entries) {
  11296. if (target.hostname.empty()) { return false; }
  11297. for (const auto &e : entries) {
  11298. switch (e.kind) {
  11299. case NoProxyKind::Wildcard: return true;
  11300. case NoProxyKind::IPv4Cidr:
  11301. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11302. return true;
  11303. }
  11304. break;
  11305. case NoProxyKind::IPv6Cidr:
  11306. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11307. return true;
  11308. }
  11309. break;
  11310. case NoProxyKind::HostnameSuffix:
  11311. if (target.is_ipv4 || target.is_ipv6) { break; }
  11312. if (target.hostname == e.hostname_pattern) { return true; }
  11313. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11314. // an entry of "example.com".
  11315. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11316. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11317. if (target.hostname[offset - 1] == '.' &&
  11318. target.hostname.compare(offset, e.hostname_pattern.size(),
  11319. e.hostname_pattern) == 0) {
  11320. return true;
  11321. }
  11322. }
  11323. break;
  11324. }
  11325. }
  11326. return false;
  11327. }
  11328. template <typename T>
  11329. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11330. T header_writer, Error &error) {
  11331. for (const auto &h : headers) {
  11332. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11333. error = Error::InvalidHeaders;
  11334. return false;
  11335. }
  11336. }
  11337. if (header_writer(strm, headers) <= 0) {
  11338. error = Error::Write;
  11339. return false;
  11340. }
  11341. return true;
  11342. }
  11343. } // namespace detail
  11344. /*
  11345. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11346. */
  11347. #ifdef CPPHTTPLIB_SSL_ENABLED
  11348. namespace detail {
  11349. // SSL socket stream implementation
  11350. inline SSLSocketStream::SSLSocketStream(
  11351. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11352. time_t read_timeout_usec, time_t write_timeout_sec,
  11353. time_t write_timeout_usec, time_t max_timeout_msec,
  11354. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11355. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11356. read_timeout_usec_(read_timeout_usec),
  11357. write_timeout_sec_(write_timeout_sec),
  11358. write_timeout_usec_(write_timeout_usec),
  11359. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11360. tls_error_.code = tls::ErrorCode::Success;
  11361. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11362. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11363. // Note: create_session() also clears this, but SSLClient currently
  11364. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11365. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11366. // SSL session was created.
  11367. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11368. #endif
  11369. }
  11370. inline SSLSocketStream::~SSLSocketStream() = default;
  11371. inline bool SSLSocketStream::is_readable() const {
  11372. return tls::pending(session_) > 0;
  11373. }
  11374. inline bool SSLSocketStream::wait_readable() const {
  11375. if (max_timeout_msec_ <= 0) {
  11376. return select_read_interruptible(sock_, read_timeout_sec_,
  11377. read_timeout_usec_, read_interrupted_) > 0;
  11378. }
  11379. time_t read_timeout_sec;
  11380. time_t read_timeout_usec;
  11381. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11382. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11383. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11384. read_interrupted_) > 0;
  11385. }
  11386. inline bool SSLSocketStream::wait_writable() const {
  11387. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11388. !tls::is_peer_closed(session_, sock_);
  11389. }
  11390. inline bool SSLSocketStream::ensure_readable() {
  11391. if (readable_hint_) {
  11392. readable_hint_ = false;
  11393. return true;
  11394. }
  11395. return wait_readable();
  11396. }
  11397. inline bool SSLSocketStream::is_peer_alive() const {
  11398. return !tls::is_peer_closed(session_, sock_);
  11399. }
  11400. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11401. if (tls::pending(session_) > 0) {
  11402. tls::TlsError err;
  11403. auto ret = tls::read(session_, ptr, size, err);
  11404. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11405. error_ = Error::ConnectionClosed;
  11406. } else if (ret < 0) {
  11407. tls_error_ = err;
  11408. }
  11409. return ret;
  11410. } else if (ensure_readable()) {
  11411. tls::TlsError err;
  11412. auto ret = tls::read(session_, ptr, size, err);
  11413. if (ret < 0) {
  11414. auto n = 1000;
  11415. #ifdef _WIN32
  11416. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11417. (err.code == tls::ErrorCode::SyscallError &&
  11418. WSAGetLastError() == WSAETIMEDOUT))) {
  11419. #else
  11420. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11421. #endif
  11422. if (tls::pending(session_) > 0) {
  11423. ret = tls::read(session_, ptr, size, err);
  11424. if (ret >= 0) { return ret; }
  11425. break;
  11426. } else if (wait_readable()) {
  11427. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11428. ret = tls::read(session_, ptr, size, err);
  11429. if (ret >= 0) { return ret; }
  11430. } else {
  11431. break;
  11432. }
  11433. }
  11434. assert(ret < 0);
  11435. tls_error_ = err;
  11436. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11437. error_ = Error::ConnectionClosed;
  11438. }
  11439. return ret;
  11440. } else {
  11441. error_ = Error::Timeout;
  11442. return -1;
  11443. }
  11444. }
  11445. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11446. if (wait_writable()) {
  11447. auto handle_size =
  11448. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11449. tls::TlsError err;
  11450. auto ret = tls::write(session_, ptr, handle_size, err);
  11451. if (ret < 0) {
  11452. auto n = 1000;
  11453. #ifdef _WIN32
  11454. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11455. (err.code == tls::ErrorCode::SyscallError &&
  11456. WSAGetLastError() == WSAETIMEDOUT))) {
  11457. #else
  11458. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11459. #endif
  11460. if (wait_writable()) {
  11461. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11462. ret = tls::write(session_, ptr, handle_size, err);
  11463. if (ret >= 0) { return ret; }
  11464. } else {
  11465. break;
  11466. }
  11467. }
  11468. assert(ret < 0);
  11469. tls_error_ = err;
  11470. }
  11471. return ret;
  11472. }
  11473. return -1;
  11474. }
  11475. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11476. int &port) const {
  11477. detail::get_remote_ip_and_port(sock_, ip, port);
  11478. }
  11479. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11480. int &port) const {
  11481. detail::get_local_ip_and_port(sock_, ip, port);
  11482. }
  11483. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11484. inline time_t SSLSocketStream::duration() const {
  11485. return static_cast<time_t>(
  11486. std::chrono::duration_cast<std::chrono::milliseconds>(
  11487. std::chrono::steady_clock::now() - start_time_)
  11488. .count());
  11489. }
  11490. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11491. read_timeout_sec_ = sec;
  11492. read_timeout_usec_ = usec;
  11493. }
  11494. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11495. max_timeout_msec_ = msec;
  11496. start_time_ = std::chrono::steady_clock::now();
  11497. }
  11498. inline void
  11499. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11500. read_interrupted_ = std::move(interrupted);
  11501. }
  11502. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11503. tls::session_t session,
  11504. time_t read_timeout_sec,
  11505. time_t read_timeout_usec,
  11506. time_t write_timeout_sec,
  11507. time_t write_timeout_usec)
  11508. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11509. read_timeout_usec_(read_timeout_usec),
  11510. write_timeout_sec_(write_timeout_sec),
  11511. write_timeout_usec_(write_timeout_usec),
  11512. start_time_(std::chrono::steady_clock::now()) {
  11513. // The receive and send paths run on different threads, so each TLS call is
  11514. // driven in non-blocking mode and readiness is awaited with select()
  11515. // outside the session lock. Set the socket non-blocking once here; it is
  11516. // never flipped back, so no thread races on the flag.
  11517. detail::set_nonblocking(sock_, true);
  11518. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11519. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11520. #endif
  11521. }
  11522. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11523. inline bool WebSocketSSLStream::is_readable() const {
  11524. std::lock_guard<std::mutex> guard(session_mutex_);
  11525. return tls::pending(session_) > 0;
  11526. }
  11527. inline bool WebSocketSSLStream::wait_readable() const {
  11528. return select_read_interruptible(sock_, read_timeout_sec_, read_timeout_usec_,
  11529. read_interrupted_) > 0;
  11530. }
  11531. inline bool WebSocketSSLStream::wait_writable() const {
  11532. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11533. // that probe toggles the socket's blocking flag, which would race with the
  11534. // concurrent reader on a permanently non-blocking socket.
  11535. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11536. }
  11537. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11538. tls::TlsError err;
  11539. auto n = 1000;
  11540. while (--n >= 0) {
  11541. {
  11542. std::lock_guard<std::mutex> guard(session_mutex_);
  11543. auto ret = tls::read(session_, ptr, size, err);
  11544. if (ret > 0) { return ret; }
  11545. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11546. error_ = Error::ConnectionClosed;
  11547. return ret;
  11548. }
  11549. }
  11550. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11551. // direction: the send path shares this session, so output it left pending
  11552. // has to be flushed before more input can be decrypted. Anything else is
  11553. // a hard error.
  11554. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11555. #ifdef _WIN32
  11556. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11557. needs_readable =
  11558. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11559. WSAGetLastError() == WSAETIMEDOUT);
  11560. #endif
  11561. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11562. error_ = Error::Read;
  11563. return -1;
  11564. }
  11565. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11566. error_ = Error::Timeout;
  11567. return -1;
  11568. }
  11569. }
  11570. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11571. // to tell a timeout from a close would otherwise see whatever the previous
  11572. // failure left behind (error_ is never cleared on success).
  11573. error_ = Error::Read;
  11574. return -1;
  11575. }
  11576. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11577. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11578. tls::TlsError err;
  11579. auto n = 1000;
  11580. while (--n >= 0) {
  11581. {
  11582. std::lock_guard<std::mutex> guard(session_mutex_);
  11583. auto ret = tls::write(session_, ptr, handle_size, err);
  11584. if (ret >= 0) { return ret; }
  11585. }
  11586. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11587. // or a post-handshake message must be consumed before the record goes
  11588. // out. Anything else is a hard error.
  11589. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11590. #ifdef _WIN32
  11591. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11592. needs_writable =
  11593. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11594. WSAGetLastError() == WSAETIMEDOUT);
  11595. #endif
  11596. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11597. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11598. }
  11599. return -1;
  11600. }
  11601. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11602. int &port) const {
  11603. detail::get_remote_ip_and_port(sock_, ip, port);
  11604. }
  11605. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11606. int &port) const {
  11607. detail::get_local_ip_and_port(sock_, ip, port);
  11608. }
  11609. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11610. inline time_t WebSocketSSLStream::duration() const {
  11611. return static_cast<time_t>(
  11612. std::chrono::duration_cast<std::chrono::milliseconds>(
  11613. std::chrono::steady_clock::now() - start_time_)
  11614. .count());
  11615. }
  11616. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11617. read_timeout_sec_ = sec;
  11618. read_timeout_usec_ = usec;
  11619. }
  11620. inline void
  11621. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11622. read_interrupted_ = std::move(interrupted);
  11623. }
  11624. } // namespace detail
  11625. #endif // CPPHTTPLIB_SSL_ENABLED
  11626. /*
  11627. * Group 4: Server implementation
  11628. */
  11629. // HTTP server implementation
  11630. inline Server::Server()
  11631. : new_task_queue([] {
  11632. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11633. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11634. }) {
  11635. #ifndef _WIN32
  11636. signal(SIGPIPE, SIG_IGN);
  11637. #endif
  11638. }
  11639. inline Server::~Server() = default;
  11640. inline std::unique_ptr<detail::MatcherBase>
  11641. Server::make_matcher(const std::string &pattern) {
  11642. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11643. // a path params pattern
  11644. if (pattern.find("/:") != std::string::npos) {
  11645. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11646. }
  11647. // A pattern with no regex metacharacter only has to be compared literally,
  11648. // which is what PathParamsMatcher already does when it captures no
  11649. // parameter, so std::regex is only worth building for the patterns that
  11650. // actually need it
  11651. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11652. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11653. }
  11654. return detail::make_unique<detail::RegexMatcher>(pattern);
  11655. }
  11656. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11657. return add_handler(get_handlers_, pattern, std::move(handler));
  11658. }
  11659. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11660. return add_handler(post_handlers_, pattern, std::move(handler));
  11661. }
  11662. inline Server &Server::Post(const std::string &pattern,
  11663. HandlerWithContentReader handler) {
  11664. return add_handler(post_handlers_for_content_reader_, pattern,
  11665. std::move(handler));
  11666. }
  11667. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11668. return add_handler(put_handlers_, pattern, std::move(handler));
  11669. }
  11670. inline Server &Server::Put(const std::string &pattern,
  11671. HandlerWithContentReader handler) {
  11672. return add_handler(put_handlers_for_content_reader_, pattern,
  11673. std::move(handler));
  11674. }
  11675. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11676. return add_handler(patch_handlers_, pattern, std::move(handler));
  11677. }
  11678. inline Server &Server::Patch(const std::string &pattern,
  11679. HandlerWithContentReader handler) {
  11680. return add_handler(patch_handlers_for_content_reader_, pattern,
  11681. std::move(handler));
  11682. }
  11683. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11684. return add_handler(delete_handlers_, pattern, std::move(handler));
  11685. }
  11686. inline Server &Server::Delete(const std::string &pattern,
  11687. HandlerWithContentReader handler) {
  11688. return add_handler(delete_handlers_for_content_reader_, pattern,
  11689. std::move(handler));
  11690. }
  11691. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11692. return add_handler(options_handlers_, pattern, std::move(handler));
  11693. }
  11694. inline const std::set<std::string> &Server::builtin_methods() {
  11695. thread_local const std::set<std::string> methods{
  11696. "GET", "HEAD", "POST", "PUT", "DELETE",
  11697. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11698. return methods;
  11699. }
  11700. inline Server::CustomHandlerEntry *
  11701. Server::custom_entry_for_registration(const std::string &method) {
  11702. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11703. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11704. // routing() before the custom tables are consulted, so a route registered
  11705. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11706. // there and would be reachable, but they carry protocol-level meaning
  11707. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11708. // library does not route.
  11709. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11710. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11711. has_invalid_registration_ = true;
  11712. return nullptr;
  11713. }
  11714. return &custom_handlers_[method];
  11715. }
  11716. inline Server &Server::CustomRoute(const std::string &method,
  11717. const std::string &pattern,
  11718. Handler handler) {
  11719. auto *entry = custom_entry_for_registration(method);
  11720. if (!entry) { return *this; }
  11721. return add_handler(entry->handlers, pattern, std::move(handler));
  11722. }
  11723. inline Server &Server::CustomRoute(const std::string &method,
  11724. const std::string &pattern,
  11725. HandlerWithContentReader handler) {
  11726. auto *entry = custom_entry_for_registration(method);
  11727. if (!entry) { return *this; }
  11728. return add_handler(entry->handlers_for_content_reader, pattern,
  11729. std::move(handler));
  11730. }
  11731. inline const Server::CustomHandlerEntry *
  11732. Server::find_custom_entry(const std::string &method) const {
  11733. // find() alone would be correct here. The empty() check is what keeps the
  11734. // per-request cost off servers that never call CustomRoute(), which is the
  11735. // overwhelmingly common case; keep it rather than walking into the tree.
  11736. if (custom_handlers_.empty()) { return nullptr; }
  11737. auto it = custom_handlers_.find(method);
  11738. return it == custom_handlers_.end() ? nullptr : &it->second;
  11739. }
  11740. inline Server &Server::WebSocket(const std::string &pattern,
  11741. WebSocketHandler handler) {
  11742. websocket_handlers_.push_back(
  11743. {make_matcher(pattern), std::move(handler), nullptr});
  11744. return *this;
  11745. }
  11746. inline Server &Server::WebSocket(const std::string &pattern,
  11747. WebSocketHandler handler,
  11748. SubProtocolSelector sub_protocol_selector) {
  11749. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11750. std::move(sub_protocol_selector)});
  11751. return *this;
  11752. }
  11753. inline bool Server::set_base_dir(const std::string &dir,
  11754. const std::string &mount_point) {
  11755. return set_mount_point(mount_point, dir);
  11756. }
  11757. inline bool Server::set_mount_point(const std::string &mount_point,
  11758. const std::string &dir, Headers headers) {
  11759. detail::FileStat stat(dir);
  11760. if (stat.is_dir()) {
  11761. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11762. if (!mnt.empty() && mnt[0] == '/') {
  11763. // Without the resolved directory, a file could not be checked to be
  11764. // inside it.
  11765. std::string resolved_base;
  11766. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11767. return false;
  11768. }
  11769. #if defined(_WIN32)
  11770. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11771. resolved_base += '\\';
  11772. }
  11773. #else
  11774. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11775. #endif
  11776. base_dirs_.push_back(
  11777. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11778. return true;
  11779. }
  11780. }
  11781. return false;
  11782. }
  11783. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11784. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11785. if (it->mount_point == mount_point) {
  11786. base_dirs_.erase(it);
  11787. return true;
  11788. }
  11789. }
  11790. return false;
  11791. }
  11792. inline Server &
  11793. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11794. const std::string &mime) {
  11795. // Keyed as find_content_type() looks it up
  11796. auto key = detail::case_ignore::to_lower(ext);
  11797. if (!key.empty() && key[0] == '.') { key.erase(0, 1); }
  11798. file_extension_and_mimetype_map_[key] = mime;
  11799. return *this;
  11800. }
  11801. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11802. default_file_mimetype_ = mime;
  11803. return *this;
  11804. }
  11805. inline Server &Server::set_file_request_handler(Handler handler) {
  11806. file_request_handler_ = std::move(handler);
  11807. return *this;
  11808. }
  11809. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11810. std::true_type) {
  11811. error_handler_ = std::move(handler);
  11812. return *this;
  11813. }
  11814. inline Server &Server::set_error_handler_core(Handler handler,
  11815. std::false_type) {
  11816. error_handler_ = [handler](const Request &req, Response &res) {
  11817. handler(req, res);
  11818. return HandlerResponse::Handled;
  11819. };
  11820. return *this;
  11821. }
  11822. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11823. exception_handler_ = std::move(handler);
  11824. return *this;
  11825. }
  11826. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11827. pre_routing_handler_ = std::move(handler);
  11828. return *this;
  11829. }
  11830. inline Server &Server::set_post_routing_handler(Handler handler) {
  11831. post_routing_handler_ = std::move(handler);
  11832. return *this;
  11833. }
  11834. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11835. pre_request_handler_ = std::move(handler);
  11836. return *this;
  11837. }
  11838. inline Server &Server::set_logger(Logger logger) {
  11839. logger_ = std::move(logger);
  11840. return *this;
  11841. }
  11842. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11843. error_logger_ = std::move(error_logger);
  11844. return *this;
  11845. }
  11846. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11847. pre_compression_logger_ = std::move(logger);
  11848. return *this;
  11849. }
  11850. inline Server &
  11851. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11852. expect_100_continue_handler_ = std::move(handler);
  11853. return *this;
  11854. }
  11855. inline Server &Server::set_start_handler(StartHandler handler) {
  11856. start_handler_ = std::move(handler);
  11857. return *this;
  11858. }
  11859. inline Server &Server::set_address_family(int family) {
  11860. address_family_ = family;
  11861. return *this;
  11862. }
  11863. inline Server &Server::set_tcp_nodelay(bool on) {
  11864. tcp_nodelay_ = on;
  11865. return *this;
  11866. }
  11867. inline Server &Server::set_ipv6_v6only(bool on) {
  11868. ipv6_v6only_ = on;
  11869. return *this;
  11870. }
  11871. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11872. socket_options_ = std::move(socket_options);
  11873. return *this;
  11874. }
  11875. inline Server &Server::set_default_headers(Headers headers) {
  11876. default_headers_ = std::move(headers);
  11877. return *this;
  11878. }
  11879. inline Server &Server::set_header_writer(
  11880. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11881. header_writer_ = writer;
  11882. return *this;
  11883. }
  11884. inline Server &
  11885. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11886. trusted_proxies_.clear();
  11887. trusted_proxies_.reserve(proxies.size());
  11888. for (const auto &proxy : proxies) {
  11889. trusted_proxies_.push_back(detail::canonical_ip(proxy));
  11890. }
  11891. return *this;
  11892. }
  11893. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11894. keep_alive_max_count_ = count;
  11895. return *this;
  11896. }
  11897. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11898. keep_alive_timeout_sec_ = sec;
  11899. return *this;
  11900. }
  11901. template <class Rep, class Period>
  11902. inline Server &Server::set_keep_alive_timeout(
  11903. const std::chrono::duration<Rep, Period> &duration) {
  11904. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11905. set_keep_alive_timeout(sec);
  11906. });
  11907. return *this;
  11908. }
  11909. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11910. read_timeout_sec_ = sec;
  11911. read_timeout_usec_ = usec;
  11912. return *this;
  11913. }
  11914. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11915. write_timeout_sec_ = sec;
  11916. write_timeout_usec_ = usec;
  11917. return *this;
  11918. }
  11919. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11920. idle_interval_sec_ = sec;
  11921. idle_interval_usec_ = usec;
  11922. return *this;
  11923. }
  11924. inline Server &Server::set_payload_max_length(size_t length) {
  11925. payload_max_length_ = length;
  11926. return *this;
  11927. }
  11928. inline Server &Server::set_compress(bool on) {
  11929. compress_ = on;
  11930. return *this;
  11931. }
  11932. inline Server &Server::set_static_file_compression(bool on) {
  11933. static_file_compression_ = on;
  11934. return *this;
  11935. }
  11936. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11937. static_file_compression_min_length_ = length;
  11938. return *this;
  11939. }
  11940. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11941. static_file_compression_max_length_ = length;
  11942. return *this;
  11943. }
  11944. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11945. websocket_max_missed_pongs_ = count;
  11946. return *this;
  11947. }
  11948. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11949. websocket_ping_interval_sec_ = sec;
  11950. return *this;
  11951. }
  11952. template <class Rep, class Period>
  11953. inline Server &Server::set_websocket_ping_interval(
  11954. const std::chrono::duration<Rep, Period> &duration) {
  11955. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11956. set_websocket_ping_interval(sec);
  11957. });
  11958. return *this;
  11959. }
  11960. inline bool Server::bind_to_port(const std::string &host, int port,
  11961. int socket_flags) {
  11962. auto ret = bind_internal(host, port, socket_flags);
  11963. if (ret == -1) { is_decommissioned = true; }
  11964. return ret >= 0;
  11965. }
  11966. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11967. auto ret = bind_internal(host, 0, socket_flags);
  11968. if (ret == -1) { is_decommissioned = true; }
  11969. return ret;
  11970. }
  11971. inline bool Server::listen_after_bind() { return listen_internal(); }
  11972. inline bool Server::listen(const std::string &host, int port,
  11973. int socket_flags) {
  11974. return bind_to_port(host, port, socket_flags) && listen_internal();
  11975. }
  11976. inline bool Server::is_running() const { return is_running_; }
  11977. inline void Server::wait_until_ready() const {
  11978. while (!is_running_ && !is_decommissioned) {
  11979. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11980. }
  11981. }
  11982. inline void Server::stop() noexcept {
  11983. // Release the listening socket whether or not the accept loop is running:
  11984. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11985. // exchange is what makes this safe to call concurrently with the accept loop.
  11986. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11987. if (sock != INVALID_SOCKET) {
  11988. detail::shutdown_socket(sock);
  11989. detail::close_socket(sock);
  11990. }
  11991. is_decommissioned = false;
  11992. }
  11993. inline void Server::decommission() { is_decommissioned = true; }
  11994. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11995. auto len = strlen(s);
  11996. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11997. len -= 2;
  11998. {
  11999. // RFC 9112 §3: exactly one SP between the method, the target and the
  12000. // version. Taking other whitespace as a separator too lets recipients
  12001. // that parse more strictly see a different request.
  12002. auto end = s + len;
  12003. if (std::count(s, end, ' ') != 2) { return false; }
  12004. auto sp1 = std::find(s, end, ' ');
  12005. auto sp2 = std::find(sp1 + 1, end, ' ');
  12006. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  12007. req.method.assign(s, sp1);
  12008. req.target.assign(sp1 + 1, sp2);
  12009. req.version.assign(sp2 + 1, end);
  12010. }
  12011. // A method outside the built-in set is accepted only when a handler has been
  12012. // registered for it with CustomRoute().
  12013. const auto &methods = builtin_methods();
  12014. if (methods.find(req.method) == methods.end() &&
  12015. !find_custom_entry(req.method)) {
  12016. output_error_log(Error::InvalidHTTPMethod, &req);
  12017. return false;
  12018. }
  12019. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  12020. output_error_log(Error::InvalidHTTPVersion, &req);
  12021. return false;
  12022. }
  12023. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  12024. // would leave this server routing a different path than a cache or a
  12025. // filter in front of it sees.
  12026. if (!detail::fields::is_request_target(req.target) ||
  12027. req.target.find('#') != std::string::npos) {
  12028. return false;
  12029. }
  12030. {
  12031. detail::divide(req.target, '?',
  12032. [&](const char *lhs_data, std::size_t lhs_size,
  12033. const char *rhs_data, std::size_t rhs_size) {
  12034. req.path =
  12035. decode_path_component(std::string(lhs_data, lhs_size));
  12036. detail::parse_query_text(rhs_data, rhs_size, req.params);
  12037. });
  12038. }
  12039. return true;
  12040. }
  12041. inline bool Server::write_response(Stream &strm, bool close_connection,
  12042. Request &req, Response &res) {
  12043. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  12044. // incorrectly to the error content.
  12045. req.ranges.clear();
  12046. return write_response_core(strm, close_connection, req, res, false);
  12047. }
  12048. inline bool Server::write_response_with_content(Stream &strm,
  12049. bool close_connection,
  12050. const Request &req,
  12051. Response &res) {
  12052. return write_response_core(strm, close_connection, req, res, true);
  12053. }
  12054. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  12055. const Request &req, Response &res,
  12056. bool need_apply_ranges) {
  12057. assert(res.status != -1);
  12058. if (400 <= res.status && error_handler_ &&
  12059. error_handler_(req, res) == HandlerResponse::Handled) {
  12060. need_apply_ranges = true;
  12061. }
  12062. // Before anything below reads res.headers, which the handlers may have
  12063. // filled directly
  12064. detail::erase_invalid_fields(res.headers);
  12065. if (!detail::body_allowed_for_status(res.status)) {
  12066. detail::clear_content(res);
  12067. }
  12068. detail::prefer_assigned_body(res);
  12069. std::string content_type;
  12070. std::string boundary;
  12071. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  12072. // Prepare additional headers
  12073. if (close_connection ||
  12074. detail::has_header_token(req.headers, "Connection", "close") ||
  12075. 400 <= res.status || // Don't leave connections open after errors
  12076. // The client withholds the body until `100 Continue`, which was never
  12077. // sent, so whether and when the body follows is unknown.
  12078. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  12079. // The body was left partway, e.g. by a content receiver that returned
  12080. // false, so the rest of it cannot be told from the next request.
  12081. (req.body_read_started_ && !req.body_consumed_)) {
  12082. res.set_header("Connection", "close");
  12083. } else {
  12084. std::string s = "timeout=";
  12085. s += std::to_string(keep_alive_timeout_sec_);
  12086. if (keep_alive_max_count_ > 0) {
  12087. s += ", max=";
  12088. s += std::to_string(keep_alive_max_count_);
  12089. }
  12090. res.set_header("Keep-Alive", s);
  12091. }
  12092. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  12093. !res.has_header("Content-Type")) {
  12094. res.set_header("Content-Type", "text/plain");
  12095. }
  12096. detail::set_framing_headers(req, res, boundary, content_type);
  12097. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  12098. res.set_header("Accept-Ranges", "bytes");
  12099. }
  12100. if (post_routing_handler_) {
  12101. post_routing_handler_(req, res);
  12102. detail::erase_invalid_fields(res.headers);
  12103. // Again, for a body or framing headers the handler changed.
  12104. detail::set_framing_headers(req, res, boundary, content_type);
  12105. }
  12106. // Response line and headers
  12107. detail::BufferStream bstrm;
  12108. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  12109. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  12110. // Combine a small body with the headers so the whole response leaves in a
  12111. // single write. A large body is written on its own instead: a copy of it
  12112. // costs more than the extra write saves.
  12113. auto send_body =
  12114. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  12115. auto body_is_separate = false;
  12116. auto provider_done = false;
  12117. if (send_body && !res.body.empty() && !res.content_provider_) {
  12118. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  12119. bstrm.write(res.body.data(), res.body.size());
  12120. } else {
  12121. body_is_separate = true;
  12122. }
  12123. } else if (send_body && res.content_provider_ &&
  12124. res.is_file_content_provider_ &&
  12125. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  12126. // A small file is read into the same buffer. Other providers may produce
  12127. // their data over time, so they are never held back.
  12128. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  12129. return false;
  12130. }
  12131. provider_done = true;
  12132. }
  12133. // Log before writing to avoid race condition with client-side code that
  12134. // accesses logger-captured data immediately after receiving the response.
  12135. output_log(req, res);
  12136. // Flush buffer
  12137. auto &data = bstrm.get_buffer();
  12138. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  12139. if (body_is_separate) {
  12140. return detail::write_data(strm, res.body.data(), res.body.size());
  12141. }
  12142. // Streaming body
  12143. if (send_body && res.content_provider_) {
  12144. if (!provider_done &&
  12145. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  12146. return false;
  12147. }
  12148. res.content_provider_success_ = true;
  12149. }
  12150. return true;
  12151. }
  12152. inline bool
  12153. Server::write_content_with_provider(Stream &strm, const Request &req,
  12154. Response &res, const std::string &boundary,
  12155. const std::string &content_type) {
  12156. auto is_shutting_down = [this]() {
  12157. return this->svr_sock_ == INVALID_SOCKET;
  12158. };
  12159. if (res.content_length_ > 0) {
  12160. if (!detail::is_partial_content(req, res)) {
  12161. return detail::write_content(strm, res.content_provider_, 0,
  12162. res.content_length_, is_shutting_down);
  12163. } else if (req.ranges.size() == 1) {
  12164. auto offset_and_length = detail::get_range_offset_and_length(
  12165. req.ranges[0], res.content_length_);
  12166. return detail::write_content(strm, res.content_provider_,
  12167. offset_and_length.first,
  12168. offset_and_length.second, is_shutting_down);
  12169. } else {
  12170. return detail::write_multipart_ranges_data(
  12171. strm, req, res, boundary, content_type, res.content_length_,
  12172. is_shutting_down);
  12173. }
  12174. } else {
  12175. if (res.is_chunked_content_provider_) {
  12176. // Use the coding `apply_ranges()` chose when it wrote the headers;
  12177. // re-negotiating here would disagree with them, e.g. once a handler's
  12178. // own Content-Encoding header suppresses the negotiation.
  12179. auto compressor = detail::make_compressor(res.content_coding_);
  12180. if (!compressor) {
  12181. compressor = detail::make_unique<detail::nocompressor>();
  12182. }
  12183. return detail::write_content_chunked(strm, res.content_provider_,
  12184. is_shutting_down, *compressor);
  12185. } else {
  12186. return detail::write_content_without_length(strm, res.content_provider_,
  12187. is_shutting_down);
  12188. }
  12189. }
  12190. }
  12191. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12192. FormFields::iterator cur_field;
  12193. FormFiles::iterator cur_file;
  12194. auto is_text_field = false;
  12195. size_t count = 0;
  12196. if (read_content_core(
  12197. strm, req, res,
  12198. // Regular
  12199. [&](const char *buf, size_t n) {
  12200. // Prevent arithmetic overflow when checking sizes.
  12201. // Avoid computing (req.body.size() + n) directly because
  12202. // adding two unsigned `size_t` values can wrap around and
  12203. // produce a small result instead of indicating overflow.
  12204. // Instead, check using subtraction: ensure `n` does not
  12205. // exceed the remaining capacity `max_size() - size()`.
  12206. if (req.body.size() >= req.body.max_size() ||
  12207. n > req.body.max_size() - req.body.size()) {
  12208. return false;
  12209. }
  12210. // Limit decompressed body size to payload_max_length_ to protect
  12211. // against "zip bomb" attacks where a small compressed payload
  12212. // decompresses to a massive size.
  12213. if (payload_max_length_ > 0 &&
  12214. (req.body.size() >= payload_max_length_ ||
  12215. n > payload_max_length_ - req.body.size())) {
  12216. return false;
  12217. }
  12218. req.body.append(buf, n);
  12219. return true;
  12220. },
  12221. // Multipart FormData
  12222. [&](const FormData &file) {
  12223. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12224. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12225. output_error_log(Error::TooManyFormDataFiles, &req);
  12226. return false;
  12227. }
  12228. if (file.filename.empty()) {
  12229. cur_field = req.form.fields.emplace(
  12230. file.name, FormField{file.name, file.content, file.headers});
  12231. is_text_field = true;
  12232. } else {
  12233. cur_file = req.form.files.emplace(file.name, file);
  12234. is_text_field = false;
  12235. }
  12236. return true;
  12237. },
  12238. [&](const char *buf, size_t n) {
  12239. if (is_text_field) {
  12240. auto &content = cur_field->second.content;
  12241. if (content.size() + n > content.max_size()) { return false; }
  12242. content.append(buf, n);
  12243. } else {
  12244. auto &content = cur_file->second.content;
  12245. if (content.size() + n > content.max_size()) { return false; }
  12246. content.append(buf, n);
  12247. }
  12248. return true;
  12249. })) {
  12250. const auto &content_type = req.get_header_value("Content-Type");
  12251. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12252. "application/x-www-form-urlencoded")) {
  12253. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12254. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12255. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12256. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12257. return false;
  12258. }
  12259. detail::parse_query_text(req.body, req.params);
  12260. }
  12261. return true;
  12262. }
  12263. return false;
  12264. }
  12265. inline bool Server::read_content_with_content_receiver(
  12266. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12267. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12268. return read_content_core(strm, req, res, std::move(receiver),
  12269. std::move(multipart_header),
  12270. std::move(multipart_receiver));
  12271. }
  12272. inline bool Server::read_content_core(
  12273. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12274. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12275. detail::FormDataParser multipart_form_data_parser;
  12276. ContentReceiverWithProgress out;
  12277. if (req.is_multipart_form_data()) {
  12278. const auto &content_type = req.get_header_value("Content-Type");
  12279. std::string boundary;
  12280. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12281. res.status = StatusCode::BadRequest_400;
  12282. output_error_log(Error::MultipartParsing, &req);
  12283. return false;
  12284. }
  12285. multipart_form_data_parser.set_boundary(std::move(boundary));
  12286. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12287. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12288. multipart_receiver);
  12289. };
  12290. } else {
  12291. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12292. size_t /*len*/) { return receiver(buf, n); };
  12293. }
  12294. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12295. if (!req.has_header("Content-Length") &&
  12296. !detail::is_chunked_transfer_encoding(req.headers)) {
  12297. return true;
  12298. }
  12299. // A second read would start where the first one stopped, or in the next
  12300. // request.
  12301. if (req.body_read_started_) { return false; }
  12302. // The client is waiting for this before it sends the body.
  12303. if (req.expect_100_continue_pending_) {
  12304. req.expect_100_continue_pending_ = false;
  12305. detail::write_response_line(strm, StatusCode::Continue_100);
  12306. strm.write("\r\n");
  12307. }
  12308. // Set before reading, since a receiver may also stop by throwing.
  12309. req.body_read_started_ = true;
  12310. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12311. out, true)) {
  12312. return false;
  12313. }
  12314. req.body_consumed_ = true;
  12315. if (req.is_multipart_form_data()) {
  12316. if (!multipart_form_data_parser.is_valid()) {
  12317. res.status = StatusCode::BadRequest_400;
  12318. output_error_log(Error::MultipartParsing, &req);
  12319. return false;
  12320. }
  12321. }
  12322. return true;
  12323. }
  12324. inline bool Server::handle_file_request(Request &req, Response &res) {
  12325. if (!detail::is_valid_path(req.path)) { return false; }
  12326. for (const auto &entry : base_dirs_) {
  12327. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12328. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12329. // One that already ends in '/' (the root mount among them) carries its own
  12330. // boundary; set_mount_point() guarantees the mount point is not empty.
  12331. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12332. (entry.mount_point.back() == '/' ||
  12333. req.path.size() == entry.mount_point.size() ||
  12334. req.path[entry.mount_point.size()] == '/')) {
  12335. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12336. auto path = entry.base_dir + sub_path;
  12337. if (path.back() == '/') { path += "index.html"; }
  12338. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12339. // but symlinks/junctions can still escape the base directory. A path
  12340. // that cannot be resolved, which includes one that does not exist, is
  12341. // not served from here.
  12342. std::string resolved_path;
  12343. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12344. if (!detail::is_path_within_base(resolved_path,
  12345. entry.resolved_base_dir)) {
  12346. res.status = StatusCode::Forbidden_403;
  12347. return true;
  12348. }
  12349. detail::FileStat stat(path);
  12350. if (stat.is_dir()) {
  12351. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12352. // in the name from reading as a scheme.
  12353. auto name = req.path.substr(req.path.rfind('/') + 1);
  12354. res.set_redirect("./" + encode_path_component(name) + "/",
  12355. StatusCode::MovedPermanently_301);
  12356. return true;
  12357. }
  12358. if (stat.is_file()) {
  12359. for (const auto &kv : entry.headers) {
  12360. res.set_header(kv.first, kv.second);
  12361. }
  12362. auto content_type = detail::find_content_type(
  12363. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12364. auto encoding = detail::EncodingType::None;
  12365. if (static_file_compression_) {
  12366. encoding = static_file_encoding(req, res, content_type, stat.size());
  12367. }
  12368. // The ETag names the representation actually sent, so a client that
  12369. // cached the compressed form revalidates against the compressed ETag
  12370. // and still gets a 304, while one that took identity keeps the plain
  12371. // ETag.
  12372. auto etag = detail::compute_etag(
  12373. stat, encoding == detail::EncodingType::None
  12374. ? std::string()
  12375. : std::string("-") + detail::encoding_name(encoding));
  12376. if (!etag.empty()) { res.set_header("ETag", etag); }
  12377. auto mtime = stat.mtime();
  12378. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12379. if (!last_modified.empty()) {
  12380. res.set_header("Last-Modified", last_modified);
  12381. }
  12382. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12383. check_if_range(req, etag, mtime);
  12384. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12385. if (!mm->is_open()) {
  12386. output_error_log(Error::OpenFile, &req);
  12387. return false;
  12388. }
  12389. detail::set_file_content_provider(res, mm, content_type, encoding);
  12390. if (req.method != "HEAD" && file_request_handler_) {
  12391. file_request_handler_(req, res);
  12392. }
  12393. return true;
  12394. } else {
  12395. output_error_log(Error::OpenFile, &req);
  12396. }
  12397. }
  12398. }
  12399. return false;
  12400. }
  12401. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12402. const std::string &etag,
  12403. time_t mtime) const {
  12404. // Handle conditional GET:
  12405. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12406. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12407. if (req.has_header("If-None-Match")) {
  12408. if (!etag.empty()) {
  12409. auto val =
  12410. detail::get_combined_header_value(req.headers, "If-None-Match");
  12411. // NOTE: We use exact string matching here. This works correctly
  12412. // because our server always generates weak ETags (W/"..."), and
  12413. // clients typically send back the same ETag they received.
  12414. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12415. // If-None-Match, where W/"x" and "x" would match, but this
  12416. // simplified implementation requires exact matches.
  12417. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12418. [&](const char *b, const char *e) {
  12419. auto seg_len = static_cast<size_t>(e - b);
  12420. return (seg_len == 1 && *b == '*') ||
  12421. (seg_len == etag.size() &&
  12422. std::equal(b, e, etag.begin()));
  12423. });
  12424. if (ret) {
  12425. res.status = StatusCode::NotModified_304;
  12426. return true;
  12427. }
  12428. }
  12429. } else if (req.has_header("If-Modified-Since")) {
  12430. auto val = req.get_header_value("If-Modified-Since");
  12431. auto t = detail::parse_http_date(val);
  12432. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12433. res.status = StatusCode::NotModified_304;
  12434. return true;
  12435. }
  12436. }
  12437. return false;
  12438. }
  12439. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12440. time_t mtime) const {
  12441. // Handle If-Range for partial content requests (RFC 9110
  12442. // Section 13.1.5). If-Range is only evaluated when Range header is
  12443. // present. If the validator matches, serve partial content; otherwise
  12444. // serve full content.
  12445. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12446. auto val = req.get_header_value("If-Range");
  12447. auto is_valid_range = [&]() {
  12448. if (detail::is_strong_etag(val)) {
  12449. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12450. // comparison.
  12451. return (!etag.empty() && val == etag);
  12452. } else if (detail::is_weak_etag(val)) {
  12453. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12454. return false;
  12455. } else {
  12456. // HTTP-date comparison
  12457. auto t = detail::parse_http_date(val);
  12458. return (t != static_cast<time_t>(-1) && mtime <= t);
  12459. }
  12460. };
  12461. if (!is_valid_range()) {
  12462. // Validator doesn't match: ignore Range and serve full content
  12463. req.ranges.clear();
  12464. return false;
  12465. }
  12466. }
  12467. return true;
  12468. }
  12469. inline socket_t
  12470. Server::create_server_socket(const std::string &host, int port,
  12471. int socket_flags,
  12472. SocketOptions socket_options) const {
  12473. return detail::create_socket(
  12474. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12475. ipv6_v6only_, std::move(socket_options),
  12476. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12477. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12478. output_error_log(Error::BindIPAddress, nullptr);
  12479. return false;
  12480. }
  12481. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12482. output_error_log(Error::Listen, nullptr);
  12483. return false;
  12484. }
  12485. return true;
  12486. });
  12487. }
  12488. inline int Server::bind_internal(const std::string &host, int port,
  12489. int socket_flags) {
  12490. if (is_decommissioned) { return -1; }
  12491. if (!is_valid()) { return -1; }
  12492. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12493. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12494. if (port == 0) {
  12495. struct sockaddr_storage addr;
  12496. socklen_t addr_len = sizeof(addr);
  12497. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12498. &addr_len) == -1) {
  12499. output_error_log(Error::GetSockName, nullptr);
  12500. return -1;
  12501. }
  12502. if (addr.ss_family == AF_INET) {
  12503. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12504. } else if (addr.ss_family == AF_INET6) {
  12505. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12506. } else {
  12507. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12508. return -1;
  12509. }
  12510. } else {
  12511. return port;
  12512. }
  12513. }
  12514. inline bool Server::listen_internal() {
  12515. // A stop() between bind and listen leaves nothing to accept on. Report
  12516. // failure instead of returning success without ever serving, and mark the
  12517. // server decommissioned the way any failed listen does so that a concurrent
  12518. // wait_until_ready() wakes up instead of spinning forever.
  12519. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12520. is_decommissioned = true;
  12521. return false;
  12522. }
  12523. auto ret = true;
  12524. is_running_ = true;
  12525. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12526. if (start_handler_) { start_handler_(); }
  12527. {
  12528. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12529. while (svr_sock_ != INVALID_SOCKET) {
  12530. #ifndef _WIN32
  12531. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12532. #endif
  12533. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12534. idle_interval_usec_);
  12535. if (val == 0) { // Timeout
  12536. task_queue->on_idle();
  12537. continue;
  12538. }
  12539. #ifndef _WIN32
  12540. }
  12541. #endif
  12542. #if defined _WIN32
  12543. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12544. // OVERLAPPED
  12545. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12546. #elif defined SOCK_CLOEXEC
  12547. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12548. #else
  12549. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12550. #endif
  12551. if (sock == INVALID_SOCKET) {
  12552. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12553. // touches the CRT errno, so the two have to be asked platform by
  12554. // platform rather than by testing errno here.
  12555. if (detail::is_accept_resource_error()) {
  12556. // The per-process descriptor limit or the network stack's buffer
  12557. // space has been reached. Try to accept new connections after a
  12558. // short sleep.
  12559. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12560. continue;
  12561. } else if (detail::is_accept_transient_error()) {
  12562. continue;
  12563. }
  12564. // Take the descriptor out of svr_sock_ before closing it: a later
  12565. // stop() would otherwise shutdown()/close() a value the OS may have
  12566. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12567. // gone. The exchange also settles the race with a concurrent stop(),
  12568. // since whichever side takes the descriptor closes it exactly once.
  12569. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12570. if (listen_sock != INVALID_SOCKET) {
  12571. detail::close_socket(listen_sock);
  12572. ret = false;
  12573. output_error_log(Error::Connection, nullptr);
  12574. } else {
  12575. ; // The server socket was closed by user.
  12576. }
  12577. break;
  12578. }
  12579. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12580. read_timeout_sec_, read_timeout_usec_);
  12581. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12582. write_timeout_sec_, write_timeout_usec_);
  12583. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12584. if (!task_queue->enqueue(
  12585. [this, sock]() { process_and_close_socket(sock); })) {
  12586. output_error_log(Error::ResourceExhaustion, nullptr);
  12587. detail::shutdown_socket(sock);
  12588. detail::close_socket(sock);
  12589. }
  12590. }
  12591. task_queue->shutdown();
  12592. }
  12593. is_decommissioned = !ret;
  12594. return ret;
  12595. }
  12596. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  12597. // Call from a catch block. The response is a 500 unless the exception handler
  12598. // sets another status. Returns whether the exception handler ran.
  12599. inline bool Server::handle_exception(Request &req, Response &res) {
  12600. res.status = StatusCode::InternalServerError_500;
  12601. if (!exception_handler_) { return false; }
  12602. exception_handler_(req, res, std::current_exception());
  12603. return true;
  12604. }
  12605. #endif
  12606. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12607. bool skip_pre_routing) {
  12608. if (!skip_pre_routing && pre_routing_handler_ &&
  12609. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12610. return true;
  12611. }
  12612. // File handler
  12613. if ((req.method == "GET" || req.method == "HEAD") &&
  12614. handle_file_request(req, res)) {
  12615. return true;
  12616. }
  12617. const auto *custom = find_custom_entry(req.method);
  12618. // The second clause mirrors what expect_content() does unconditionally for
  12619. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12620. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12621. // `allprop`) would skip its handler and fall through to 404.
  12622. if (detail::expect_content(req) ||
  12623. (custom && !custom->handlers_for_content_reader.empty())) {
  12624. // Content reader handler
  12625. {
  12626. // Track whether the ContentReader was aborted due to the decompressed
  12627. // payload exceeding `payload_max_length_`.
  12628. // The user handler runs after the lambda returns, so we must restore the
  12629. // 413 status if the handler overwrites it.
  12630. bool content_reader_payload_too_large = false;
  12631. ContentReader reader(
  12632. [&](ContentReceiver receiver) {
  12633. auto result = read_content_with_content_receiver(
  12634. strm, req, res, std::move(receiver), nullptr, nullptr);
  12635. if (!result) {
  12636. output_error_log(Error::Read, &req);
  12637. if (res.status == StatusCode::PayloadTooLarge_413) {
  12638. content_reader_payload_too_large = true;
  12639. }
  12640. }
  12641. return result;
  12642. },
  12643. [&](FormDataHeader header, ContentReceiver receiver) {
  12644. auto result = read_content_with_content_receiver(
  12645. strm, req, res, nullptr, std::move(header),
  12646. std::move(receiver));
  12647. if (!result) {
  12648. output_error_log(Error::Read, &req);
  12649. if (res.status == StatusCode::PayloadTooLarge_413) {
  12650. content_reader_payload_too_large = true;
  12651. }
  12652. }
  12653. return result;
  12654. });
  12655. bool dispatched = false;
  12656. if (req.method == "POST") {
  12657. dispatched = dispatch_request_for_content_reader(
  12658. req, res, std::move(reader), post_handlers_for_content_reader_);
  12659. } else if (req.method == "PUT") {
  12660. dispatched = dispatch_request_for_content_reader(
  12661. req, res, std::move(reader), put_handlers_for_content_reader_);
  12662. } else if (req.method == "PATCH") {
  12663. dispatched = dispatch_request_for_content_reader(
  12664. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12665. } else if (req.method == "DELETE") {
  12666. dispatched = dispatch_request_for_content_reader(
  12667. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12668. } else if (custom) {
  12669. dispatched = dispatch_request_for_content_reader(
  12670. req, res, std::move(reader), custom->handlers_for_content_reader);
  12671. }
  12672. if (dispatched) {
  12673. if (content_reader_payload_too_large) {
  12674. // Enforce the limit: override any status the handler may have set
  12675. // and return false so the error path sends a plain 413 response.
  12676. res.status = StatusCode::PayloadTooLarge_413;
  12677. detail::clear_content(res);
  12678. return false;
  12679. }
  12680. return true;
  12681. }
  12682. }
  12683. // NOTE: `req.body` is not read here. For a regular handler the body is
  12684. // read inside dispatch_request(), after the route has matched and the
  12685. // pre-request handler has approved the request, so that a rejected
  12686. // request (e.g. failed authentication) never forces us to buffer a
  12687. // potentially large body.
  12688. }
  12689. // Regular handler
  12690. if (req.method == "GET" || req.method == "HEAD") {
  12691. return dispatch_request(req, res, get_handlers_, strm);
  12692. } else if (req.method == "POST") {
  12693. return dispatch_request(req, res, post_handlers_, strm);
  12694. } else if (req.method == "PUT") {
  12695. return dispatch_request(req, res, put_handlers_, strm);
  12696. } else if (req.method == "DELETE") {
  12697. return dispatch_request(req, res, delete_handlers_, strm);
  12698. } else if (req.method == "OPTIONS") {
  12699. return dispatch_request(req, res, options_handlers_, strm);
  12700. } else if (req.method == "PATCH") {
  12701. return dispatch_request(req, res, patch_handlers_, strm);
  12702. } else if (custom) {
  12703. return dispatch_request(req, res, custom->handlers, strm);
  12704. }
  12705. res.status = StatusCode::BadRequest_400;
  12706. return false;
  12707. }
  12708. inline bool Server::dispatch_request(Request &req, Response &res,
  12709. const Handlers &handlers, Stream &strm) {
  12710. for (const auto &x : handlers) {
  12711. const auto &matcher = x.first;
  12712. const auto &handler = x.second;
  12713. if (matcher->match(req)) {
  12714. req.matched_route = matcher->pattern();
  12715. // Run the pre-request handler before reading the body so a rejected
  12716. // request (e.g. failed authentication) never forces us to buffer a
  12717. // potentially large body. `req.matched_route` is available here.
  12718. if (pre_request_handler_ &&
  12719. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12720. return true;
  12721. }
  12722. // The route matched and the request was approved; read the body now.
  12723. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12724. output_error_log(Error::Read, &req);
  12725. return false;
  12726. }
  12727. handler(req, res);
  12728. return true;
  12729. }
  12730. }
  12731. return false;
  12732. }
  12733. // Decides the content coding for a response served straight from a file. Both
  12734. // the ETag, which has to name the representation actually sent, and
  12735. // `apply_static_file_compression()` go through this, so the two cannot drift
  12736. // apart.
  12737. inline detail::EncodingType
  12738. Server::static_file_encoding(const Request &req, const Response &res,
  12739. const std::string &content_type,
  12740. size_t length) const {
  12741. if (!static_file_compression_) { return detail::EncodingType::None; }
  12742. // Nothing to compress, and an empty file already answers with
  12743. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12744. // turn an empty body into a 20-byte gzip stream.
  12745. if (length == 0) { return detail::EncodingType::None; }
  12746. // A file that already fits in a single packet gains nothing from being made
  12747. // smaller, since it still travels in that one segment, and a file of a few
  12748. // bytes comes out larger than it went in.
  12749. if (length < static_file_compression_min_length_) {
  12750. return detail::EncodingType::None;
  12751. }
  12752. // RFC 9110 applies Range to the representation after content coding, so a
  12753. // compressed 206 would mean compressing the whole file and then slicing it.
  12754. // Serve ranges from the identity representation instead.
  12755. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12756. if (static_file_compression_max_length_ > 0 &&
  12757. length > static_file_compression_max_length_) {
  12758. return detail::EncodingType::None;
  12759. }
  12760. return detail::encoding_type(req, res, content_type);
  12761. }
  12762. // Compresses a file-backed content provider into `res.body`. Returns false when
  12763. // the response is left untouched.
  12764. inline bool Server::apply_static_file_compression(const Request &req,
  12765. Response &res) const {
  12766. auto type = res.content_coding_;
  12767. if (type == detail::EncodingType::None || !res.content_provider_) {
  12768. return false;
  12769. }
  12770. auto compressor = detail::make_compressor(type);
  12771. if (!compressor) { return false; }
  12772. output_pre_compression_log(req, res);
  12773. std::string compressed;
  12774. if (!detail::compress_content_provider(res.content_provider_,
  12775. res.content_length_, *compressor,
  12776. compressed)) {
  12777. return false;
  12778. }
  12779. res.body.swap(compressed);
  12780. // The provider was consumed in full, so its releaser hears about a success.
  12781. res.content_provider_success_ = true;
  12782. detail::clear_content_provider(res);
  12783. res.set_header("Content-Encoding", detail::encoding_name(type));
  12784. res.set_header("Vary", "Accept-Encoding");
  12785. return true;
  12786. }
  12787. inline void Server::apply_ranges(const Request &req, Response &res,
  12788. std::string &content_type,
  12789. std::string &boundary) const {
  12790. // A known-length content provider leaves `res.body` empty, so the compressor
  12791. // at the end of this function never runs for one (issue #2545). A file-backed
  12792. // provider is fully readable right here, so compress it and answer with an
  12793. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12794. // takes the same path as `set_content()` from here on. Range requests never
  12795. // get a content coding, so `Content-Range` still names identity bytes and
  12796. // none of the range handling below applies.
  12797. if (apply_static_file_compression(req, res)) { return; }
  12798. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12799. auto it = res.headers.find("Content-Type");
  12800. if (it != res.headers.end()) {
  12801. content_type = it->second;
  12802. res.headers.erase(it);
  12803. }
  12804. boundary = detail::make_multipart_data_boundary();
  12805. res.set_header("Content-Type",
  12806. "multipart/byteranges; boundary=" + boundary);
  12807. }
  12808. auto type =
  12809. compress_ ? detail::encoding_type(req, res) : detail::EncodingType::None;
  12810. if (res.body.empty()) {
  12811. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12812. res.status == StatusCode::PartialContent_206) {
  12813. auto offset_and_length = detail::get_range_offset_and_length(
  12814. req.ranges[0], res.content_length_);
  12815. auto content_range = detail::make_content_range_header_field(
  12816. offset_and_length, res.content_length_);
  12817. res.set_header("Content-Range", content_range);
  12818. } else if (res.is_chunked_content_provider_) {
  12819. res.content_coding_ = type;
  12820. if (type != detail::EncodingType::None) {
  12821. res.set_header("Content-Encoding", detail::encoding_name(type));
  12822. res.set_header("Vary", "Accept-Encoding");
  12823. }
  12824. }
  12825. } else {
  12826. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12827. ;
  12828. } else if (req.ranges.size() == 1) {
  12829. auto offset_and_length =
  12830. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12831. auto offset = offset_and_length.first;
  12832. auto length = offset_and_length.second;
  12833. auto content_range = detail::make_content_range_header_field(
  12834. offset_and_length, res.body.size());
  12835. res.set_header("Content-Range", content_range);
  12836. assert(offset + length <= res.body.size());
  12837. res.body = res.body.substr(offset, length);
  12838. } else {
  12839. std::string data;
  12840. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12841. res.body.size(), data);
  12842. res.body.swap(data);
  12843. }
  12844. if (type != detail::EncodingType::None) {
  12845. output_pre_compression_log(req, res);
  12846. if (auto compressor = detail::make_compressor(type)) {
  12847. std::string compressed;
  12848. if (compressor->compress(res.body.data(), res.body.size(), true,
  12849. [&](const char *data, size_t data_len) {
  12850. compressed.append(data, data_len);
  12851. return true;
  12852. })) {
  12853. res.body.swap(compressed);
  12854. res.set_header("Content-Encoding", detail::encoding_name(type));
  12855. res.set_header("Vary", "Accept-Encoding");
  12856. }
  12857. }
  12858. }
  12859. res.content_length_ = res.body.size();
  12860. }
  12861. }
  12862. inline bool Server::dispatch_request_for_content_reader(
  12863. Request &req, Response &res, ContentReader content_reader,
  12864. const HandlersForContentReader &handlers) const {
  12865. for (const auto &x : handlers) {
  12866. const auto &matcher = x.first;
  12867. const auto &handler = x.second;
  12868. if (matcher->match(req)) {
  12869. req.matched_route = matcher->pattern();
  12870. if (!pre_request_handler_ ||
  12871. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12872. handler(req, res, content_reader);
  12873. }
  12874. return true;
  12875. }
  12876. }
  12877. return false;
  12878. }
  12879. inline std::string
  12880. get_client_ip(const std::string &x_forwarded_for,
  12881. const std::vector<std::string> &trusted_proxies) {
  12882. // X-Forwarded-For is a comma-separated list per RFC 7239
  12883. std::vector<std::string> ip_list;
  12884. detail::split(x_forwarded_for.data(),
  12885. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12886. [&](const char *b, const char *e) {
  12887. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12888. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12889. });
  12890. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12891. // no segments. Signal "no client IP derived" with an empty string so the
  12892. // caller can fall back to the connection-level remote address.
  12893. if (ip_list.empty()) { return std::string(); }
  12894. // Each hop appends the address it received the request from, so the rightmost
  12895. // entries are the ones written by our own infrastructure while the leftmost
  12896. // are whatever the original client chose to send. Walk from the right and
  12897. // skip trusted proxies; the first address that is not a trusted proxy is the
  12898. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12899. // from the left instead lets a client forge an arbitrary address by following
  12900. // it with a trusted proxy's address, which the left-to-right scan then
  12901. // returned as the client.
  12902. for (size_t i = ip_list.size(); i-- > 0;) {
  12903. const auto &ip = ip_list[i];
  12904. if (!detail::is_trusted_proxy(ip, trusted_proxies)) { return ip; }
  12905. }
  12906. // Every hop was a trusted proxy; fall back to the first entry.
  12907. return ip_list.front();
  12908. }
  12909. inline bool
  12910. Server::process_request(Stream &strm, const std::string &remote_addr,
  12911. int remote_port, const std::string &local_addr,
  12912. int local_port, bool close_connection,
  12913. bool &connection_closed,
  12914. const std::function<void(Request &)> &setup_request,
  12915. bool *websocket_upgraded) {
  12916. std::array<char, 2048> buf{};
  12917. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12918. // The read timeout bounds the request line and headers as a whole, so a
  12919. // client sending them a byte at a time cannot hold the worker any longer.
  12920. auto read_timeout_msec = read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000;
  12921. strm.set_max_timeout(read_timeout_msec);
  12922. // Connection has been closed on client
  12923. if (!line_reader.getline()) { return false; }
  12924. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12925. // clients send an extra CRLF after a request body, which would otherwise be
  12926. // parsed as the next request on a persistent connection.
  12927. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12928. return false;
  12929. }
  12930. Request req;
  12931. req.start_time_ = std::chrono::steady_clock::now();
  12932. req.remote_addr = remote_addr;
  12933. req.remote_port = remote_port;
  12934. req.local_addr = local_addr;
  12935. req.local_port = local_port;
  12936. Response res;
  12937. res.version = "HTTP/1.1";
  12938. res.headers = default_headers_;
  12939. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12940. // close the connection after that response, whichever path wrote it (an
  12941. // error status, a handler, or a rejected request). Reading on would also
  12942. // parse whatever the client sent next on a connection it considers done.
  12943. auto honor_connection_close = detail::scope_exit([&] {
  12944. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12945. connection_closed = true;
  12946. }
  12947. });
  12948. // Request line and headers. A rejected message leaves the rest of it (and
  12949. // any body) unread, so the connection cannot be reused: the leftover bytes
  12950. // would be parsed as the next request.
  12951. if (!parse_request_line(line_reader.ptr(), req)) {
  12952. connection_closed = true;
  12953. res.status = StatusCode::BadRequest_400;
  12954. output_error_log(Error::InvalidRequestLine, &req);
  12955. return write_response(strm, close_connection, req, res);
  12956. }
  12957. // Request headers
  12958. if (!detail::read_headers(strm, req.headers)) {
  12959. connection_closed = true;
  12960. res.status = StatusCode::BadRequest_400;
  12961. output_error_log(Error::InvalidHeaders, &req);
  12962. return write_response(strm, close_connection, req, res);
  12963. }
  12964. strm.set_max_timeout(0);
  12965. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12966. // which would otherwise let an intermediary and this parser disagree on
  12967. // where the body ends and enable request smuggling. Three cases: a
  12968. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12969. // or empty), which would otherwise be read as "no body"; a non-zero
  12970. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12971. // tolerated for compatibility with existing clients); and a
  12972. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12973. // length undeterminable. None of them may fall through to the "no body"
  12974. // path, or the body bytes are parsed as the next request on a persistent
  12975. // connection.
  12976. auto is_invalid_content_length = false;
  12977. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12978. is_invalid_content_length);
  12979. if (is_invalid_content_length ||
  12980. detail::has_conflicting_content_length(req.headers) ||
  12981. (req.has_header("Transfer-Encoding") &&
  12982. !detail::is_chunked_transfer_encoding(req.headers))) {
  12983. connection_closed = true;
  12984. res.status = StatusCode::BadRequest_400;
  12985. return write_response(strm, close_connection, req, res);
  12986. }
  12987. // RFC 9112 6.1: a lone "chunked" is the only transfer coding implemented
  12988. if (req.has_header("Transfer-Encoding") &&
  12989. (req.get_header_value_count("Transfer-Encoding") != 1 ||
  12990. !detail::case_ignore::equal(req.get_header_value("Transfer-Encoding"),
  12991. "chunked"))) {
  12992. connection_closed = true;
  12993. res.status = StatusCode::NotImplemented_501;
  12994. return write_response(strm, close_connection, req, res);
  12995. }
  12996. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12997. // HTTP/1.0 request, is honoured, but the connection closes after the
  12998. // response.
  12999. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  13000. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  13001. // value, or none in HTTP/1.1, so that every recipient of the request sees
  13002. // the same authority.
  13003. auto host_count = req.get_header_value_count("Host");
  13004. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  13005. !detail::fields::is_host(req.get_header_value("Host"))) {
  13006. connection_closed = true;
  13007. res.status = StatusCode::BadRequest_400;
  13008. output_error_log(Error::InvalidHeaders, &req);
  13009. return write_response(strm, close_connection, req, res);
  13010. }
  13011. // Check if the request URI doesn't exceed the limit
  13012. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13013. connection_closed = true;
  13014. res.status = StatusCode::UriTooLong_414;
  13015. output_error_log(Error::ExceedUriMaxLength, &req);
  13016. return write_response(strm, close_connection, req, res);
  13017. }
  13018. if (detail::has_header_token(req.headers, "Connection", "close")) {
  13019. connection_closed = true;
  13020. }
  13021. if (req.version == "HTTP/1.0" &&
  13022. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  13023. connection_closed = true;
  13024. }
  13025. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  13026. // itself a trusted proxy. Otherwise any direct client could spoof
  13027. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  13028. if (detail::is_trusted_proxy(remote_addr, trusted_proxies_) &&
  13029. req.has_header("X-Forwarded-For")) {
  13030. // Some proxies append the address they observed as a separate
  13031. // X-Forwarded-For field line instead of extending the one the client sent
  13032. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  13033. // be scanned. Reading only the first occurrence would hand back the
  13034. // client-supplied, and therefore forgeable, value.
  13035. auto x_forwarded_for =
  13036. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  13037. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  13038. req.remote_addr = derived.empty() ? remote_addr : derived;
  13039. } else {
  13040. req.remote_addr = remote_addr;
  13041. }
  13042. req.remote_port = remote_port;
  13043. req.local_addr = local_addr;
  13044. req.local_port = local_port;
  13045. if (req.has_header("Accept")) {
  13046. auto accept_header =
  13047. detail::get_combined_header_value(req.headers, "Accept");
  13048. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  13049. connection_closed = true;
  13050. res.status = StatusCode::BadRequest_400;
  13051. output_error_log(Error::HTTPParsing, &req);
  13052. return write_response(strm, close_connection, req, res);
  13053. }
  13054. }
  13055. // RFC 9110 14.2: range handling is defined only for GET (and so for HEAD)
  13056. if ((req.method == "GET" || req.method == "HEAD") &&
  13057. req.has_header("Range")) {
  13058. const auto &range_header_value = req.get_header_value("Range");
  13059. // RFC 9110 14.2: a range unit other than bytes must be ignored
  13060. auto unit = range_header_value.substr(0, range_header_value.find('='));
  13061. if (detail::case_ignore::equal(unit, "bytes") &&
  13062. !detail::parse_range_header(range_header_value, req.ranges)) {
  13063. connection_closed = true;
  13064. res.status = StatusCode::RangeNotSatisfiable_416;
  13065. output_error_log(Error::InvalidRangeHeader, &req);
  13066. return write_response(strm, close_connection, req, res);
  13067. }
  13068. }
  13069. if (setup_request) { setup_request(req); }
  13070. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  13071. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  13072. // must be ignored. An expectation we do not recognize is left alone; the
  13073. // 417 the section allows for one is a MAY, not a requirement.
  13074. //
  13075. // `100 Continue` itself is deferred until the body is actually read (see
  13076. // read_content_core), so a request rejected by a later handler never
  13077. // invites the client to send a body nobody will read.
  13078. if (req.version != "HTTP/1.0" &&
  13079. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  13080. int status = StatusCode::Continue_100;
  13081. if (expect_100_continue_handler_) {
  13082. status = expect_100_continue_handler_(req, res);
  13083. }
  13084. if (status == StatusCode::Continue_100) {
  13085. req.expect_100_continue_pending_ = true;
  13086. } else {
  13087. if (res.status == -1) { res.status = status; }
  13088. connection_closed = true;
  13089. return write_response(strm, true, req, res);
  13090. }
  13091. }
  13092. // Setup `is_connection_closed` method
  13093. auto sock = strm.socket();
  13094. req.is_connection_closed = [sock]() {
  13095. return !detail::is_socket_alive(sock);
  13096. };
  13097. // WebSocket upgrade
  13098. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  13099. // that authentication and other middleware can reject the request with an
  13100. // HTTP response (e.g., 401) before the protocol switches.
  13101. // The response says so when this connection closes after it.
  13102. auto close_after_response = close_connection || connection_closed;
  13103. // An upgrade request has been through pre-routing before it reaches routing()
  13104. auto is_upgrade = detail::is_websocket_upgrade(req);
  13105. if (is_upgrade) {
  13106. // A response given here leaves the body unread, and it would be parsed as
  13107. // the next request.
  13108. auto close_if_answered =
  13109. close_after_response || detail::has_framed_body(req);
  13110. const WebSocketHandlerEntry *ws_route = nullptr;
  13111. std::string selected_subprotocol;
  13112. auto answer_before_upgrade = [&]() -> bool {
  13113. if (pre_routing_handler_ &&
  13114. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  13115. return true;
  13116. }
  13117. for (const auto &entry : websocket_handlers_) {
  13118. if (!entry.matcher->match(req)) { continue; }
  13119. req.matched_route = entry.matcher->pattern();
  13120. if (pre_request_handler_ &&
  13121. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  13122. return true;
  13123. }
  13124. ws_route = &entry;
  13125. if (entry.sub_protocol_selector) {
  13126. auto protocol_header = detail::get_combined_header_value(
  13127. req.headers, "Sec-WebSocket-Protocol");
  13128. if (!protocol_header.empty()) {
  13129. std::vector<std::string> protocols;
  13130. detail::split(protocol_header.data(),
  13131. protocol_header.data() + protocol_header.size(), ',',
  13132. [&](const char *b, const char *e) {
  13133. protocols.emplace_back(b, e);
  13134. });
  13135. selected_subprotocol = entry.sub_protocol_selector(protocols);
  13136. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  13137. if (std::find(protocols.begin(), protocols.end(),
  13138. selected_subprotocol) == protocols.end()) {
  13139. selected_subprotocol.clear();
  13140. }
  13141. }
  13142. }
  13143. return false;
  13144. }
  13145. return false;
  13146. };
  13147. auto answered = false;
  13148. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13149. answered = answer_before_upgrade();
  13150. #else
  13151. try {
  13152. answered = answer_before_upgrade();
  13153. } catch (...) {
  13154. if (!handle_exception(req, res)) {
  13155. return write_response(strm, close_if_answered, req, res);
  13156. }
  13157. answered = true;
  13158. }
  13159. #endif
  13160. if (answered) {
  13161. if (res.status == -1) { res.status = StatusCode::OK_200; }
  13162. return write_response_with_content(strm, close_if_answered, req, res);
  13163. }
  13164. if (ws_route) {
  13165. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  13166. auto accept_key = detail::websocket_accept_key(client_key);
  13167. // Send 101 Switching Protocols
  13168. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  13169. "Upgrade: websocket\r\n"
  13170. "Connection: Upgrade\r\n"
  13171. "Sec-WebSocket-Accept: " +
  13172. accept_key + "\r\n";
  13173. if (!selected_subprotocol.empty()) {
  13174. if (!detail::fields::is_field_value(selected_subprotocol)) {
  13175. return false;
  13176. }
  13177. handshake_response +=
  13178. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  13179. }
  13180. handshake_response += "\r\n";
  13181. if (strm.write(handshake_response.data(), handshake_response.size()) <
  13182. 0) {
  13183. return false;
  13184. }
  13185. connection_closed = true;
  13186. if (websocket_upgraded) { *websocket_upgraded = true; }
  13187. #ifdef CPPHTTPLIB_SSL_ENABLED
  13188. if (req.ssl) {
  13189. // wss: the heartbeat ping thread and the read path enter the same
  13190. // TLS session from different threads. Hand the WebSocket a stream
  13191. // that serializes every TLS call, so the shared SSLSocketStream on
  13192. // the plain HTTP/HTTPS paths stays untouched.
  13193. auto ws_strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  13194. strm.socket(), const_cast<tls::session_t>(req.ssl),
  13195. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13196. write_timeout_sec_, write_timeout_usec_));
  13197. ws::WebSocket ws(std::move(ws_strm), req, true,
  13198. websocket_ping_interval_sec_,
  13199. websocket_max_missed_pongs_);
  13200. ws_route->handler(req, ws);
  13201. return true;
  13202. }
  13203. #endif
  13204. // Use WebSocket-specific read timeout instead of HTTP timeout
  13205. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0);
  13206. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13207. websocket_max_missed_pongs_);
  13208. ws_route->handler(req, ws);
  13209. return true;
  13210. }
  13211. // No WebSocket route: route it as a plain HTTP request
  13212. }
  13213. // Routing
  13214. auto routed = false;
  13215. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13216. routed = routing(req, res, strm, is_upgrade);
  13217. #else
  13218. try {
  13219. routed = routing(req, res, strm, is_upgrade);
  13220. } catch (...) { routed = handle_exception(req, res); }
  13221. #endif
  13222. auto ret = false;
  13223. if (routed) {
  13224. if (res.status == -1) {
  13225. res.status = req.ranges.empty() ? StatusCode::OK_200
  13226. : StatusCode::PartialContent_206;
  13227. }
  13228. // Before the Range checks below, so they see the body's own length.
  13229. detail::prefer_assigned_body(res);
  13230. // Serve file content by using a content provider
  13231. auto file_open_error = false;
  13232. if (!res.file_content_path_.empty()) {
  13233. const auto &path = res.file_content_path_;
  13234. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13235. if (!mm->is_open()) {
  13236. res.status = StatusCode::NotFound_404;
  13237. output_error_log(Error::OpenFile, &req);
  13238. file_open_error = true;
  13239. } else {
  13240. auto content_type = res.file_content_content_type_;
  13241. if (content_type.empty()) {
  13242. // One the handler set after set_file_content()
  13243. content_type = res.get_header_value("Content-Type");
  13244. }
  13245. if (content_type.empty()) {
  13246. content_type = detail::find_content_type(
  13247. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13248. }
  13249. detail::set_file_content_provider(
  13250. res, mm, content_type,
  13251. static_file_encoding(req, res, content_type, mm->size()));
  13252. }
  13253. }
  13254. if (file_open_error) {
  13255. ret = write_response(strm, close_after_response, req, res);
  13256. } else if (detail::range_error(req, res)) {
  13257. detail::clear_content(res);
  13258. res.status = StatusCode::RangeNotSatisfiable_416;
  13259. ret = write_response(strm, close_after_response, req, res);
  13260. } else {
  13261. ret = write_response_with_content(strm, close_after_response, req, res);
  13262. }
  13263. } else {
  13264. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13265. ret = write_response(strm, close_after_response, req, res);
  13266. }
  13267. // Drain any unconsumed framed body to prevent request smuggling on
  13268. // keep-alive. Without framing there is no body to drain — reading would
  13269. // consume the next request (issue #2450). If the response has committed the
  13270. // connection to close, there is no next request to protect. A body read in
  13271. // part cannot be drained from where it stopped, so the connection closes,
  13272. // as it does when the body is longer than the drain limit or does not
  13273. // arrive within the read timeout.
  13274. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13275. !detail::has_header_token(res.headers, "Connection", "close")) {
  13276. strm.set_max_timeout(read_timeout_msec);
  13277. int dummy_status;
  13278. if (req.body_read_started_ ||
  13279. !detail::read_content(
  13280. strm, req, CPPHTTPLIB_UNREAD_PAYLOAD_MAX_LENGTH, dummy_status,
  13281. nullptr, [](const char *, size_t, size_t, size_t) { return true; },
  13282. false)) {
  13283. connection_closed = true;
  13284. }
  13285. }
  13286. return ret;
  13287. }
  13288. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13289. inline bool Server::process_and_close_socket(socket_t sock) {
  13290. std::string remote_addr;
  13291. int remote_port = 0;
  13292. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13293. std::string local_addr;
  13294. int local_port = 0;
  13295. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13296. bool websocket_upgraded = false;
  13297. auto ret = serve_guarded([&]() {
  13298. return detail::process_server_socket(
  13299. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13300. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13301. write_timeout_usec_,
  13302. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13303. return process_request(strm, remote_addr, remote_port, local_addr,
  13304. local_port, close_connection,
  13305. connection_closed, nullptr,
  13306. &websocket_upgraded);
  13307. });
  13308. });
  13309. detail::drain_and_close_socket(sock);
  13310. return ret;
  13311. }
  13312. inline void Server::output_log(const Request &req, const Response &res) const {
  13313. if (logger_) {
  13314. std::lock_guard<std::mutex> guard(logger_mutex_);
  13315. logger_(req, res);
  13316. }
  13317. }
  13318. inline void Server::output_pre_compression_log(const Request &req,
  13319. const Response &res) const {
  13320. if (pre_compression_logger_) {
  13321. std::lock_guard<std::mutex> guard(logger_mutex_);
  13322. pre_compression_logger_(req, res);
  13323. }
  13324. }
  13325. inline void Server::output_error_log(const Error &err,
  13326. const Request *req) const {
  13327. if (error_logger_) {
  13328. std::lock_guard<std::mutex> guard(logger_mutex_);
  13329. error_logger_(err, req);
  13330. }
  13331. }
  13332. /*
  13333. * Group 5: ClientImpl and Client (Universal) implementation
  13334. */
  13335. // HTTP client implementation
  13336. inline ClientImpl::ClientImpl(const std::string &host)
  13337. : ClientImpl(host, 80, std::string(), std::string()) {}
  13338. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13339. : ClientImpl(host, port, std::string(), std::string()) {}
  13340. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13341. const std::string &client_cert_path,
  13342. const std::string &client_key_path)
  13343. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13344. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13345. inline ClientImpl::~ClientImpl() {
  13346. // Wait until all the requests in flight are handled.
  13347. size_t retry_count = 10;
  13348. while (retry_count-- > 0) {
  13349. {
  13350. std::lock_guard<std::mutex> guard(socket_mutex_);
  13351. if (socket_requests_in_flight_ == 0) { break; }
  13352. }
  13353. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13354. }
  13355. std::lock_guard<std::mutex> guard(socket_mutex_);
  13356. shutdown_socket(socket_);
  13357. close_socket(socket_);
  13358. }
  13359. inline bool ClientImpl::is_valid() const { return true; }
  13360. inline bool
  13361. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13362. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13363. if (no_proxy_entries_.empty()) { return true; }
  13364. // host_ is const so its normalized form is invariant; cache it. The
  13365. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13366. if (host == host_) {
  13367. if (!host_normalized_valid_) {
  13368. host_normalized_ = detail::normalize_target(host_);
  13369. host_normalized_valid_ = true;
  13370. }
  13371. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13372. }
  13373. auto target = detail::normalize_target(host);
  13374. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13375. }
  13376. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13377. if (is_proxy_enabled_for_host(host_)) {
  13378. return detail::create_client_socket(
  13379. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13380. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13381. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13382. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13383. }
  13384. // Check is custom IP or hostname specified for host_
  13385. std::string connect_host;
  13386. std::string ip;
  13387. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13388. return detail::create_client_socket(
  13389. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13390. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13391. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13392. write_timeout_usec_, interface_, error);
  13393. }
  13394. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13395. Error &error) {
  13396. auto sock = create_client_socket(error);
  13397. if (sock == INVALID_SOCKET) { return false; }
  13398. socket.sock = sock;
  13399. return true;
  13400. }
  13401. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13402. socket_tls_settings_version_ = tls_settings_version_;
  13403. return create_and_connect_socket(socket, error);
  13404. }
  13405. inline bool ClientImpl::setup_proxy_connection(
  13406. Socket & /*socket*/,
  13407. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13408. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13409. return true;
  13410. }
  13411. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13412. bool /*shutdown_gracefully*/) {
  13413. // If there are any requests in flight from threads other than us, then it's
  13414. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13415. assert(socket_requests_in_flight_ == 0 ||
  13416. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13417. }
  13418. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13419. if (socket.sock == INVALID_SOCKET) { return; }
  13420. detail::shutdown_socket(socket.sock);
  13421. }
  13422. inline void ClientImpl::close_socket(Socket &socket) {
  13423. // If there are requests in flight in another thread, usually closing
  13424. // the socket will be fine and they will simply receive an error when
  13425. // using the closed socket, but it is still a bug since rarely the OS
  13426. // may reassign the socket id to be used for a new socket, and then
  13427. // suddenly they will be operating on a live socket that is different
  13428. // than the one they intended!
  13429. assert(socket_requests_in_flight_ == 0 ||
  13430. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13431. // It is also a bug if this happens while SSL is still active
  13432. #ifdef CPPHTTPLIB_SSL_ENABLED
  13433. assert(socket.ssl == nullptr);
  13434. #endif
  13435. if (socket.sock == INVALID_SOCKET) { return; }
  13436. detail::close_socket(socket.sock);
  13437. socket.sock = INVALID_SOCKET;
  13438. }
  13439. inline void ClientImpl::disconnect(bool gracefully) {
  13440. shutdown_ssl(socket_, gracefully);
  13441. shutdown_socket(socket_);
  13442. close_socket(socket_);
  13443. }
  13444. inline bool ClientImpl::socket_reusable() {
  13445. if (!socket_.is_open()) { return false; }
  13446. auto is_alive = detail::is_socket_alive(socket_.sock);
  13447. #ifdef CPPHTTPLIB_SSL_ENABLED
  13448. if (is_alive && is_ssl() && tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13449. is_alive = false;
  13450. }
  13451. #endif
  13452. if (!is_alive) {
  13453. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13454. disconnect(/*gracefully=*/false);
  13455. return false;
  13456. }
  13457. if (is_ssl() && socket_tls_settings_version_ != tls_settings_version_) {
  13458. disconnect(/*gracefully=*/true);
  13459. return false;
  13460. }
  13461. return true;
  13462. }
  13463. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13464. Response &res,
  13465. bool skip_100_continue) const {
  13466. std::array<char, 2048> buf{};
  13467. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13468. if (!line_reader.getline()) { return false; }
  13469. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13470. res.reason)) {
  13471. return req.method == "CONNECT";
  13472. }
  13473. // Skip interim (1xx) responses along with their header fields, except a 100
  13474. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13475. // HTTP on the connection, so it is final. A server sending them without end
  13476. // would hold the client, so there may be only so many.
  13477. size_t interim_count = 0;
  13478. while (100 <= res.status && res.status < 200 &&
  13479. res.status != StatusCode::SwitchingProtocol_101 &&
  13480. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13481. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13482. return false;
  13483. }
  13484. Headers interim_headers;
  13485. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13486. if (!line_reader.getline()) { return false; } // next response line
  13487. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13488. res.reason)) {
  13489. return false;
  13490. }
  13491. }
  13492. return true;
  13493. }
  13494. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13495. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13496. // A same-origin redirect and a digest retry send through here again. Only
  13497. // the call the caller made reports a failure, once, with its request.
  13498. auto outermost = send_depth_++ == 0;
  13499. auto se = detail::scope_exit([&] { send_depth_--; });
  13500. if (outermost) { error = Error::Success; }
  13501. auto ret = send_(req, res, error);
  13502. if (error == Error::SSLPeerCouldBeClosed_) {
  13503. assert(!ret);
  13504. ret = send_(req, res, error);
  13505. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13506. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13507. }
  13508. // Also an answer that carries an error, such as a proxy's 407
  13509. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13510. return ret;
  13511. }
  13512. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13513. #ifdef CPPHTTPLIB_SSL_ENABLED
  13514. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13515. // client that failed to set up its TLS context keeps reporting why.
  13516. if (is_valid()) {
  13517. last_ssl_error_ = 0;
  13518. last_backend_error_ = 0;
  13519. }
  13520. #endif
  13521. {
  13522. std::lock_guard<std::mutex> guard(socket_mutex_);
  13523. // Set this to false immediately - if it ever gets set to true by the end
  13524. // of the request, we know another thread instructed us to close the
  13525. // socket.
  13526. socket_should_be_closed_when_request_is_done_ = false;
  13527. // A redirect or a retry sent inside a request keeps its stop()
  13528. if (socket_requests_in_flight_ == 0) { stop_requested_ = false; }
  13529. if (!socket_reusable()) {
  13530. if (!ensure_socket_connection(socket_, error)) { return false; }
  13531. {
  13532. auto success = true;
  13533. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13534. error)) {
  13535. return success;
  13536. }
  13537. }
  13538. }
  13539. // Mark the current socket as being in use so that it cannot be closed by
  13540. // anyone else while this request is ongoing, even though we will be
  13541. // releasing the mutex.
  13542. if (socket_requests_in_flight_ > 1) {
  13543. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13544. }
  13545. socket_requests_in_flight_ += 1;
  13546. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13547. }
  13548. for (const auto &header : default_headers_) {
  13549. if (req.headers.find(header.first) == req.headers.end()) {
  13550. req.headers.insert(header);
  13551. }
  13552. }
  13553. auto ret = false;
  13554. auto close_connection = !keep_alive_;
  13555. auto se = detail::scope_exit([&]() {
  13556. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13557. std::lock_guard<std::mutex> guard(socket_mutex_);
  13558. socket_requests_in_flight_ -= 1;
  13559. if (socket_requests_in_flight_ <= 0) {
  13560. assert(socket_requests_in_flight_ == 0);
  13561. socket_requests_are_from_thread_ = std::thread::id();
  13562. }
  13563. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13564. !ret) {
  13565. disconnect(/*gracefully=*/true);
  13566. }
  13567. });
  13568. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13569. strm.set_read_interrupt([this] { return stop_requested_.load(); });
  13570. return handle_request(strm, req, res, close_connection, error);
  13571. });
  13572. if (!ret) {
  13573. if (error == Error::Success) { error = Error::Unknown; }
  13574. }
  13575. return ret;
  13576. }
  13577. inline Result ClientImpl::send(const Request &req) {
  13578. auto req2 = req;
  13579. return send_(std::move(req2));
  13580. }
  13581. inline Result ClientImpl::send_(Request &&req) {
  13582. auto res = detail::make_unique<Response>();
  13583. auto error = Error::Success;
  13584. #ifdef CPPHTTPLIB_SSL_ENABLED
  13585. // Hold the request lock until the Result has read this request's TLS error
  13586. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13587. #endif
  13588. auto ret = send(req, *res, error);
  13589. #ifdef CPPHTTPLIB_SSL_ENABLED
  13590. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13591. last_ssl_error_, last_backend_error_};
  13592. #else
  13593. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13594. #endif
  13595. }
  13596. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13597. const std::string &ct) {
  13598. (void)for_stream;
  13599. // Default headers are meant for the origin and may carry its credentials, so
  13600. // keep them off the CONNECT request the proxy reads.
  13601. if (r.method != "CONNECT") {
  13602. for (const auto &header : default_headers_) {
  13603. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13604. }
  13605. }
  13606. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13607. // prepend it rather than appending it after the caller's own fields.
  13608. if (!r.has_header("Host")) {
  13609. r.headers.emplace_front(
  13610. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13611. address_family_));
  13612. }
  13613. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13614. if (!r.content_receiver) {
  13615. if (!r.has_header("Accept-Encoding")) {
  13616. std::string accept_encoding;
  13617. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13618. accept_encoding = "br";
  13619. #endif
  13620. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13621. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13622. accept_encoding += "gzip, deflate";
  13623. #endif
  13624. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13625. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13626. accept_encoding += "zstd";
  13627. #endif
  13628. r.set_header("Accept-Encoding", accept_encoding);
  13629. }
  13630. detail::add_default_user_agent_header(r);
  13631. }
  13632. if (!r.body.empty()) {
  13633. if (!ct.empty() && !r.has_header("Content-Type")) {
  13634. r.headers.emplace("Content-Type", ct);
  13635. }
  13636. if (!r.has_header("Content-Length")) {
  13637. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13638. }
  13639. }
  13640. }
  13641. inline ClientImpl::StreamHandle
  13642. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13643. const Params &params, const Headers &headers,
  13644. const std::string &body,
  13645. const std::string &content_type) {
  13646. // Encode the target exactly like the buffered send path does, so that the
  13647. // same `path` produces the same request line through either API.
  13648. auto raw_query_path =
  13649. params.empty() ? path : append_query_params(path, params);
  13650. Request req;
  13651. req.method = method;
  13652. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13653. req.headers = headers;
  13654. req.body = body;
  13655. prepare_default_headers(req, true, content_type);
  13656. auto handle = open_stream_(req);
  13657. // Like a buffered request, a stream that fails to open is reported once
  13658. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13659. return handle;
  13660. }
  13661. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13662. StreamHandle handle;
  13663. handle.response = detail::make_unique<Response>();
  13664. handle.error = Error::Success;
  13665. handle.connection_ = detail::make_unique<ClientConnection>();
  13666. {
  13667. // A request in flight uses socket_ without holding socket_mutex_
  13668. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13669. std::lock_guard<std::mutex> guard(socket_mutex_);
  13670. if (!socket_reusable()) {
  13671. if (!ensure_socket_connection(socket_, handle.error)) {
  13672. handle.response.reset();
  13673. return handle;
  13674. }
  13675. {
  13676. auto success = true;
  13677. auto start_time = std::chrono::steady_clock::now();
  13678. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13679. success, handle.error)) {
  13680. if (!success) { handle.response.reset(); }
  13681. return handle;
  13682. }
  13683. }
  13684. }
  13685. transfer_socket_ownership_to_handle(handle);
  13686. }
  13687. #ifdef CPPHTTPLIB_SSL_ENABLED
  13688. if (is_ssl() && handle.connection_->session) {
  13689. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13690. handle.connection_->sock, handle.connection_->session,
  13691. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13692. write_timeout_usec_);
  13693. } else {
  13694. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13695. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13696. write_timeout_sec_, write_timeout_usec_);
  13697. }
  13698. #else
  13699. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13700. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13701. write_timeout_sec_, write_timeout_usec_);
  13702. #endif
  13703. handle.stream_ = handle.socket_stream_.get();
  13704. auto &strm = *handle.stream_;
  13705. // After connecting, as for a buffered request
  13706. add_credential_headers(req);
  13707. // Build the request line and headers in memory first, like write_request()
  13708. // does, so that a rejected header leaves nothing on the wire.
  13709. {
  13710. detail::BufferStream bstrm;
  13711. // The path follows the authority in absolute-form, so one that does not
  13712. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13713. auto prefix = proxy_target_prefix();
  13714. if ((!prefix.empty() && req.path[0] != '/') ||
  13715. detail::write_request_line(bstrm, req.method, prefix + req.path) < 0) {
  13716. handle.error = Error::Write;
  13717. handle.response.reset();
  13718. return handle;
  13719. }
  13720. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13721. handle.error)) {
  13722. handle.response.reset();
  13723. return handle;
  13724. }
  13725. const auto &data = bstrm.get_buffer();
  13726. if (!detail::write_data(strm, data.data(), data.size())) {
  13727. handle.error = Error::Write;
  13728. handle.response.reset();
  13729. return handle;
  13730. }
  13731. }
  13732. if (!req.body.empty()) {
  13733. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13734. handle.error = Error::Write;
  13735. handle.response.reset();
  13736. return handle;
  13737. }
  13738. }
  13739. if (!read_response_line(strm, req, *handle.response) ||
  13740. !detail::read_headers(strm, handle.response->headers)) {
  13741. handle.error = Error::Read;
  13742. handle.response.reset();
  13743. return handle;
  13744. }
  13745. handle.body_reader_.stream = handle.stream_;
  13746. handle.body_reader_.payload_max_length = payload_max_length_;
  13747. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13748. // header section, so none of its framing or coding headers apply.
  13749. if (req.method == "HEAD" ||
  13750. handle.response->status == StatusCode::NoContent_204 ||
  13751. handle.response->status == StatusCode::NotModified_304) {
  13752. handle.body_reader_.eof = true;
  13753. return handle;
  13754. }
  13755. // Same framing check as ClientImpl::process_request()
  13756. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13757. handle.error = Error::Read;
  13758. handle.response.reset();
  13759. return handle;
  13760. }
  13761. if (handle.response->has_header("Content-Length")) {
  13762. bool is_invalid = false;
  13763. auto content_length = detail::get_header_value_u64(
  13764. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13765. if (is_invalid) {
  13766. handle.error = Error::Read;
  13767. handle.response.reset();
  13768. return handle;
  13769. }
  13770. handle.body_reader_.has_content_length = true;
  13771. handle.body_reader_.content_length = content_length;
  13772. }
  13773. handle.body_reader_.chunked =
  13774. detail::is_chunked_transfer_encoding(handle.response->headers);
  13775. auto content_encoding = detail::get_combined_header_value(
  13776. handle.response->headers, "Content-Encoding");
  13777. if (decompress_ && !content_encoding.empty()) {
  13778. // Same policy as prepare_content_receiver(): reject a coding we know about
  13779. // but were not built with, pass an unrecognized one through as-is.
  13780. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13781. if (!handle.decompressor_) {
  13782. if (detail::is_known_content_encoding(content_encoding)) {
  13783. handle.error = Error::UnsupportedContentEncoding;
  13784. handle.response.reset();
  13785. return handle;
  13786. }
  13787. } else if (!handle.decompressor_->is_valid()) {
  13788. handle.error = Error::Compression;
  13789. handle.response.reset();
  13790. return handle;
  13791. }
  13792. }
  13793. return handle;
  13794. }
  13795. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13796. if (!is_valid() || !response) { return -1; }
  13797. auto n = decompressor_
  13798. ? read_with_decompression(buf, len)
  13799. : detail::read_body_content(stream_, body_reader_, buf, len);
  13800. if (n == 0) { parse_trailers_if_needed(); }
  13801. return n;
  13802. }
  13803. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13804. size_t len) {
  13805. if (decompress_offset_ < decompress_buffer_.size()) {
  13806. auto available = decompress_buffer_.size() - decompress_offset_;
  13807. auto to_copy = (std::min)(len, available);
  13808. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13809. decompress_offset_ += to_copy;
  13810. decompressed_bytes_read_ += to_copy;
  13811. return static_cast<ssize_t>(to_copy);
  13812. }
  13813. decompress_buffer_.clear();
  13814. decompress_offset_ = 0;
  13815. constexpr size_t kDecompressionBufferSize = 8192;
  13816. char compressed_buf[kDecompressionBufferSize];
  13817. while (true) {
  13818. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13819. sizeof(compressed_buf));
  13820. if (n <= 0) { return n; }
  13821. auto exceeded = false;
  13822. bool decompress_ok = decompressor_->decompress(
  13823. compressed_buf, static_cast<size_t>(n),
  13824. [&](const char *data, size_t data_len) {
  13825. decompress_buffer_.append(data, data_len);
  13826. auto limit = body_reader_.payload_max_length;
  13827. exceeded =
  13828. limit > 0 &&
  13829. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13830. return !exceeded;
  13831. });
  13832. if (!decompress_ok) {
  13833. body_reader_.last_error =
  13834. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13835. return -1;
  13836. }
  13837. if (!decompress_buffer_.empty()) { break; }
  13838. }
  13839. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13840. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13841. decompress_offset_ = to_copy;
  13842. decompressed_bytes_read_ += to_copy;
  13843. return static_cast<ssize_t>(to_copy);
  13844. }
  13845. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13846. // The trailers follow the last chunk, so there are none before it
  13847. auto &decoder = body_reader_.chunked_decoder;
  13848. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13849. return;
  13850. }
  13851. trailers_parsed_ = true;
  13852. decoder->parse_trailers_into(response->trailers, response->headers);
  13853. }
  13854. namespace detail {
  13855. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13856. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13857. size_t &out_chunk_offset,
  13858. size_t &out_chunk_total) {
  13859. if (finished) { return 0; }
  13860. if (chunk_remaining == 0) {
  13861. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13862. if (!lr.getline()) { return -1; }
  13863. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13864. // the line terminator is never mistaken for line content.
  13865. const char *eol = lr.ptr() + lr.size();
  13866. if (lr.end_with_crlf()) {
  13867. eol -= 2;
  13868. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13869. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13870. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13871. // has to come off here or the check below would reject the line.
  13872. eol -= 1;
  13873. }
  13874. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13875. const char *p = lr.ptr();
  13876. int v = 0;
  13877. if (p == eol || !is_hex(*p, v)) { return -1; }
  13878. size_t chunk_len = 0;
  13879. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13880. for (; p < eol && is_hex(*p, v); ++p) {
  13881. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13882. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13883. }
  13884. while (p < eol && is_space_or_tab(*p)) {
  13885. ++p;
  13886. }
  13887. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13888. // terminator, and it is built from tokens and quoted-strings, so it never
  13889. // holds a CR, LF or any other control character. getline() reads up to the
  13890. // CRLF, so a bare LF left in here would be swallowed as extension text
  13891. // while an intermediary that ends the line on it delimits the chunks
  13892. // differently, and the two disagree on where the body ends (request
  13893. // smuggling).
  13894. if (p < eol && *p != ';') { return -1; }
  13895. for (; p < eol; ++p) {
  13896. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13897. }
  13898. // The bytes around the data are no payload, so they are counted on their
  13899. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  13900. // them, which lets a stream send a byte at a time, and what goes past that
  13901. // in padding, leading zeros and extensions builds up to one header field.
  13902. overhead += lr.size() + 2;
  13903. overhead = overhead > 16 ? overhead - 16 : 0;
  13904. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  13905. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  13906. if (chunk_len == 0) {
  13907. chunk_remaining = 0;
  13908. finished = true;
  13909. out_chunk_offset = 0;
  13910. out_chunk_total = 0;
  13911. return 0;
  13912. }
  13913. chunk_remaining = chunk_len;
  13914. last_chunk_total = chunk_remaining;
  13915. last_chunk_offset = 0;
  13916. }
  13917. auto to_read = (std::min)(chunk_remaining, len);
  13918. auto n = strm.read(buf, to_read);
  13919. if (n <= 0) { return -1; }
  13920. auto offset_before = last_chunk_offset;
  13921. last_chunk_offset += static_cast<size_t>(n);
  13922. chunk_remaining -= static_cast<size_t>(n);
  13923. out_chunk_offset = offset_before;
  13924. out_chunk_total = last_chunk_total;
  13925. if (chunk_remaining == 0) {
  13926. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13927. if (!lr.getline()) { return -1; }
  13928. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13929. }
  13930. return n;
  13931. }
  13932. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13933. const Headers &src_headers) {
  13934. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13935. if (!lr.getline()) { return false; }
  13936. return parse_trailers(lr, dest, src_headers);
  13937. }
  13938. // Only 301, 302, 303, 307 and 308 redirect. Any other 3xx, such as a 304, or
  13939. // a redirect without a Location, is a final response.
  13940. inline bool is_redirect(const Response &res) {
  13941. switch (res.status) {
  13942. case StatusCode::MovedPermanently_301:
  13943. case StatusCode::Found_302:
  13944. case StatusCode::SeeOther_303:
  13945. case StatusCode::TemporaryRedirect_307:
  13946. case StatusCode::PermanentRedirect_308:
  13947. return !res.get_header_value("Location").empty();
  13948. default: return false;
  13949. }
  13950. }
  13951. } // namespace detail
  13952. inline void
  13953. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13954. handle.connection_->sock = socket_.sock;
  13955. #ifdef CPPHTTPLIB_SSL_ENABLED
  13956. handle.connection_->session = socket_.ssl;
  13957. socket_.ssl = nullptr;
  13958. #endif
  13959. socket_.sock = INVALID_SOCKET;
  13960. }
  13961. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  13962. inline std::string ClientImpl::proxy_target_prefix() const {
  13963. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  13964. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  13965. }
  13966. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13967. Response &res, bool close_connection,
  13968. Error &error) {
  13969. if (req.path.empty()) {
  13970. error = Error::Connection;
  13971. return false;
  13972. }
  13973. auto req_save = req;
  13974. bool ret;
  13975. auto prefix = proxy_target_prefix();
  13976. if (!prefix.empty()) {
  13977. // The path follows the authority in absolute-form, so one that does not
  13978. // begin with '/' (e.g. "@evil.example/x") would name another host.
  13979. if (req.path[0] != '/') {
  13980. error = Error::Write;
  13981. return false;
  13982. }
  13983. auto req2 = req;
  13984. req2.path = prefix + req.path;
  13985. ret = process_request(strm, req2, res, close_connection, error);
  13986. req = std::move(req2);
  13987. req.path = req_save.path;
  13988. } else {
  13989. ret = process_request(strm, req, res, close_connection, error);
  13990. }
  13991. if (!ret) { return false; }
  13992. {
  13993. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13994. // for this to be safe.
  13995. // This is safe to call because handle_request is only called by send_
  13996. // which locks the request mutex during the process. It would be a bug
  13997. // to call it from a different thread since it's a thread-safety issue
  13998. // to do these things to the socket if another thread is using the socket.
  13999. std::lock_guard<std::mutex> guard(socket_mutex_);
  14000. // Also when the request asked for it (e.g. a body that was never sent,
  14001. // or "Connection: close"), so that a redirect or an auth retry below does
  14002. // not reuse the socket.
  14003. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  14004. detail::has_header_token(res.headers, "Connection", "close") ||
  14005. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  14006. disconnect(/*gracefully=*/true);
  14007. }
  14008. }
  14009. if (follow_location_ && detail::is_redirect(res)) {
  14010. req = std::move(req_save);
  14011. // The client that followed the redirect has answered any challenge it
  14012. // could. Retrying below would sign another host's challenge and send it
  14013. // here.
  14014. return redirect(req, res, error);
  14015. }
  14016. #ifdef CPPHTTPLIB_SSL_ENABLED
  14017. if ((res.status == StatusCode::Unauthorized_401 ||
  14018. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  14019. req.authorization_count_ < 5) {
  14020. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  14021. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  14022. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  14023. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  14024. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  14025. return ret;
  14026. }
  14027. const auto &username =
  14028. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  14029. const auto &password =
  14030. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  14031. if (!username.empty() && !password.empty()) {
  14032. std::map<std::string, std::string> auth;
  14033. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  14034. Request new_req = req;
  14035. new_req.authorization_count_ += 1;
  14036. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  14037. : "Authorization");
  14038. new_req.headers.insert(detail::make_digest_authentication_header(
  14039. req, make_request_target(req), auth, new_req.authorization_count_,
  14040. detail::random_string(10), username, password, is_proxy));
  14041. Response new_res;
  14042. ret = send(new_req, new_res, error);
  14043. if (ret) { res = std::move(new_res); }
  14044. }
  14045. }
  14046. }
  14047. #endif
  14048. return ret;
  14049. }
  14050. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  14051. if (req.redirect_count_ == 0) {
  14052. error = Error::ExceedRedirectCount;
  14053. return false;
  14054. }
  14055. auto location = res.get_header_value("location");
  14056. if (location.empty()) { return false; }
  14057. detail::UrlComponents uc;
  14058. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  14059. uc)) {
  14060. return false;
  14061. }
  14062. // Only follow http/https redirects
  14063. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  14064. return false;
  14065. }
  14066. auto scheme = is_ssl() ? "https" : "http";
  14067. auto next_scheme = std::move(uc.scheme);
  14068. auto next_host = std::move(uc.host);
  14069. auto port_str = std::move(uc.port);
  14070. auto next_path = std::move(uc.path);
  14071. auto next_query = std::move(uc.query);
  14072. auto next_port = port_;
  14073. if (!port_str.empty()) {
  14074. if (!detail::parse_port(port_str, next_port)) { return false; }
  14075. } else if (!next_scheme.empty()) {
  14076. next_port = next_scheme == "https" ? 443 : 80;
  14077. }
  14078. if (next_scheme.empty()) { next_scheme = scheme; }
  14079. if (next_host.empty()) { next_host = host_; }
  14080. if (next_path.empty()) { next_path = "/"; }
  14081. // An absolute or absolute-path location can have dot segments too.
  14082. if (next_path[0] == '/') {
  14083. next_path = detail::remove_dot_segments(next_path);
  14084. }
  14085. auto path = std::move(next_path) + next_query;
  14086. // A Unix socket client sends "Host: localhost", so a Location naming
  14087. // localhost names this client too.
  14088. auto is_same_host = next_host == host_ ||
  14089. (address_family_ == AF_UNIX && next_host == "localhost");
  14090. // Same host redirect - use current client
  14091. if (next_scheme == scheme && is_same_host && next_port == port_) {
  14092. return detail::redirect(*this, req, res, path, location, error);
  14093. }
  14094. // Cross-host/scheme redirect - create new client with robust setup
  14095. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  14096. path, location, error);
  14097. }
  14098. // New method for robust redirect client creation
  14099. inline bool ClientImpl::create_redirect_client(
  14100. const std::string &scheme, const std::string &host, int port, Request &req,
  14101. Response &res, const std::string &path, const std::string &location,
  14102. Error &error) {
  14103. // Determine if we need SSL
  14104. auto need_ssl = (scheme == "https");
  14105. // Clean up request headers that are host/client specific
  14106. // Remove headers that should not be carried over to new host
  14107. auto headers_to_remove = std::vector<std::string>{
  14108. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  14109. for (const auto &header_name : headers_to_remove) {
  14110. auto it = req.headers.find(header_name);
  14111. while (it != req.headers.end()) {
  14112. it = req.headers.erase(it);
  14113. it = req.headers.find(header_name);
  14114. }
  14115. }
  14116. // Create appropriate client type and handle redirect
  14117. if (need_ssl) {
  14118. #ifdef CPPHTTPLIB_SSL_ENABLED
  14119. // Create SSL client for HTTPS redirect
  14120. SSLClient redirect_client(host, port);
  14121. // Setup basic client configuration first
  14122. setup_redirect_client(redirect_client);
  14123. redirect_client.enable_server_certificate_verification(
  14124. server_certificate_verification_);
  14125. redirect_client.enable_server_hostname_verification(
  14126. server_hostname_verification_);
  14127. redirect_client.system_ca_mode_ = system_ca_mode_;
  14128. // Transfer CA certificate to redirect client
  14129. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  14130. if (is_ssl()) {
  14131. auto &self = static_cast<SSLClient &>(*this);
  14132. // A store given to set_ca_cert_store() lives only in this client's
  14133. // context, which then holds all that is trusted.
  14134. if (self.ca_cert_store_set_) {
  14135. std::string pem;
  14136. {
  14137. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  14138. pem = detail::ca_certs_to_pem(self.ctx_);
  14139. }
  14140. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  14141. redirect_client.ca_cert_store_set_ = true;
  14142. } else if (self.custom_ca_loaded_) {
  14143. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  14144. ca_cert_pem_.size());
  14145. }
  14146. redirect_client.set_session_verifier(self.session_verifier_);
  14147. if (self.server_certificate_verifier_) {
  14148. redirect_client.set_server_certificate_verifier(
  14149. self.server_certificate_verifier_);
  14150. }
  14151. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  14152. redirect_client.enable_windows_cert_verification_ =
  14153. self.enable_windows_cert_verification_;
  14154. #endif
  14155. }
  14156. // Client certificates are set through constructor for SSLClient
  14157. // NOTE: SSLClient constructor already takes client_cert_path and
  14158. // client_key_path so we need to create it properly if client certs are
  14159. // needed
  14160. // Execute the redirect
  14161. return detail::redirect(redirect_client, req, res, path, location, error);
  14162. #else
  14163. // SSL not supported - set appropriate error
  14164. error = Error::SSLConnection;
  14165. return false;
  14166. #endif
  14167. } else {
  14168. // HTTP redirect
  14169. ClientImpl redirect_client(host, port);
  14170. // Setup client with robust configuration
  14171. setup_redirect_client(redirect_client);
  14172. // Execute the redirect
  14173. return detail::redirect(redirect_client, req, res, path, location, error);
  14174. }
  14175. }
  14176. // New method for robust client setup (based on basic_manual_redirect.cpp
  14177. // logic)
  14178. template <typename ClientType>
  14179. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  14180. // Copy basic settings first
  14181. client.set_connection_timeout(connection_timeout_sec_,
  14182. connection_timeout_usec_);
  14183. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14184. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  14185. client.set_max_timeout(max_timeout_msec_);
  14186. if (has_payload_max_length_) {
  14187. client.set_payload_max_length(payload_max_length_);
  14188. }
  14189. client.set_keep_alive(keep_alive_);
  14190. client.set_follow_location(
  14191. true); // Enable redirects to handle multi-step redirects
  14192. client.set_path_encode(path_encode_);
  14193. client.set_compress(compress_);
  14194. client.set_decompress(decompress_);
  14195. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  14196. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  14197. // 15.4, credentials must not be forwarded when redirecting to a different
  14198. // host. This function is only called for cross-host redirects; same-host
  14199. // redirects are handled directly in ClientImpl::redirect().
  14200. // Copy the proxy configuration unconditionally; the per-target bypass is
  14201. // re-evaluated at send time, so a later hop to a non-bypassed host can
  14202. // still use the proxy.
  14203. client.no_proxy_entries_ = no_proxy_entries_;
  14204. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14205. client.set_proxy(proxy_host_, proxy_port_);
  14206. if (!proxy_basic_auth_username_.empty() ||
  14207. !proxy_basic_auth_password_.empty()) {
  14208. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14209. proxy_basic_auth_password_);
  14210. }
  14211. if (!proxy_bearer_token_auth_token_.empty()) {
  14212. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14213. }
  14214. #ifdef CPPHTTPLIB_SSL_ENABLED
  14215. if (!proxy_digest_auth_username_.empty()) {
  14216. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14217. proxy_digest_auth_password_);
  14218. }
  14219. #endif
  14220. }
  14221. // Copy network and socket settings
  14222. client.addr_map_ = addr_map_;
  14223. client.tunnel_addr_map_ = tunnel_addr_map_;
  14224. // A Unix socket client reaches every host through its own socket, as curl's
  14225. // --unix-socket does, unless the caller mapped that host elsewhere. The
  14226. // Location's host is never taken as a socket path.
  14227. if (address_family_ == AF_UNIX) {
  14228. auto &target = client.addr_map_[client.host()];
  14229. if (target.empty()) { target = detail::addr_map_target(addr_map_, host_); }
  14230. }
  14231. client.set_address_family(address_family_);
  14232. client.set_tcp_nodelay(tcp_nodelay_);
  14233. client.set_ipv6_v6only(ipv6_v6only_);
  14234. if (socket_options_) { client.set_socket_options(socket_options_); }
  14235. if (!interface_.empty()) { client.set_interface(interface_); }
  14236. // Copy logging and headers. Not the error logger: a failure comes back to
  14237. // this client's send(), which reports it with the caller's request.
  14238. if (logger_) { client.set_logger(logger_); }
  14239. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14240. // Each new client should generate its own headers based on its target host
  14241. }
  14242. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14243. const Request &req,
  14244. Error &error) const {
  14245. auto is_shutting_down = []() { return false; };
  14246. if (req.is_chunked_content_provider_) {
  14247. auto compressor = compress_ ? detail::create_compressor().first
  14248. : std::unique_ptr<detail::compressor>();
  14249. if (!compressor) {
  14250. compressor = detail::make_unique<detail::nocompressor>();
  14251. }
  14252. return detail::write_content_chunked(strm, req.content_provider_,
  14253. is_shutting_down, *compressor, error);
  14254. } else {
  14255. return detail::write_content_with_progress(
  14256. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14257. req.upload_progress, error);
  14258. }
  14259. }
  14260. // What goes on the request line for req: its path, encoded and without the
  14261. // fragment, with `req.params` as the query when the path has none.
  14262. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14263. auto target = detail::encode_request_target(req.path, path_encode_);
  14264. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14265. target = append_query_params(target, req.params);
  14266. }
  14267. return target;
  14268. }
  14269. inline void ClientImpl::add_credential_headers(Request &req) {
  14270. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14271. // it opens is read by the origin. Each credential goes only to its own hop.
  14272. auto is_connect = req.method == "CONNECT";
  14273. if (!is_connect) {
  14274. detail::add_authorization_header(req, basic_auth_username_,
  14275. basic_auth_password_,
  14276. bearer_token_auth_token_, false);
  14277. }
  14278. // Proxy-Authorization is only sent when the proxy reads this message —
  14279. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14280. // would leak proxy credentials to the destination server.
  14281. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14282. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14283. proxy_basic_auth_password_,
  14284. proxy_bearer_token_auth_token_, true);
  14285. }
  14286. }
  14287. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14288. bool close_connection, Error &error,
  14289. bool skip_body, bool &rejected_locally) {
  14290. rejected_locally = false;
  14291. // Prepare additional headers
  14292. if (close_connection) {
  14293. if (!req.has_header("Connection")) {
  14294. req.set_header("Connection", "close");
  14295. }
  14296. }
  14297. std::string ct_for_defaults;
  14298. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14299. ct_for_defaults = "text/plain";
  14300. }
  14301. prepare_default_headers(req, false, ct_for_defaults);
  14302. if (req.body.empty()) {
  14303. if (req.content_provider_) {
  14304. if (!req.is_chunked_content_provider_) {
  14305. if (!req.has_header("Content-Length")) {
  14306. auto length = std::to_string(req.content_length_);
  14307. req.set_header("Content-Length", length);
  14308. }
  14309. }
  14310. } else {
  14311. if (req.method == "POST" || req.method == "PUT" ||
  14312. req.method == "PATCH") {
  14313. req.set_header("Content-Length", "0");
  14314. }
  14315. }
  14316. }
  14317. add_credential_headers(req);
  14318. // Request line and headers
  14319. {
  14320. detail::BufferStream bstrm;
  14321. auto path_with_query = make_request_target(req);
  14322. // The query already came in through `req.path`; still populate
  14323. // `req.params` for handlers/users who read them.
  14324. auto query_part = detail::query_of(req.path);
  14325. if (!query_part.empty()) {
  14326. detail::parse_query_text(query_part, req.params);
  14327. }
  14328. // Write request line and headers
  14329. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14330. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14331. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14332. // fail the request cleanly instead of emitting a request-line-less,
  14333. // header-injecting request.
  14334. error = Error::Write;
  14335. rejected_locally = true;
  14336. return false;
  14337. }
  14338. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14339. error)) {
  14340. rejected_locally = true;
  14341. return false;
  14342. }
  14343. // Flush buffer
  14344. auto &data = bstrm.get_buffer();
  14345. if (!detail::write_data(strm, data.data(), data.size())) {
  14346. error = Error::Write;
  14347. return false;
  14348. }
  14349. }
  14350. // After sending request line and headers, wait briefly for an early server
  14351. // response (e.g. 4xx) and avoid sending a potentially large request body
  14352. // unnecessarily. This workaround is only enabled on Windows because Unix
  14353. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14354. // buffering can accept large writes even when the peer already responded.
  14355. // Check the stream first (which covers SSL via `is_readable()`), then
  14356. // fall back to select on the socket. Only perform the wait for very large
  14357. // request bodies to avoid interfering with normal small requests and
  14358. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14359. // response. Skip this check when using Expect: 100-continue, as the protocol
  14360. // handles early responses properly.
  14361. #if defined(_WIN32)
  14362. if (!skip_body &&
  14363. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14364. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14365. auto start = std::chrono::high_resolution_clock::now();
  14366. for (;;) {
  14367. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14368. // from SSL internals. If the underlying socket is readable, assume an
  14369. // early response may be present.
  14370. auto sock = strm.socket();
  14371. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14372. return false;
  14373. }
  14374. // Fallback to stream-level check for non-socket streams or when the
  14375. // socket isn't reporting readable. Avoid using `is_readable()` for
  14376. // SSL, since `SSL_pending()` may report buffered records that do not
  14377. // indicate a complete application-level response yet.
  14378. if (!is_ssl() && strm.is_readable()) { return false; }
  14379. auto now = std::chrono::high_resolution_clock::now();
  14380. auto elapsed =
  14381. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14382. .count();
  14383. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14384. break;
  14385. }
  14386. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14387. }
  14388. }
  14389. #endif
  14390. // Body
  14391. if (skip_body) { return true; }
  14392. return write_request_body(strm, req, error);
  14393. }
  14394. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14395. Error &error) {
  14396. if (req.body.empty()) {
  14397. return write_content_with_provider(strm, req, error);
  14398. }
  14399. if (req.upload_progress) {
  14400. auto body_size = req.body.size();
  14401. size_t written = 0;
  14402. auto data = req.body.data();
  14403. while (written < body_size) {
  14404. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14405. if (!detail::write_data(strm, data + written, to_write)) {
  14406. error = Error::Write;
  14407. return false;
  14408. }
  14409. written += to_write;
  14410. if (!req.upload_progress(written, body_size)) {
  14411. error = Error::Canceled;
  14412. return false;
  14413. }
  14414. }
  14415. } else {
  14416. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14417. error = Error::Write;
  14418. return false;
  14419. }
  14420. }
  14421. return true;
  14422. }
  14423. inline std::unique_ptr<Response>
  14424. ClientImpl::send_with_content_provider_and_receiver(
  14425. Request &req, const char *body, size_t content_length,
  14426. ContentProvider content_provider,
  14427. ContentProviderWithoutLength content_provider_without_length,
  14428. const std::string &content_type, ContentReceiver content_receiver,
  14429. Error &error) {
  14430. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14431. auto enc = compress_
  14432. ? detail::create_compressor()
  14433. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14434. nullptr, nullptr);
  14435. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14436. if (enc.first && !content_provider_without_length) {
  14437. auto &compressor = enc.first;
  14438. if (content_provider) {
  14439. auto ok = true;
  14440. auto finished = false;
  14441. size_t offset = 0;
  14442. DataSink data_sink;
  14443. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14444. if (ok) {
  14445. auto last = offset + data_len == content_length;
  14446. auto ret = compressor->compress(
  14447. data, data_len, last,
  14448. [&](const char *compressed_data, size_t compressed_data_len) {
  14449. req.body.append(compressed_data, compressed_data_len);
  14450. return true;
  14451. });
  14452. if (ret) {
  14453. offset += data_len;
  14454. } else {
  14455. ok = false;
  14456. }
  14457. }
  14458. return ok;
  14459. };
  14460. // As in detail::write_content_with_progress(): the body is framed by
  14461. // content_length, so a provider that finishes early has truncated it.
  14462. // Stop and report that instead of calling the provider forever.
  14463. data_sink.done = [&]() { finished = true; };
  14464. while (ok && !finished && offset < content_length) {
  14465. if (!content_provider(offset, content_length - offset, data_sink)) {
  14466. error = Error::Canceled;
  14467. output_error_log(error, &req);
  14468. return nullptr;
  14469. }
  14470. }
  14471. // A short body here means either the provider stopped early or the
  14472. // compressor gave up. The branch below reports a failing compressor as
  14473. // Error::Compression, so keep the two distinguishable.
  14474. if (offset < content_length) {
  14475. error = ok ? Error::Write : Error::Compression;
  14476. output_error_log(error, &req);
  14477. return nullptr;
  14478. }
  14479. } else {
  14480. if (!compressor->compress(body, content_length, true,
  14481. [&](const char *data, size_t data_len) {
  14482. req.body.append(data, data_len);
  14483. return true;
  14484. })) {
  14485. error = Error::Compression;
  14486. output_error_log(error, &req);
  14487. return nullptr;
  14488. }
  14489. }
  14490. } else {
  14491. if (content_provider) {
  14492. req.content_length_ = content_length;
  14493. req.content_provider_ = std::move(content_provider);
  14494. req.is_chunked_content_provider_ = false;
  14495. } else if (content_provider_without_length) {
  14496. req.content_length_ = 0;
  14497. req.content_provider_ = detail::ContentProviderAdapter(
  14498. std::move(content_provider_without_length));
  14499. req.is_chunked_content_provider_ = true;
  14500. req.set_header("Transfer-Encoding", "chunked");
  14501. } else {
  14502. req.body.assign(body, content_length);
  14503. }
  14504. }
  14505. if (content_receiver) {
  14506. req.content_receiver =
  14507. [content_receiver](const char *data, size_t data_length,
  14508. size_t /*offset*/, size_t /*total_length*/) {
  14509. return content_receiver(data, data_length);
  14510. };
  14511. }
  14512. auto res = detail::make_unique<Response>();
  14513. return send(req, *res, error) ? std::move(res) : nullptr;
  14514. }
  14515. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14516. const std::string &method, const std::string &path, const Headers &headers,
  14517. const char *body, size_t content_length, ContentProvider content_provider,
  14518. ContentProviderWithoutLength content_provider_without_length,
  14519. const std::string &content_type, ContentReceiver content_receiver,
  14520. UploadProgress progress) {
  14521. Request req;
  14522. req.method = method;
  14523. req.headers = headers;
  14524. req.path = path;
  14525. req.upload_progress = std::move(progress);
  14526. if (max_timeout_msec_ > 0) {
  14527. req.start_time_ = std::chrono::steady_clock::now();
  14528. }
  14529. auto error = Error::Success;
  14530. #ifdef CPPHTTPLIB_SSL_ENABLED
  14531. // Hold the request lock until the Result has read this request's TLS error
  14532. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14533. #endif
  14534. auto res = send_with_content_provider_and_receiver(
  14535. req, body, content_length, std::move(content_provider),
  14536. std::move(content_provider_without_length), content_type,
  14537. std::move(content_receiver), error);
  14538. #ifdef CPPHTTPLIB_SSL_ENABLED
  14539. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14540. last_backend_error_};
  14541. #else
  14542. return Result{std::move(res), error, std::move(req.headers)};
  14543. #endif
  14544. }
  14545. inline void ClientImpl::output_log(const Request &req,
  14546. const Response &res) const {
  14547. if (logger_) {
  14548. std::lock_guard<std::mutex> guard(logger_mutex_);
  14549. logger_(req, res);
  14550. }
  14551. }
  14552. inline void ClientImpl::output_error_log(const Error &err,
  14553. const Request *req) const {
  14554. if (error_logger_) {
  14555. std::lock_guard<std::mutex> guard(logger_mutex_);
  14556. error_logger_(err, req);
  14557. }
  14558. }
  14559. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14560. Response &res, bool close_connection,
  14561. Error &error) {
  14562. // Auto-add Expect: 100-continue for large bodies
  14563. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14564. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14565. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14566. req.set_header("Expect", "100-continue");
  14567. }
  14568. }
  14569. // Check for Expect: 100-continue
  14570. auto expect_100_continue =
  14571. detail::has_header_token(req.headers, "Expect", "100-continue");
  14572. // Send request (skip body if using Expect: 100-continue)
  14573. auto rejected_locally = false;
  14574. auto write_request_success =
  14575. write_request(strm, req, close_connection, error, expect_100_continue,
  14576. rejected_locally);
  14577. // A failed write normally still reads the response below, since the server
  14578. // may have answered early (e.g. 413/414) and closed while the body was being
  14579. // sent. A request rejected before any byte reached the socket gets no such
  14580. // response, and waiting for one would block until the read timeout.
  14581. if (rejected_locally) { return false; }
  14582. #ifdef CPPHTTPLIB_SSL_ENABLED
  14583. if (is_ssl() && !expect_100_continue) {
  14584. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14585. if (!is_proxy_enabled) {
  14586. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14587. error = Error::SSLPeerCouldBeClosed_;
  14588. return false;
  14589. }
  14590. }
  14591. }
  14592. #endif
  14593. // Handle Expect: 100-continue.
  14594. //
  14595. // Wait for an interim/early response by attempting to read the status line
  14596. // under a short timeout, instead of trusting raw socket readability. Over
  14597. // TLS, post-handshake records (e.g. session tickets) make the socket
  14598. // readable without any HTTP response being available; relying on
  14599. // `select_read` there caused the body to be withheld forever and the
  14600. // request to fail with `Read` (#2458). If no status line arrives within the
  14601. // timeout, send the body anyway (matching curl's behavior).
  14602. auto status_line_read = false;
  14603. if (expect_100_continue && write_request_success) {
  14604. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14605. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14606. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14607. strm.set_read_timeout(sec, usec);
  14608. status_line_read = read_response_line(strm, req, res, false);
  14609. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14610. }
  14611. if (!status_line_read) {
  14612. // No interim response within the timeout: send the body and handle the
  14613. // response as usual.
  14614. if (!write_request_body(strm, req, error)) { return false; }
  14615. expect_100_continue = false; // Switch to normal response handling
  14616. }
  14617. }
  14618. // Receive response and headers
  14619. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14620. if ((!status_line_read &&
  14621. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14622. !detail::read_headers(strm, res.headers)) {
  14623. if (write_request_success) { error = Error::Read; }
  14624. return false;
  14625. }
  14626. if (!write_request_success) { return false; }
  14627. // Handle Expect: 100-continue response
  14628. if (expect_100_continue) {
  14629. if (res.status == StatusCode::Continue_100) {
  14630. // Server accepted, send the body
  14631. if (!write_request_body(strm, req, error)) { return false; }
  14632. // Read the actual response
  14633. res.headers.clear();
  14634. res.body.clear();
  14635. if (!read_response_line(strm, req, res) ||
  14636. !detail::read_headers(strm, res.headers)) {
  14637. error = Error::Read;
  14638. return false;
  14639. }
  14640. } else {
  14641. // A final response came first, so the body this request declared was
  14642. // never sent, and the server may still be waiting for it. The
  14643. // connection cannot carry another request.
  14644. std::lock_guard<std::mutex> guard(socket_mutex_);
  14645. socket_should_be_closed_when_request_is_done_ = true;
  14646. }
  14647. }
  14648. // Body
  14649. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14650. req.method != "CONNECT") {
  14651. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14652. // whose final transfer coding is not chunked is not ambiguous: its body
  14653. // runs until the server closes the connection, so it is not rejected.
  14654. // HEAD/204 are excluded above and a 304 carries no body.
  14655. if (res.status != StatusCode::NotModified_304) {
  14656. if (detail::has_conflicting_content_length(res.headers)) {
  14657. error = Error::Read;
  14658. return false;
  14659. }
  14660. if (detail::has_faulty_transfer_encoding(res)) {
  14661. std::lock_guard<std::mutex> guard(socket_mutex_);
  14662. socket_should_be_closed_when_request_is_done_ = true;
  14663. }
  14664. }
  14665. auto redirect = follow_location_ && detail::is_redirect(res);
  14666. if (req.response_handler && !redirect) {
  14667. if (!req.response_handler(res)) {
  14668. error = Error::Canceled;
  14669. return false;
  14670. }
  14671. }
  14672. auto out =
  14673. req.content_receiver
  14674. ? static_cast<ContentReceiverWithProgress>(
  14675. [&](const char *buf, size_t n, size_t off, size_t len) {
  14676. if (redirect) { return true; }
  14677. auto ret = req.content_receiver(buf, n, off, len);
  14678. if (!ret) { error = Error::Canceled; }
  14679. return ret;
  14680. })
  14681. : static_cast<ContentReceiverWithProgress>(
  14682. [&](const char *buf, size_t n, size_t /*off*/,
  14683. size_t /*len*/) {
  14684. assert(res.body.size() + n <= res.body.max_size());
  14685. if (payload_max_length_ > 0 &&
  14686. (res.body.size() >= payload_max_length_ ||
  14687. n > payload_max_length_ - res.body.size())) {
  14688. return false;
  14689. }
  14690. res.body.append(buf, n);
  14691. return true;
  14692. });
  14693. auto progress = [&](size_t current, size_t total) {
  14694. if (!req.download_progress || redirect) { return true; }
  14695. auto ret = req.download_progress(current, total);
  14696. if (!ret) { error = Error::Canceled; }
  14697. return ret;
  14698. };
  14699. if (res.has_header("Content-Length")) {
  14700. if (!req.content_receiver) {
  14701. auto len = res.get_header_value_u64("Content-Length");
  14702. if (len > res.body.max_size()) {
  14703. error = Error::Read;
  14704. return false;
  14705. }
  14706. // Content-Length is only the server's claim, so reserve no more than
  14707. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14708. // body has arrived. A longer body grows as it is read.
  14709. auto reserve_len =
  14710. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14711. if (payload_max_length_ > 0) {
  14712. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14713. }
  14714. res.body.reserve(reserve_len);
  14715. }
  14716. }
  14717. if (res.status != StatusCode::NotModified_304) {
  14718. auto content_status = 0;
  14719. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14720. ? (std::numeric_limits<size_t>::max)()
  14721. : payload_max_length_;
  14722. if (!detail::read_content(strm, res, max_length, content_status,
  14723. std::move(progress), std::move(out),
  14724. decompress_)) {
  14725. if (error != Error::Canceled) {
  14726. // Tell the caller apart from a plain read failure when the body was
  14727. // over the payload limit or could not be decoded because of its
  14728. // Content-Encoding.
  14729. switch (content_status) {
  14730. case StatusCode::PayloadTooLarge_413:
  14731. error = Error::ExceedMaxPayloadSize;
  14732. break;
  14733. case StatusCode::UnsupportedMediaType_415:
  14734. error = Error::UnsupportedContentEncoding;
  14735. break;
  14736. case StatusCode::InternalServerError_500:
  14737. error = Error::Compression;
  14738. break;
  14739. default: error = Error::Read; break;
  14740. }
  14741. }
  14742. return false;
  14743. }
  14744. }
  14745. }
  14746. // Log
  14747. output_log(req, res);
  14748. return true;
  14749. }
  14750. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14751. const std::string &boundary, const UploadFormDataItems &items,
  14752. const FormDataProviderItems &provider_items) const {
  14753. size_t cur_item = 0;
  14754. size_t cur_start = 0;
  14755. // cur_item and cur_start are copied to within the std::function and
  14756. // maintain state between successive calls
  14757. return [&, cur_item, cur_start](size_t offset,
  14758. DataSink &sink) mutable -> bool {
  14759. if (!offset && !items.empty()) {
  14760. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14761. return true;
  14762. } else if (cur_item < provider_items.size()) {
  14763. if (!cur_start) {
  14764. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14765. provider_items[cur_item], boundary);
  14766. offset += begin.size();
  14767. cur_start = offset;
  14768. sink.os << begin;
  14769. }
  14770. DataSink cur_sink;
  14771. auto has_data = true;
  14772. cur_sink.write = sink.write;
  14773. // Forward is_writable so a provider item asking whether it may keep
  14774. // going gets the outer sink's answer rather than the default `true`.
  14775. cur_sink.is_writable = sink.is_writable;
  14776. cur_sink.done = [&]() { has_data = false; };
  14777. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14778. return false;
  14779. }
  14780. if (!has_data) {
  14781. sink.os << detail::serialize_multipart_formdata_item_end();
  14782. cur_item++;
  14783. cur_start = 0;
  14784. }
  14785. return true;
  14786. } else {
  14787. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14788. sink.done();
  14789. return true;
  14790. }
  14791. };
  14792. }
  14793. inline bool ClientImpl::process_socket(
  14794. const Socket &socket,
  14795. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14796. std::function<bool(Stream &strm)> callback) {
  14797. return detail::process_client_socket(
  14798. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14799. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14800. }
  14801. inline bool ClientImpl::is_ssl() const { return false; }
  14802. inline Result ClientImpl::Get(const std::string &path,
  14803. DownloadProgress progress) {
  14804. return Get(path, Headers(), std::move(progress));
  14805. }
  14806. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14807. DownloadProgress progress) {
  14808. return Get(path, params, Headers(), std::move(progress));
  14809. }
  14810. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14811. const Headers &headers,
  14812. DownloadProgress progress) {
  14813. if (params.empty()) { return Get(path, headers); }
  14814. std::string path_with_query = append_query_params(path, params);
  14815. return Get(path_with_query, headers, std::move(progress));
  14816. }
  14817. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14818. DownloadProgress progress) {
  14819. Request req;
  14820. req.method = "GET";
  14821. req.path = path;
  14822. req.headers = headers;
  14823. req.download_progress = std::move(progress);
  14824. if (max_timeout_msec_ > 0) {
  14825. req.start_time_ = std::chrono::steady_clock::now();
  14826. }
  14827. return send_(std::move(req));
  14828. }
  14829. inline Result ClientImpl::Get(const std::string &path,
  14830. ContentReceiver content_receiver,
  14831. DownloadProgress progress) {
  14832. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14833. std::move(progress));
  14834. }
  14835. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14836. ContentReceiver content_receiver,
  14837. DownloadProgress progress) {
  14838. return Get(path, headers, nullptr, std::move(content_receiver),
  14839. std::move(progress));
  14840. }
  14841. inline Result ClientImpl::Get(const std::string &path,
  14842. ResponseHandler response_handler,
  14843. ContentReceiver content_receiver,
  14844. DownloadProgress progress) {
  14845. return Get(path, Headers(), std::move(response_handler),
  14846. std::move(content_receiver), std::move(progress));
  14847. }
  14848. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14849. ResponseHandler response_handler,
  14850. ContentReceiver content_receiver,
  14851. DownloadProgress progress) {
  14852. Request req;
  14853. req.method = "GET";
  14854. req.path = path;
  14855. req.headers = headers;
  14856. req.response_handler = std::move(response_handler);
  14857. req.content_receiver =
  14858. [content_receiver](const char *data, size_t data_length,
  14859. size_t /*offset*/, size_t /*total_length*/) {
  14860. return content_receiver(data, data_length);
  14861. };
  14862. req.download_progress = std::move(progress);
  14863. if (max_timeout_msec_ > 0) {
  14864. req.start_time_ = std::chrono::steady_clock::now();
  14865. }
  14866. return send_(std::move(req));
  14867. }
  14868. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14869. const Headers &headers,
  14870. ContentReceiver content_receiver,
  14871. DownloadProgress progress) {
  14872. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14873. std::move(progress));
  14874. }
  14875. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14876. const Headers &headers,
  14877. ResponseHandler response_handler,
  14878. ContentReceiver content_receiver,
  14879. DownloadProgress progress) {
  14880. if (params.empty()) {
  14881. return Get(path, headers, std::move(response_handler),
  14882. std::move(content_receiver), std::move(progress));
  14883. }
  14884. std::string path_with_query = append_query_params(path, params);
  14885. return Get(path_with_query, headers, std::move(response_handler),
  14886. std::move(content_receiver), std::move(progress));
  14887. }
  14888. inline Result ClientImpl::Head(const std::string &path) {
  14889. return Head(path, Headers());
  14890. }
  14891. inline Result ClientImpl::Head(const std::string &path,
  14892. const Headers &headers) {
  14893. Request req;
  14894. req.method = "HEAD";
  14895. req.headers = headers;
  14896. req.path = path;
  14897. if (max_timeout_msec_ > 0) {
  14898. req.start_time_ = std::chrono::steady_clock::now();
  14899. }
  14900. return send_(std::move(req));
  14901. }
  14902. inline Result ClientImpl::Post(const std::string &path) {
  14903. return Post(path, std::string(), std::string());
  14904. }
  14905. inline Result ClientImpl::Post(const std::string &path,
  14906. const Headers &headers) {
  14907. return Post(path, headers, nullptr, 0, std::string());
  14908. }
  14909. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14910. size_t content_length,
  14911. const std::string &content_type,
  14912. UploadProgress progress) {
  14913. return Post(path, Headers(), body, content_length, content_type, progress);
  14914. }
  14915. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14916. const std::string &content_type,
  14917. UploadProgress progress) {
  14918. return Post(path, Headers(), body, content_type, progress);
  14919. }
  14920. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14921. return Post(path, Headers(), params);
  14922. }
  14923. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14924. ContentProvider content_provider,
  14925. const std::string &content_type,
  14926. UploadProgress progress) {
  14927. return Post(path, Headers(), content_length, std::move(content_provider),
  14928. content_type, progress);
  14929. }
  14930. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14931. ContentProvider content_provider,
  14932. const std::string &content_type,
  14933. ContentReceiver content_receiver,
  14934. UploadProgress progress) {
  14935. return Post(path, Headers(), content_length, std::move(content_provider),
  14936. content_type, std::move(content_receiver), progress);
  14937. }
  14938. inline Result ClientImpl::Post(const std::string &path,
  14939. ContentProviderWithoutLength content_provider,
  14940. const std::string &content_type,
  14941. UploadProgress progress) {
  14942. return Post(path, Headers(), std::move(content_provider), content_type,
  14943. progress);
  14944. }
  14945. inline Result ClientImpl::Post(const std::string &path,
  14946. ContentProviderWithoutLength content_provider,
  14947. const std::string &content_type,
  14948. ContentReceiver content_receiver,
  14949. UploadProgress progress) {
  14950. return Post(path, Headers(), std::move(content_provider), content_type,
  14951. std::move(content_receiver), progress);
  14952. }
  14953. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14954. const Params &params) {
  14955. auto query = detail::params_to_query_str(params);
  14956. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14957. }
  14958. inline Result ClientImpl::Post(const std::string &path,
  14959. const UploadFormDataItems &items,
  14960. UploadProgress progress) {
  14961. return Post(path, Headers(), items, progress);
  14962. }
  14963. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14964. const UploadFormDataItems &items,
  14965. UploadProgress progress) {
  14966. const auto &boundary = detail::make_multipart_data_boundary();
  14967. const auto &content_type =
  14968. detail::serialize_multipart_formdata_get_content_type(boundary);
  14969. auto content_length = detail::get_multipart_content_length(items, boundary);
  14970. return Post(path, headers, content_length,
  14971. detail::make_multipart_content_provider(items, boundary),
  14972. content_type, progress);
  14973. }
  14974. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14975. const UploadFormDataItems &items,
  14976. const std::string &boundary,
  14977. UploadProgress progress) {
  14978. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14979. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14980. }
  14981. const auto &content_type =
  14982. detail::serialize_multipart_formdata_get_content_type(boundary);
  14983. auto content_length = detail::get_multipart_content_length(items, boundary);
  14984. return Post(path, headers, content_length,
  14985. detail::make_multipart_content_provider(items, boundary),
  14986. content_type, progress);
  14987. }
  14988. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14989. const char *body, size_t content_length,
  14990. const std::string &content_type,
  14991. UploadProgress progress) {
  14992. return send_with_content_provider_and_receiver(
  14993. "POST", path, headers, body, content_length, nullptr, nullptr,
  14994. content_type, nullptr, progress);
  14995. }
  14996. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14997. const std::string &body,
  14998. const std::string &content_type,
  14999. UploadProgress progress) {
  15000. return send_with_content_provider_and_receiver(
  15001. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  15002. content_type, nullptr, progress);
  15003. }
  15004. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15005. size_t content_length,
  15006. ContentProvider content_provider,
  15007. const std::string &content_type,
  15008. UploadProgress progress) {
  15009. return send_with_content_provider_and_receiver(
  15010. "POST", path, headers, nullptr, content_length,
  15011. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15012. }
  15013. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15014. size_t content_length,
  15015. ContentProvider content_provider,
  15016. const std::string &content_type,
  15017. ContentReceiver content_receiver,
  15018. DownloadProgress progress) {
  15019. return send_with_content_provider_and_receiver(
  15020. "POST", path, headers, nullptr, content_length,
  15021. std::move(content_provider), nullptr, content_type,
  15022. std::move(content_receiver), std::move(progress));
  15023. }
  15024. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15025. ContentProviderWithoutLength content_provider,
  15026. const std::string &content_type,
  15027. UploadProgress progress) {
  15028. return send_with_content_provider_and_receiver(
  15029. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15030. content_type, nullptr, progress);
  15031. }
  15032. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15033. ContentProviderWithoutLength content_provider,
  15034. const std::string &content_type,
  15035. ContentReceiver content_receiver,
  15036. DownloadProgress progress) {
  15037. return send_with_content_provider_and_receiver(
  15038. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15039. content_type, std::move(content_receiver), std::move(progress));
  15040. }
  15041. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15042. const UploadFormDataItems &items,
  15043. const FormDataProviderItems &provider_items,
  15044. UploadProgress progress) {
  15045. const auto &boundary = detail::make_multipart_data_boundary();
  15046. const auto &content_type =
  15047. detail::serialize_multipart_formdata_get_content_type(boundary);
  15048. return send_with_content_provider_and_receiver(
  15049. "POST", path, headers, nullptr, 0, nullptr,
  15050. get_multipart_content_provider(boundary, items, provider_items),
  15051. content_type, nullptr, progress);
  15052. }
  15053. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  15054. const std::string &body,
  15055. const std::string &content_type,
  15056. ContentReceiver content_receiver,
  15057. DownloadProgress progress) {
  15058. Request req;
  15059. req.method = "POST";
  15060. req.path = path;
  15061. req.headers = headers;
  15062. req.body = body;
  15063. req.content_receiver =
  15064. [content_receiver](const char *data, size_t data_length,
  15065. size_t /*offset*/, size_t /*total_length*/) {
  15066. return content_receiver(data, data_length);
  15067. };
  15068. req.download_progress = std::move(progress);
  15069. if (max_timeout_msec_ > 0) {
  15070. req.start_time_ = std::chrono::steady_clock::now();
  15071. }
  15072. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15073. return send_(std::move(req));
  15074. }
  15075. inline Result ClientImpl::Put(const std::string &path) {
  15076. return Put(path, std::string(), std::string());
  15077. }
  15078. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  15079. return Put(path, headers, nullptr, 0, std::string());
  15080. }
  15081. inline Result ClientImpl::Put(const std::string &path, const char *body,
  15082. size_t content_length,
  15083. const std::string &content_type,
  15084. UploadProgress progress) {
  15085. return Put(path, Headers(), body, content_length, content_type, progress);
  15086. }
  15087. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  15088. const std::string &content_type,
  15089. UploadProgress progress) {
  15090. return Put(path, Headers(), body, content_type, progress);
  15091. }
  15092. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  15093. return Put(path, Headers(), params);
  15094. }
  15095. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15096. ContentProvider content_provider,
  15097. const std::string &content_type,
  15098. UploadProgress progress) {
  15099. return Put(path, Headers(), content_length, std::move(content_provider),
  15100. content_type, progress);
  15101. }
  15102. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  15103. ContentProvider content_provider,
  15104. const std::string &content_type,
  15105. ContentReceiver content_receiver,
  15106. UploadProgress progress) {
  15107. return Put(path, Headers(), content_length, std::move(content_provider),
  15108. content_type, std::move(content_receiver), progress);
  15109. }
  15110. inline Result ClientImpl::Put(const std::string &path,
  15111. ContentProviderWithoutLength content_provider,
  15112. const std::string &content_type,
  15113. UploadProgress progress) {
  15114. return Put(path, Headers(), std::move(content_provider), content_type,
  15115. progress);
  15116. }
  15117. inline Result ClientImpl::Put(const std::string &path,
  15118. ContentProviderWithoutLength content_provider,
  15119. const std::string &content_type,
  15120. ContentReceiver content_receiver,
  15121. UploadProgress progress) {
  15122. return Put(path, Headers(), std::move(content_provider), content_type,
  15123. std::move(content_receiver), progress);
  15124. }
  15125. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15126. const Params &params) {
  15127. auto query = detail::params_to_query_str(params);
  15128. return Put(path, headers, query, "application/x-www-form-urlencoded");
  15129. }
  15130. inline Result ClientImpl::Put(const std::string &path,
  15131. const UploadFormDataItems &items,
  15132. UploadProgress progress) {
  15133. return Put(path, Headers(), items, progress);
  15134. }
  15135. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15136. const UploadFormDataItems &items,
  15137. UploadProgress progress) {
  15138. const auto &boundary = detail::make_multipart_data_boundary();
  15139. const auto &content_type =
  15140. detail::serialize_multipart_formdata_get_content_type(boundary);
  15141. auto content_length = detail::get_multipart_content_length(items, boundary);
  15142. return Put(path, headers, content_length,
  15143. detail::make_multipart_content_provider(items, boundary),
  15144. content_type, progress);
  15145. }
  15146. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15147. const UploadFormDataItems &items,
  15148. const std::string &boundary,
  15149. UploadProgress progress) {
  15150. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15151. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15152. }
  15153. const auto &content_type =
  15154. detail::serialize_multipart_formdata_get_content_type(boundary);
  15155. auto content_length = detail::get_multipart_content_length(items, boundary);
  15156. return Put(path, headers, content_length,
  15157. detail::make_multipart_content_provider(items, boundary),
  15158. content_type, progress);
  15159. }
  15160. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15161. const char *body, size_t content_length,
  15162. const std::string &content_type,
  15163. UploadProgress progress) {
  15164. return send_with_content_provider_and_receiver(
  15165. "PUT", path, headers, body, content_length, nullptr, nullptr,
  15166. content_type, nullptr, progress);
  15167. }
  15168. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15169. const std::string &body,
  15170. const std::string &content_type,
  15171. UploadProgress progress) {
  15172. return send_with_content_provider_and_receiver(
  15173. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  15174. content_type, nullptr, progress);
  15175. }
  15176. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15177. size_t content_length,
  15178. ContentProvider content_provider,
  15179. const std::string &content_type,
  15180. UploadProgress progress) {
  15181. return send_with_content_provider_and_receiver(
  15182. "PUT", path, headers, nullptr, content_length,
  15183. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15184. }
  15185. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15186. size_t content_length,
  15187. ContentProvider content_provider,
  15188. const std::string &content_type,
  15189. ContentReceiver content_receiver,
  15190. UploadProgress progress) {
  15191. return send_with_content_provider_and_receiver(
  15192. "PUT", path, headers, nullptr, content_length,
  15193. std::move(content_provider), nullptr, content_type,
  15194. std::move(content_receiver), progress);
  15195. }
  15196. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15197. ContentProviderWithoutLength content_provider,
  15198. const std::string &content_type,
  15199. UploadProgress progress) {
  15200. return send_with_content_provider_and_receiver(
  15201. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15202. content_type, nullptr, progress);
  15203. }
  15204. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15205. ContentProviderWithoutLength content_provider,
  15206. const std::string &content_type,
  15207. ContentReceiver content_receiver,
  15208. UploadProgress progress) {
  15209. return send_with_content_provider_and_receiver(
  15210. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15211. content_type, std::move(content_receiver), progress);
  15212. }
  15213. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15214. const UploadFormDataItems &items,
  15215. const FormDataProviderItems &provider_items,
  15216. UploadProgress progress) {
  15217. const auto &boundary = detail::make_multipart_data_boundary();
  15218. const auto &content_type =
  15219. detail::serialize_multipart_formdata_get_content_type(boundary);
  15220. return send_with_content_provider_and_receiver(
  15221. "PUT", path, headers, nullptr, 0, nullptr,
  15222. get_multipart_content_provider(boundary, items, provider_items),
  15223. content_type, nullptr, progress);
  15224. }
  15225. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15226. const std::string &body,
  15227. const std::string &content_type,
  15228. ContentReceiver content_receiver,
  15229. DownloadProgress progress) {
  15230. Request req;
  15231. req.method = "PUT";
  15232. req.path = path;
  15233. req.headers = headers;
  15234. req.body = body;
  15235. req.content_receiver =
  15236. [content_receiver](const char *data, size_t data_length,
  15237. size_t /*offset*/, size_t /*total_length*/) {
  15238. return content_receiver(data, data_length);
  15239. };
  15240. req.download_progress = std::move(progress);
  15241. if (max_timeout_msec_ > 0) {
  15242. req.start_time_ = std::chrono::steady_clock::now();
  15243. }
  15244. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15245. return send_(std::move(req));
  15246. }
  15247. inline Result ClientImpl::Patch(const std::string &path) {
  15248. return Patch(path, std::string(), std::string());
  15249. }
  15250. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15251. UploadProgress progress) {
  15252. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15253. }
  15254. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15255. size_t content_length,
  15256. const std::string &content_type,
  15257. UploadProgress progress) {
  15258. return Patch(path, Headers(), body, content_length, content_type, progress);
  15259. }
  15260. inline Result ClientImpl::Patch(const std::string &path,
  15261. const std::string &body,
  15262. const std::string &content_type,
  15263. UploadProgress progress) {
  15264. return Patch(path, Headers(), body, content_type, progress);
  15265. }
  15266. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15267. return Patch(path, Headers(), params);
  15268. }
  15269. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15270. ContentProvider content_provider,
  15271. const std::string &content_type,
  15272. UploadProgress progress) {
  15273. return Patch(path, Headers(), content_length, std::move(content_provider),
  15274. content_type, progress);
  15275. }
  15276. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15277. ContentProvider content_provider,
  15278. const std::string &content_type,
  15279. ContentReceiver content_receiver,
  15280. UploadProgress progress) {
  15281. return Patch(path, Headers(), content_length, std::move(content_provider),
  15282. content_type, std::move(content_receiver), progress);
  15283. }
  15284. inline Result ClientImpl::Patch(const std::string &path,
  15285. ContentProviderWithoutLength content_provider,
  15286. const std::string &content_type,
  15287. UploadProgress progress) {
  15288. return Patch(path, Headers(), std::move(content_provider), content_type,
  15289. progress);
  15290. }
  15291. inline Result ClientImpl::Patch(const std::string &path,
  15292. ContentProviderWithoutLength content_provider,
  15293. const std::string &content_type,
  15294. ContentReceiver content_receiver,
  15295. UploadProgress progress) {
  15296. return Patch(path, Headers(), std::move(content_provider), content_type,
  15297. std::move(content_receiver), progress);
  15298. }
  15299. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15300. const Params &params) {
  15301. auto query = detail::params_to_query_str(params);
  15302. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15303. }
  15304. inline Result ClientImpl::Patch(const std::string &path,
  15305. const UploadFormDataItems &items,
  15306. UploadProgress progress) {
  15307. return Patch(path, Headers(), items, progress);
  15308. }
  15309. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15310. const UploadFormDataItems &items,
  15311. UploadProgress progress) {
  15312. const auto &boundary = detail::make_multipart_data_boundary();
  15313. const auto &content_type =
  15314. detail::serialize_multipart_formdata_get_content_type(boundary);
  15315. auto content_length = detail::get_multipart_content_length(items, boundary);
  15316. return Patch(path, headers, content_length,
  15317. detail::make_multipart_content_provider(items, boundary),
  15318. content_type, progress);
  15319. }
  15320. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15321. const UploadFormDataItems &items,
  15322. const std::string &boundary,
  15323. UploadProgress progress) {
  15324. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15325. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15326. }
  15327. const auto &content_type =
  15328. detail::serialize_multipart_formdata_get_content_type(boundary);
  15329. auto content_length = detail::get_multipart_content_length(items, boundary);
  15330. return Patch(path, headers, content_length,
  15331. detail::make_multipart_content_provider(items, boundary),
  15332. content_type, progress);
  15333. }
  15334. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15335. const char *body, size_t content_length,
  15336. const std::string &content_type,
  15337. UploadProgress progress) {
  15338. return send_with_content_provider_and_receiver(
  15339. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15340. content_type, nullptr, progress);
  15341. }
  15342. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15343. const std::string &body,
  15344. const std::string &content_type,
  15345. UploadProgress progress) {
  15346. return send_with_content_provider_and_receiver(
  15347. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15348. content_type, nullptr, progress);
  15349. }
  15350. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15351. size_t content_length,
  15352. ContentProvider content_provider,
  15353. const std::string &content_type,
  15354. UploadProgress progress) {
  15355. return send_with_content_provider_and_receiver(
  15356. "PATCH", path, headers, nullptr, content_length,
  15357. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15358. }
  15359. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15360. size_t content_length,
  15361. ContentProvider content_provider,
  15362. const std::string &content_type,
  15363. ContentReceiver content_receiver,
  15364. UploadProgress progress) {
  15365. return send_with_content_provider_and_receiver(
  15366. "PATCH", path, headers, nullptr, content_length,
  15367. std::move(content_provider), nullptr, content_type,
  15368. std::move(content_receiver), progress);
  15369. }
  15370. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15371. ContentProviderWithoutLength content_provider,
  15372. const std::string &content_type,
  15373. UploadProgress progress) {
  15374. return send_with_content_provider_and_receiver(
  15375. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15376. content_type, nullptr, progress);
  15377. }
  15378. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15379. ContentProviderWithoutLength content_provider,
  15380. const std::string &content_type,
  15381. ContentReceiver content_receiver,
  15382. UploadProgress progress) {
  15383. return send_with_content_provider_and_receiver(
  15384. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15385. content_type, std::move(content_receiver), progress);
  15386. }
  15387. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15388. const UploadFormDataItems &items,
  15389. const FormDataProviderItems &provider_items,
  15390. UploadProgress progress) {
  15391. const auto &boundary = detail::make_multipart_data_boundary();
  15392. const auto &content_type =
  15393. detail::serialize_multipart_formdata_get_content_type(boundary);
  15394. return send_with_content_provider_and_receiver(
  15395. "PATCH", path, headers, nullptr, 0, nullptr,
  15396. get_multipart_content_provider(boundary, items, provider_items),
  15397. content_type, nullptr, progress);
  15398. }
  15399. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15400. const std::string &body,
  15401. const std::string &content_type,
  15402. ContentReceiver content_receiver,
  15403. DownloadProgress progress) {
  15404. Request req;
  15405. req.method = "PATCH";
  15406. req.path = path;
  15407. req.headers = headers;
  15408. req.body = body;
  15409. req.content_receiver =
  15410. [content_receiver](const char *data, size_t data_length,
  15411. size_t /*offset*/, size_t /*total_length*/) {
  15412. return content_receiver(data, data_length);
  15413. };
  15414. req.download_progress = std::move(progress);
  15415. if (max_timeout_msec_ > 0) {
  15416. req.start_time_ = std::chrono::steady_clock::now();
  15417. }
  15418. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15419. return send_(std::move(req));
  15420. }
  15421. inline Result ClientImpl::Delete(const std::string &path,
  15422. DownloadProgress progress) {
  15423. return Delete(path, Headers(), std::string(), std::string(), progress);
  15424. }
  15425. inline Result ClientImpl::Delete(const std::string &path,
  15426. const Headers &headers,
  15427. DownloadProgress progress) {
  15428. return Delete(path, headers, std::string(), std::string(), progress);
  15429. }
  15430. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15431. size_t content_length,
  15432. const std::string &content_type,
  15433. DownloadProgress progress) {
  15434. return Delete(path, Headers(), body, content_length, content_type, progress);
  15435. }
  15436. inline Result ClientImpl::Delete(const std::string &path,
  15437. const std::string &body,
  15438. const std::string &content_type,
  15439. DownloadProgress progress) {
  15440. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15441. progress);
  15442. }
  15443. inline Result ClientImpl::Delete(const std::string &path,
  15444. const Headers &headers,
  15445. const std::string &body,
  15446. const std::string &content_type,
  15447. DownloadProgress progress) {
  15448. return Delete(path, headers, body.data(), body.size(), content_type,
  15449. progress);
  15450. }
  15451. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15452. DownloadProgress progress) {
  15453. return Delete(path, Headers(), params, progress);
  15454. }
  15455. inline Result ClientImpl::Delete(const std::string &path,
  15456. const Headers &headers, const Params &params,
  15457. DownloadProgress progress) {
  15458. auto query = detail::params_to_query_str(params);
  15459. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15460. progress);
  15461. }
  15462. inline Result ClientImpl::Delete(const std::string &path,
  15463. const Headers &headers, const char *body,
  15464. size_t content_length,
  15465. const std::string &content_type,
  15466. DownloadProgress progress) {
  15467. Request req;
  15468. req.method = "DELETE";
  15469. req.headers = headers;
  15470. req.path = path;
  15471. req.download_progress = std::move(progress);
  15472. if (max_timeout_msec_ > 0) {
  15473. req.start_time_ = std::chrono::steady_clock::now();
  15474. }
  15475. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15476. req.body.assign(body, content_length);
  15477. return send_(std::move(req));
  15478. }
  15479. inline Result ClientImpl::Options(const std::string &path) {
  15480. return Options(path, Headers());
  15481. }
  15482. inline Result ClientImpl::Options(const std::string &path,
  15483. const Headers &headers) {
  15484. Request req;
  15485. req.method = "OPTIONS";
  15486. req.headers = headers;
  15487. req.path = path;
  15488. if (max_timeout_msec_ > 0) {
  15489. req.start_time_ = std::chrono::steady_clock::now();
  15490. }
  15491. return send_(std::move(req));
  15492. }
  15493. inline void ClientImpl::stop() {
  15494. std::lock_guard<std::mutex> guard(socket_mutex_);
  15495. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15496. // do is to shutdown_socket, so that threads using this socket suddenly
  15497. // discover they can't read/write any more and error out. Everything else
  15498. // (closing the socket, shutting ssl down) is unsafe because these actions
  15499. // are not thread-safe.
  15500. if (socket_requests_in_flight_ > 0) {
  15501. shutdown_socket(socket_);
  15502. // shutdown() does not wake a read waiting in WSAPoll on Windows, so the
  15503. // request's reads also give up once they see this flag.
  15504. stop_requested_ = true;
  15505. // Aside from that, we set a flag for the socket to be closed when we're
  15506. // done.
  15507. socket_should_be_closed_when_request_is_done_ = true;
  15508. return;
  15509. }
  15510. disconnect(/*gracefully=*/true);
  15511. }
  15512. inline std::string ClientImpl::host() const { return host_; }
  15513. inline int ClientImpl::port() const { return port_; }
  15514. inline size_t ClientImpl::is_socket_open() const {
  15515. std::lock_guard<std::mutex> guard(socket_mutex_);
  15516. return socket_.is_open();
  15517. }
  15518. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15519. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15520. connection_timeout_sec_ = sec;
  15521. connection_timeout_usec_ = usec;
  15522. }
  15523. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15524. read_timeout_sec_ = sec;
  15525. read_timeout_usec_ = usec;
  15526. }
  15527. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15528. write_timeout_sec_ = sec;
  15529. write_timeout_usec_ = usec;
  15530. }
  15531. inline void ClientImpl::set_max_timeout(time_t msec) {
  15532. max_timeout_msec_ = msec;
  15533. }
  15534. inline void ClientImpl::set_basic_auth(const std::string &username,
  15535. const std::string &password) {
  15536. basic_auth_username_ = username;
  15537. basic_auth_password_ = password;
  15538. }
  15539. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15540. bearer_token_auth_token_ = token;
  15541. }
  15542. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15543. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15544. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15545. inline void
  15546. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15547. set_direct_hostname_addr_map(std::move(addr_map));
  15548. }
  15549. inline void ClientImpl::set_direct_hostname_addr_map(
  15550. std::map<std::string, std::string> addr_map) {
  15551. addr_map_ = std::move(addr_map);
  15552. }
  15553. inline void ClientImpl::set_tunnel_hostname_addr_map(
  15554. std::map<std::string, std::string> addr_map) {
  15555. tunnel_addr_map_ = std::move(addr_map);
  15556. }
  15557. inline void ClientImpl::set_default_headers(Headers headers) {
  15558. default_headers_ = std::move(headers);
  15559. }
  15560. inline void ClientImpl::set_header_writer(
  15561. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15562. header_writer_ = writer;
  15563. }
  15564. inline void ClientImpl::set_address_family(int family) {
  15565. address_family_ = family;
  15566. }
  15567. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15568. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15569. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15570. socket_options_ = std::move(socket_options);
  15571. }
  15572. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15573. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15574. inline void ClientImpl::set_payload_max_length(size_t length) {
  15575. payload_max_length_ = length;
  15576. has_payload_max_length_ = true;
  15577. }
  15578. inline void ClientImpl::set_interface(const std::string &intf) {
  15579. interface_ = intf;
  15580. }
  15581. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15582. proxy_host_ = host;
  15583. proxy_port_ = port;
  15584. std::lock_guard<std::mutex> guard(socket_mutex_);
  15585. disconnect(/*gracefully=*/true);
  15586. }
  15587. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15588. const std::string &password) {
  15589. proxy_basic_auth_username_ = username;
  15590. proxy_basic_auth_password_ = password;
  15591. }
  15592. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15593. proxy_bearer_token_auth_token_ = token;
  15594. }
  15595. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15596. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15597. std::lock_guard<std::mutex> guard(socket_mutex_);
  15598. disconnect(/*gracefully=*/true);
  15599. }
  15600. #ifdef CPPHTTPLIB_SSL_ENABLED
  15601. inline void ClientImpl::set_digest_auth(const std::string &username,
  15602. const std::string &password) {
  15603. digest_auth_username_ = username;
  15604. digest_auth_password_ = password;
  15605. }
  15606. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15607. const std::string &ca_cert_dir_path) {
  15608. ca_cert_file_path_ = ca_cert_file_path;
  15609. ca_cert_dir_path_ = ca_cert_dir_path;
  15610. }
  15611. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15612. const std::string &password) {
  15613. proxy_digest_auth_username_ = username;
  15614. proxy_digest_auth_password_ = password;
  15615. }
  15616. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15617. if (server_certificate_verification_ == enabled) { return; }
  15618. server_certificate_verification_ = enabled;
  15619. tls_settings_changed();
  15620. }
  15621. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15622. if (server_hostname_verification_ == enabled) { return; }
  15623. server_hostname_verification_ = enabled;
  15624. tls_settings_changed();
  15625. }
  15626. inline void ClientImpl::enable_system_ca(bool enabled) {
  15627. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15628. }
  15629. #endif
  15630. inline void ClientImpl::set_logger(Logger logger) {
  15631. logger_ = std::move(logger);
  15632. }
  15633. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15634. error_logger_ = std::move(error_logger);
  15635. }
  15636. /*
  15637. * SSL/TLS Common Implementation
  15638. */
  15639. inline ClientConnection::~ClientConnection() {
  15640. #ifdef CPPHTTPLIB_SSL_ENABLED
  15641. if (session) {
  15642. tls::shutdown(session, true);
  15643. tls::free_session(session);
  15644. session = nullptr;
  15645. }
  15646. #endif
  15647. if (sock != INVALID_SOCKET) {
  15648. detail::close_socket(sock);
  15649. sock = INVALID_SOCKET;
  15650. }
  15651. }
  15652. // Universal client implementation
  15653. inline Client::Client(const std::string &scheme_host_port)
  15654. : Client(scheme_host_port, std::string(), std::string()) {}
  15655. inline Client::Client(const std::string &scheme_host_port,
  15656. const std::string &client_cert_path,
  15657. const std::string &client_key_path) {
  15658. detail::UrlComponents uc;
  15659. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15660. auto &scheme = uc.scheme;
  15661. #ifdef CPPHTTPLIB_SSL_ENABLED
  15662. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15663. #else
  15664. if (!scheme.empty() && scheme != "http") {
  15665. #endif
  15666. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15667. std::string msg = "'" + scheme + "' scheme is not supported.";
  15668. throw std::invalid_argument(msg);
  15669. #endif
  15670. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15671. return;
  15672. }
  15673. auto is_ssl = scheme == "https";
  15674. auto host = std::move(uc.host);
  15675. auto port = is_ssl ? 443 : 80;
  15676. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15677. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15678. return;
  15679. }
  15680. if (is_ssl) {
  15681. #ifdef CPPHTTPLIB_SSL_ENABLED
  15682. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15683. client_key_path);
  15684. is_ssl_ = is_ssl;
  15685. #endif
  15686. } else {
  15687. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15688. client_key_path);
  15689. }
  15690. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15691. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15692. // A URL, but not one this client can use, such as one with userinfo. A
  15693. // Unix socket path may have "//" further on.
  15694. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15695. } else {
  15696. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15697. // if port param below changes.
  15698. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15699. client_cert_path, client_key_path);
  15700. }
  15701. }
  15702. inline Client::Client(const std::string &host, int port)
  15703. : Client(host, port, std::string(), std::string()) {}
  15704. inline Client::Client(const std::string &host, int port,
  15705. const std::string &client_cert_path,
  15706. const std::string &client_key_path)
  15707. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15708. client_key_path)) {}
  15709. inline Client::~Client() = default;
  15710. inline bool Client::is_valid() const {
  15711. return cli_ != nullptr && cli_->is_valid();
  15712. }
  15713. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15714. return cli_->Get(path, std::move(progress));
  15715. }
  15716. inline Result Client::Get(const std::string &path, const Headers &headers,
  15717. DownloadProgress progress) {
  15718. return cli_->Get(path, headers, std::move(progress));
  15719. }
  15720. inline Result Client::Get(const std::string &path,
  15721. ContentReceiver content_receiver,
  15722. DownloadProgress progress) {
  15723. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15724. }
  15725. inline Result Client::Get(const std::string &path, const Headers &headers,
  15726. ContentReceiver content_receiver,
  15727. DownloadProgress progress) {
  15728. return cli_->Get(path, headers, std::move(content_receiver),
  15729. std::move(progress));
  15730. }
  15731. inline Result Client::Get(const std::string &path,
  15732. ResponseHandler response_handler,
  15733. ContentReceiver content_receiver,
  15734. DownloadProgress progress) {
  15735. return cli_->Get(path, std::move(response_handler),
  15736. std::move(content_receiver), std::move(progress));
  15737. }
  15738. inline Result Client::Get(const std::string &path, const Headers &headers,
  15739. ResponseHandler response_handler,
  15740. ContentReceiver content_receiver,
  15741. DownloadProgress progress) {
  15742. return cli_->Get(path, headers, std::move(response_handler),
  15743. std::move(content_receiver), std::move(progress));
  15744. }
  15745. inline Result Client::Get(const std::string &path, const Params &params,
  15746. DownloadProgress progress) {
  15747. return cli_->Get(path, params, std::move(progress));
  15748. }
  15749. inline Result Client::Get(const std::string &path, const Params &params,
  15750. const Headers &headers, DownloadProgress progress) {
  15751. return cli_->Get(path, params, headers, std::move(progress));
  15752. }
  15753. inline Result Client::Get(const std::string &path, const Params &params,
  15754. const Headers &headers,
  15755. ContentReceiver content_receiver,
  15756. DownloadProgress progress) {
  15757. return cli_->Get(path, params, headers, std::move(content_receiver),
  15758. std::move(progress));
  15759. }
  15760. inline Result Client::Get(const std::string &path, const Params &params,
  15761. const Headers &headers,
  15762. ResponseHandler response_handler,
  15763. ContentReceiver content_receiver,
  15764. DownloadProgress progress) {
  15765. return cli_->Get(path, params, headers, std::move(response_handler),
  15766. std::move(content_receiver), std::move(progress));
  15767. }
  15768. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15769. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15770. return cli_->Head(path, headers);
  15771. }
  15772. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15773. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15774. return cli_->Post(path, headers);
  15775. }
  15776. inline Result Client::Post(const std::string &path, const char *body,
  15777. size_t content_length,
  15778. const std::string &content_type,
  15779. UploadProgress progress) {
  15780. return cli_->Post(path, body, content_length, content_type, progress);
  15781. }
  15782. inline Result Client::Post(const std::string &path, const Headers &headers,
  15783. const char *body, size_t content_length,
  15784. const std::string &content_type,
  15785. UploadProgress progress) {
  15786. return cli_->Post(path, headers, body, content_length, content_type,
  15787. progress);
  15788. }
  15789. inline Result Client::Post(const std::string &path, const std::string &body,
  15790. const std::string &content_type,
  15791. UploadProgress progress) {
  15792. return cli_->Post(path, body, content_type, progress);
  15793. }
  15794. inline Result Client::Post(const std::string &path, const Headers &headers,
  15795. const std::string &body,
  15796. const std::string &content_type,
  15797. UploadProgress progress) {
  15798. return cli_->Post(path, headers, body, content_type, progress);
  15799. }
  15800. inline Result Client::Post(const std::string &path, size_t content_length,
  15801. ContentProvider content_provider,
  15802. const std::string &content_type,
  15803. UploadProgress progress) {
  15804. return cli_->Post(path, content_length, std::move(content_provider),
  15805. content_type, progress);
  15806. }
  15807. inline Result Client::Post(const std::string &path, size_t content_length,
  15808. ContentProvider content_provider,
  15809. const std::string &content_type,
  15810. ContentReceiver content_receiver,
  15811. UploadProgress progress) {
  15812. return cli_->Post(path, content_length, std::move(content_provider),
  15813. content_type, std::move(content_receiver), progress);
  15814. }
  15815. inline Result Client::Post(const std::string &path,
  15816. ContentProviderWithoutLength content_provider,
  15817. const std::string &content_type,
  15818. UploadProgress progress) {
  15819. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15820. }
  15821. inline Result Client::Post(const std::string &path,
  15822. ContentProviderWithoutLength content_provider,
  15823. const std::string &content_type,
  15824. ContentReceiver content_receiver,
  15825. UploadProgress progress) {
  15826. return cli_->Post(path, std::move(content_provider), content_type,
  15827. std::move(content_receiver), progress);
  15828. }
  15829. inline Result Client::Post(const std::string &path, const Headers &headers,
  15830. size_t content_length,
  15831. ContentProvider content_provider,
  15832. const std::string &content_type,
  15833. UploadProgress progress) {
  15834. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15835. content_type, progress);
  15836. }
  15837. inline Result Client::Post(const std::string &path, const Headers &headers,
  15838. size_t content_length,
  15839. ContentProvider content_provider,
  15840. const std::string &content_type,
  15841. ContentReceiver content_receiver,
  15842. DownloadProgress progress) {
  15843. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15844. content_type, std::move(content_receiver), progress);
  15845. }
  15846. inline Result Client::Post(const std::string &path, const Headers &headers,
  15847. ContentProviderWithoutLength content_provider,
  15848. const std::string &content_type,
  15849. UploadProgress progress) {
  15850. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15851. progress);
  15852. }
  15853. inline Result Client::Post(const std::string &path, const Headers &headers,
  15854. ContentProviderWithoutLength content_provider,
  15855. const std::string &content_type,
  15856. ContentReceiver content_receiver,
  15857. DownloadProgress progress) {
  15858. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15859. std::move(content_receiver), progress);
  15860. }
  15861. inline Result Client::Post(const std::string &path, const Params &params) {
  15862. return cli_->Post(path, params);
  15863. }
  15864. inline Result Client::Post(const std::string &path, const Headers &headers,
  15865. const Params &params) {
  15866. return cli_->Post(path, headers, params);
  15867. }
  15868. inline Result Client::Post(const std::string &path,
  15869. const UploadFormDataItems &items,
  15870. UploadProgress progress) {
  15871. return cli_->Post(path, items, progress);
  15872. }
  15873. inline Result Client::Post(const std::string &path, const Headers &headers,
  15874. const UploadFormDataItems &items,
  15875. UploadProgress progress) {
  15876. return cli_->Post(path, headers, items, progress);
  15877. }
  15878. inline Result Client::Post(const std::string &path, const Headers &headers,
  15879. const UploadFormDataItems &items,
  15880. const std::string &boundary,
  15881. UploadProgress progress) {
  15882. return cli_->Post(path, headers, items, boundary, progress);
  15883. }
  15884. inline Result Client::Post(const std::string &path, const Headers &headers,
  15885. const UploadFormDataItems &items,
  15886. const FormDataProviderItems &provider_items,
  15887. UploadProgress progress) {
  15888. return cli_->Post(path, headers, items, provider_items, progress);
  15889. }
  15890. inline Result Client::Post(const std::string &path, const Headers &headers,
  15891. const std::string &body,
  15892. const std::string &content_type,
  15893. ContentReceiver content_receiver,
  15894. DownloadProgress progress) {
  15895. return cli_->Post(path, headers, body, content_type,
  15896. std::move(content_receiver), progress);
  15897. }
  15898. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15899. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15900. return cli_->Put(path, headers);
  15901. }
  15902. inline Result Client::Put(const std::string &path, const char *body,
  15903. size_t content_length,
  15904. const std::string &content_type,
  15905. UploadProgress progress) {
  15906. return cli_->Put(path, body, content_length, content_type, progress);
  15907. }
  15908. inline Result Client::Put(const std::string &path, const Headers &headers,
  15909. const char *body, size_t content_length,
  15910. const std::string &content_type,
  15911. UploadProgress progress) {
  15912. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15913. }
  15914. inline Result Client::Put(const std::string &path, const std::string &body,
  15915. const std::string &content_type,
  15916. UploadProgress progress) {
  15917. return cli_->Put(path, body, content_type, progress);
  15918. }
  15919. inline Result Client::Put(const std::string &path, const Headers &headers,
  15920. const std::string &body,
  15921. const std::string &content_type,
  15922. UploadProgress progress) {
  15923. return cli_->Put(path, headers, body, content_type, progress);
  15924. }
  15925. inline Result Client::Put(const std::string &path, size_t content_length,
  15926. ContentProvider content_provider,
  15927. const std::string &content_type,
  15928. UploadProgress progress) {
  15929. return cli_->Put(path, content_length, std::move(content_provider),
  15930. content_type, progress);
  15931. }
  15932. inline Result Client::Put(const std::string &path, size_t content_length,
  15933. ContentProvider content_provider,
  15934. const std::string &content_type,
  15935. ContentReceiver content_receiver,
  15936. UploadProgress progress) {
  15937. return cli_->Put(path, content_length, std::move(content_provider),
  15938. content_type, std::move(content_receiver), progress);
  15939. }
  15940. inline Result Client::Put(const std::string &path,
  15941. ContentProviderWithoutLength content_provider,
  15942. const std::string &content_type,
  15943. UploadProgress progress) {
  15944. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15945. }
  15946. inline Result Client::Put(const std::string &path,
  15947. ContentProviderWithoutLength content_provider,
  15948. const std::string &content_type,
  15949. ContentReceiver content_receiver,
  15950. UploadProgress progress) {
  15951. return cli_->Put(path, std::move(content_provider), content_type,
  15952. std::move(content_receiver), progress);
  15953. }
  15954. inline Result Client::Put(const std::string &path, const Headers &headers,
  15955. size_t content_length,
  15956. ContentProvider content_provider,
  15957. const std::string &content_type,
  15958. UploadProgress progress) {
  15959. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15960. content_type, progress);
  15961. }
  15962. inline Result Client::Put(const std::string &path, const Headers &headers,
  15963. size_t content_length,
  15964. ContentProvider content_provider,
  15965. const std::string &content_type,
  15966. ContentReceiver content_receiver,
  15967. UploadProgress progress) {
  15968. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15969. content_type, std::move(content_receiver), progress);
  15970. }
  15971. inline Result Client::Put(const std::string &path, const Headers &headers,
  15972. ContentProviderWithoutLength content_provider,
  15973. const std::string &content_type,
  15974. UploadProgress progress) {
  15975. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15976. progress);
  15977. }
  15978. inline Result Client::Put(const std::string &path, const Headers &headers,
  15979. ContentProviderWithoutLength content_provider,
  15980. const std::string &content_type,
  15981. ContentReceiver content_receiver,
  15982. UploadProgress progress) {
  15983. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15984. std::move(content_receiver), progress);
  15985. }
  15986. inline Result Client::Put(const std::string &path, const Params &params) {
  15987. return cli_->Put(path, params);
  15988. }
  15989. inline Result Client::Put(const std::string &path, const Headers &headers,
  15990. const Params &params) {
  15991. return cli_->Put(path, headers, params);
  15992. }
  15993. inline Result Client::Put(const std::string &path,
  15994. const UploadFormDataItems &items,
  15995. UploadProgress progress) {
  15996. return cli_->Put(path, items, progress);
  15997. }
  15998. inline Result Client::Put(const std::string &path, const Headers &headers,
  15999. const UploadFormDataItems &items,
  16000. UploadProgress progress) {
  16001. return cli_->Put(path, headers, items, progress);
  16002. }
  16003. inline Result Client::Put(const std::string &path, const Headers &headers,
  16004. const UploadFormDataItems &items,
  16005. const std::string &boundary,
  16006. UploadProgress progress) {
  16007. return cli_->Put(path, headers, items, boundary, progress);
  16008. }
  16009. inline Result Client::Put(const std::string &path, const Headers &headers,
  16010. const UploadFormDataItems &items,
  16011. const FormDataProviderItems &provider_items,
  16012. UploadProgress progress) {
  16013. return cli_->Put(path, headers, items, provider_items, progress);
  16014. }
  16015. inline Result Client::Put(const std::string &path, const Headers &headers,
  16016. const std::string &body,
  16017. const std::string &content_type,
  16018. ContentReceiver content_receiver,
  16019. DownloadProgress progress) {
  16020. return cli_->Put(path, headers, body, content_type, content_receiver,
  16021. progress);
  16022. }
  16023. inline Result Client::Patch(const std::string &path) {
  16024. return cli_->Patch(path);
  16025. }
  16026. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  16027. return cli_->Patch(path, headers);
  16028. }
  16029. inline Result Client::Patch(const std::string &path, const char *body,
  16030. size_t content_length,
  16031. const std::string &content_type,
  16032. UploadProgress progress) {
  16033. return cli_->Patch(path, body, content_length, content_type, progress);
  16034. }
  16035. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16036. const char *body, size_t content_length,
  16037. const std::string &content_type,
  16038. UploadProgress progress) {
  16039. return cli_->Patch(path, headers, body, content_length, content_type,
  16040. progress);
  16041. }
  16042. inline Result Client::Patch(const std::string &path, const std::string &body,
  16043. const std::string &content_type,
  16044. UploadProgress progress) {
  16045. return cli_->Patch(path, body, content_type, progress);
  16046. }
  16047. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16048. const std::string &body,
  16049. const std::string &content_type,
  16050. UploadProgress progress) {
  16051. return cli_->Patch(path, headers, body, content_type, progress);
  16052. }
  16053. inline Result Client::Patch(const std::string &path, size_t content_length,
  16054. ContentProvider content_provider,
  16055. const std::string &content_type,
  16056. UploadProgress progress) {
  16057. return cli_->Patch(path, content_length, std::move(content_provider),
  16058. content_type, progress);
  16059. }
  16060. inline Result Client::Patch(const std::string &path, size_t content_length,
  16061. ContentProvider content_provider,
  16062. const std::string &content_type,
  16063. ContentReceiver content_receiver,
  16064. UploadProgress progress) {
  16065. return cli_->Patch(path, content_length, std::move(content_provider),
  16066. content_type, std::move(content_receiver), progress);
  16067. }
  16068. inline Result Client::Patch(const std::string &path,
  16069. ContentProviderWithoutLength content_provider,
  16070. const std::string &content_type,
  16071. UploadProgress progress) {
  16072. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  16073. }
  16074. inline Result Client::Patch(const std::string &path,
  16075. ContentProviderWithoutLength content_provider,
  16076. const std::string &content_type,
  16077. ContentReceiver content_receiver,
  16078. UploadProgress progress) {
  16079. return cli_->Patch(path, std::move(content_provider), content_type,
  16080. std::move(content_receiver), progress);
  16081. }
  16082. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16083. size_t content_length,
  16084. ContentProvider content_provider,
  16085. const std::string &content_type,
  16086. UploadProgress progress) {
  16087. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16088. content_type, progress);
  16089. }
  16090. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16091. size_t content_length,
  16092. ContentProvider content_provider,
  16093. const std::string &content_type,
  16094. ContentReceiver content_receiver,
  16095. UploadProgress progress) {
  16096. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  16097. content_type, std::move(content_receiver), progress);
  16098. }
  16099. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16100. ContentProviderWithoutLength content_provider,
  16101. const std::string &content_type,
  16102. UploadProgress progress) {
  16103. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16104. progress);
  16105. }
  16106. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16107. ContentProviderWithoutLength content_provider,
  16108. const std::string &content_type,
  16109. ContentReceiver content_receiver,
  16110. UploadProgress progress) {
  16111. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  16112. std::move(content_receiver), progress);
  16113. }
  16114. inline Result Client::Patch(const std::string &path, const Params &params) {
  16115. return cli_->Patch(path, params);
  16116. }
  16117. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16118. const Params &params) {
  16119. return cli_->Patch(path, headers, params);
  16120. }
  16121. inline Result Client::Patch(const std::string &path,
  16122. const UploadFormDataItems &items,
  16123. UploadProgress progress) {
  16124. return cli_->Patch(path, items, progress);
  16125. }
  16126. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16127. const UploadFormDataItems &items,
  16128. UploadProgress progress) {
  16129. return cli_->Patch(path, headers, items, progress);
  16130. }
  16131. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16132. const UploadFormDataItems &items,
  16133. const std::string &boundary,
  16134. UploadProgress progress) {
  16135. return cli_->Patch(path, headers, items, boundary, progress);
  16136. }
  16137. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16138. const UploadFormDataItems &items,
  16139. const FormDataProviderItems &provider_items,
  16140. UploadProgress progress) {
  16141. return cli_->Patch(path, headers, items, provider_items, progress);
  16142. }
  16143. inline Result Client::Patch(const std::string &path, const Headers &headers,
  16144. const std::string &body,
  16145. const std::string &content_type,
  16146. ContentReceiver content_receiver,
  16147. DownloadProgress progress) {
  16148. return cli_->Patch(path, headers, body, content_type, content_receiver,
  16149. progress);
  16150. }
  16151. inline Result Client::Delete(const std::string &path,
  16152. DownloadProgress progress) {
  16153. return cli_->Delete(path, progress);
  16154. }
  16155. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16156. DownloadProgress progress) {
  16157. return cli_->Delete(path, headers, progress);
  16158. }
  16159. inline Result Client::Delete(const std::string &path, const char *body,
  16160. size_t content_length,
  16161. const std::string &content_type,
  16162. DownloadProgress progress) {
  16163. return cli_->Delete(path, body, content_length, content_type, progress);
  16164. }
  16165. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16166. const char *body, size_t content_length,
  16167. const std::string &content_type,
  16168. DownloadProgress progress) {
  16169. return cli_->Delete(path, headers, body, content_length, content_type,
  16170. progress);
  16171. }
  16172. inline Result Client::Delete(const std::string &path, const std::string &body,
  16173. const std::string &content_type,
  16174. DownloadProgress progress) {
  16175. return cli_->Delete(path, body, content_type, progress);
  16176. }
  16177. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16178. const std::string &body,
  16179. const std::string &content_type,
  16180. DownloadProgress progress) {
  16181. return cli_->Delete(path, headers, body, content_type, progress);
  16182. }
  16183. inline Result Client::Delete(const std::string &path, const Params &params,
  16184. DownloadProgress progress) {
  16185. return cli_->Delete(path, params, progress);
  16186. }
  16187. inline Result Client::Delete(const std::string &path, const Headers &headers,
  16188. const Params &params, DownloadProgress progress) {
  16189. return cli_->Delete(path, headers, params, progress);
  16190. }
  16191. inline Result Client::Options(const std::string &path) {
  16192. return cli_->Options(path);
  16193. }
  16194. inline Result Client::Options(const std::string &path, const Headers &headers) {
  16195. return cli_->Options(path, headers);
  16196. }
  16197. inline ClientImpl::StreamHandle
  16198. Client::open_stream(const std::string &method, const std::string &path,
  16199. const Params &params, const Headers &headers,
  16200. const std::string &body, const std::string &content_type) {
  16201. return cli_->open_stream(method, path, params, headers, body, content_type);
  16202. }
  16203. inline bool Client::send(Request &req, Response &res, Error &error) {
  16204. return cli_->send(req, res, error);
  16205. }
  16206. inline Result Client::send(const Request &req) { return cli_->send(req); }
  16207. inline void Client::stop() { cli_->stop(); }
  16208. inline std::string Client::host() const { return cli_->host(); }
  16209. inline int Client::port() const { return cli_->port(); }
  16210. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  16211. inline socket_t Client::socket() const { return cli_->socket(); }
  16212. inline void
  16213. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  16214. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16215. }
  16216. inline void Client::set_direct_hostname_addr_map(
  16217. std::map<std::string, std::string> addr_map) {
  16218. cli_->set_direct_hostname_addr_map(std::move(addr_map));
  16219. }
  16220. inline void Client::set_tunnel_hostname_addr_map(
  16221. std::map<std::string, std::string> addr_map) {
  16222. cli_->set_tunnel_hostname_addr_map(std::move(addr_map));
  16223. }
  16224. inline void Client::set_default_headers(Headers headers) {
  16225. cli_->set_default_headers(std::move(headers));
  16226. }
  16227. inline void Client::set_header_writer(
  16228. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  16229. cli_->set_header_writer(writer);
  16230. }
  16231. inline void Client::set_address_family(int family) {
  16232. cli_->set_address_family(family);
  16233. }
  16234. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16235. inline void Client::set_socket_options(SocketOptions socket_options) {
  16236. cli_->set_socket_options(std::move(socket_options));
  16237. }
  16238. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16239. cli_->set_connection_timeout(sec, usec);
  16240. }
  16241. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16242. cli_->set_read_timeout(sec, usec);
  16243. }
  16244. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16245. cli_->set_write_timeout(sec, usec);
  16246. }
  16247. inline void Client::set_basic_auth(const std::string &username,
  16248. const std::string &password) {
  16249. cli_->set_basic_auth(username, password);
  16250. }
  16251. inline void Client::set_bearer_token_auth(const std::string &token) {
  16252. cli_->set_bearer_token_auth(token);
  16253. }
  16254. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16255. inline void Client::set_follow_location(bool on) {
  16256. cli_->set_follow_location(on);
  16257. }
  16258. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16259. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16260. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16261. inline void Client::set_payload_max_length(size_t length) {
  16262. cli_->set_payload_max_length(length);
  16263. }
  16264. inline void Client::set_interface(const std::string &intf) {
  16265. cli_->set_interface(intf);
  16266. }
  16267. inline void Client::set_proxy(const std::string &host, int port) {
  16268. cli_->set_proxy(host, port);
  16269. }
  16270. inline void Client::set_proxy_basic_auth(const std::string &username,
  16271. const std::string &password) {
  16272. cli_->set_proxy_basic_auth(username, password);
  16273. }
  16274. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16275. cli_->set_proxy_bearer_token_auth(token);
  16276. }
  16277. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16278. cli_->set_no_proxy(patterns);
  16279. }
  16280. inline void Client::set_logger(Logger logger) {
  16281. cli_->set_logger(std::move(logger));
  16282. }
  16283. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16284. cli_->set_error_logger(std::move(error_logger));
  16285. }
  16286. /*
  16287. * Group 6: SSL Server and Client implementation
  16288. */
  16289. #ifdef CPPHTTPLIB_SSL_ENABLED
  16290. // SSL HTTP server implementation
  16291. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16292. const char *client_ca_cert_file_path,
  16293. const char *client_ca_cert_dir_path,
  16294. const char *private_key_password) {
  16295. using namespace tls;
  16296. ctx_ = create_server_context();
  16297. if (!ctx_) { return; }
  16298. // Load server certificate and private key
  16299. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16300. private_key_password)) {
  16301. last_ssl_error_ = static_cast<int>(get_error());
  16302. free_context(ctx_);
  16303. ctx_ = nullptr;
  16304. return;
  16305. }
  16306. // Load client CA certificates for client authentication
  16307. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16308. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16309. client_ca_cert_dir_path)) {
  16310. last_ssl_error_ = static_cast<int>(get_error());
  16311. free_context(ctx_);
  16312. ctx_ = nullptr;
  16313. return;
  16314. }
  16315. // Enable client certificate verification
  16316. set_verify_client(ctx_, true);
  16317. }
  16318. }
  16319. inline SSLServer::SSLServer(const PemMemory &pem) {
  16320. using namespace tls;
  16321. ctx_ = create_server_context();
  16322. if (ctx_) {
  16323. std::string cert_buf, key_buf;
  16324. if (!set_server_cert_pem(
  16325. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16326. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16327. pem.private_key_password)) {
  16328. last_ssl_error_ = static_cast<int>(get_error());
  16329. free_context(ctx_);
  16330. ctx_ = nullptr;
  16331. } else if (pem.client_ca_pem) {
  16332. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16333. : strlen(pem.client_ca_pem);
  16334. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16335. last_ssl_error_ = static_cast<int>(get_error());
  16336. free_context(ctx_);
  16337. ctx_ = nullptr;
  16338. } else {
  16339. set_verify_client(ctx_, true);
  16340. }
  16341. }
  16342. }
  16343. }
  16344. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16345. using namespace tls;
  16346. ctx_ = create_server_context();
  16347. if (ctx_) {
  16348. if (!setup_callback(ctx_)) {
  16349. free_context(ctx_);
  16350. ctx_ = nullptr;
  16351. }
  16352. }
  16353. }
  16354. inline SSLServer::~SSLServer() {
  16355. if (ctx_) { tls::free_context(ctx_); }
  16356. }
  16357. inline bool SSLServer::is_valid() const {
  16358. return ctx_ != nullptr && Server::is_valid();
  16359. }
  16360. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16361. using namespace tls;
  16362. session_t session = nullptr;
  16363. {
  16364. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16365. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16366. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16367. if (session) { handshakes_in_progress_++; }
  16368. }
  16369. if (!session) {
  16370. last_ssl_error_ = static_cast<int>(get_error());
  16371. detail::shutdown_socket(sock);
  16372. detail::close_socket(sock);
  16373. return false;
  16374. }
  16375. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16376. bool handshake_done = false;
  16377. bool ret = false;
  16378. bool websocket_upgraded = false;
  16379. auto cleanup = detail::scope_exit([&] {
  16380. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16381. free_session(session);
  16382. detail::shutdown_socket(sock);
  16383. detail::close_socket(sock);
  16384. });
  16385. // Perform TLS accept handshake with timeout
  16386. TlsError tls_err;
  16387. auto accepted = false;
  16388. {
  16389. auto handshake_left = detail::scope_exit([&] {
  16390. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16391. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16392. });
  16393. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16394. read_timeout_usec_, &tls_err);
  16395. }
  16396. if (!accepted) {
  16397. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16398. // Map TlsError to legacy ssl_error for backward compatibility
  16399. if (tls_err.code == ErrorCode::WantRead) {
  16400. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16401. } else if (tls_err.code == ErrorCode::WantWrite) {
  16402. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16403. } else {
  16404. last_ssl_error_ = SSL_ERROR_SSL;
  16405. }
  16406. #else
  16407. last_ssl_error_ = static_cast<int>(get_error());
  16408. #endif
  16409. return false;
  16410. }
  16411. handshake_done = true;
  16412. std::string remote_addr;
  16413. int remote_port = 0;
  16414. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16415. std::string local_addr;
  16416. int local_port = 0;
  16417. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16418. ret = serve_guarded([&]() {
  16419. return detail::process_server_socket_ssl(
  16420. svr_sock_, session, sock, keep_alive_max_count_,
  16421. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16422. write_timeout_sec_, write_timeout_usec_,
  16423. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16424. return process_request(
  16425. strm, remote_addr, remote_port, local_addr, local_port,
  16426. close_connection, connection_closed,
  16427. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16428. });
  16429. });
  16430. return ret;
  16431. }
  16432. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16433. const char *key_pem,
  16434. const char *client_ca_pem,
  16435. const char *password) {
  16436. if (!ctx_) { return false; }
  16437. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16438. updates_pending_++;
  16439. auto se = detail::scope_exit([&] {
  16440. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16441. });
  16442. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16443. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16444. return false;
  16445. }
  16446. if (client_ca_pem) {
  16447. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16448. // As in the constructors, a client CA makes client certificates required
  16449. tls::set_verify_client(ctx_, true);
  16450. }
  16451. return true;
  16452. }
  16453. // SSL HTTP client implementation
  16454. inline SSLClient::~SSLClient() {
  16455. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16456. // base function rather than the derived function once we get to the
  16457. // base class destructor, and won't free the SSL (causing a leak).
  16458. // This must happen before the context is freed below: some backends
  16459. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16460. // context, so freeing the context first leaves close_notify reading
  16461. // freed memory.
  16462. shutdown_ssl_impl(socket_, true);
  16463. if (ctx_) {
  16464. tls::free_context(ctx_);
  16465. ctx_ = nullptr;
  16466. }
  16467. }
  16468. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16469. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16470. shutdown_ssl_impl(socket, shutdown_gracefully);
  16471. }
  16472. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16473. bool shutdown_gracefully) {
  16474. if (socket.sock == INVALID_SOCKET) {
  16475. assert(socket.ssl == nullptr);
  16476. return;
  16477. }
  16478. if (socket.ssl) {
  16479. tls::shutdown(socket.ssl, shutdown_gracefully);
  16480. {
  16481. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16482. tls::free_session(socket.ssl);
  16483. }
  16484. socket.ssl = nullptr;
  16485. }
  16486. assert(socket.ssl == nullptr);
  16487. }
  16488. inline bool SSLClient::process_socket(
  16489. const Socket &socket,
  16490. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16491. std::function<bool(Stream &strm)> callback) {
  16492. assert(socket.ssl);
  16493. return detail::process_client_socket_ssl(
  16494. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16495. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16496. [&](detail::SSLSocketStream &strm) {
  16497. auto ret = callback(strm);
  16498. // A request that failed after the handshake reports Error::Read or
  16499. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16500. // from the server, for Result::ssl_error() and ssl_backend_error()
  16501. const auto &tls_error = strm.tls_error();
  16502. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16503. last_ssl_error_ = static_cast<int>(tls_error.code);
  16504. last_backend_error_ = tls_error.backend_code;
  16505. }
  16506. return ret;
  16507. });
  16508. }
  16509. inline bool SSLClient::is_ssl() const { return true; }
  16510. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16511. if (!is_valid()) {
  16512. error = Error::SSLConnection;
  16513. return false;
  16514. }
  16515. return ClientImpl::create_and_connect_socket(socket, error);
  16516. }
  16517. inline bool SSLClient::setup_proxy_connection(
  16518. Socket &socket,
  16519. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16520. Response &res, bool &success, Error &error) {
  16521. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16522. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16523. return false;
  16524. }
  16525. if (!initialize_ssl(socket, error)) {
  16526. shutdown_socket(socket);
  16527. close_socket(socket);
  16528. success = false;
  16529. return false;
  16530. }
  16531. return true;
  16532. }
  16533. // Assumes that socket_mutex_ is locked and that there are no requests in
  16534. // flight
  16535. inline bool SSLClient::connect_with_proxy(
  16536. Socket &socket,
  16537. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16538. Response &res, bool &success, Error &error) {
  16539. success = true;
  16540. auto connect_target =
  16541. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  16542. auto retargeted = connect_target !=
  16543. detail::make_host_and_port_string_always_port(host_, port_);
  16544. Response proxy_res;
  16545. if (!detail::process_client_socket(
  16546. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16547. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16548. start_time, [&](Stream &strm) {
  16549. Request req2;
  16550. req2.method = "CONNECT";
  16551. req2.path = connect_target;
  16552. if (retargeted) { req2.set_header("Host", connect_target); }
  16553. if (max_timeout_msec_ > 0) {
  16554. req2.start_time_ = std::chrono::steady_clock::now();
  16555. }
  16556. return process_request(strm, req2, proxy_res, false, error);
  16557. })) {
  16558. // Thread-safe to close everything because we are assuming there are no
  16559. // requests in flight
  16560. shutdown_ssl(socket, true);
  16561. shutdown_socket(socket);
  16562. close_socket(socket);
  16563. success = false;
  16564. return false;
  16565. }
  16566. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16567. if (!proxy_digest_auth_username_.empty() &&
  16568. !proxy_digest_auth_password_.empty()) {
  16569. std::map<std::string, std::string> auth;
  16570. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16571. // Close the current socket and create a new one for the authenticated
  16572. // request
  16573. shutdown_ssl(socket, true);
  16574. shutdown_socket(socket);
  16575. close_socket(socket);
  16576. // Create a new socket for the authenticated CONNECT request
  16577. if (!ensure_socket_connection(socket, error)) {
  16578. success = false;
  16579. return false;
  16580. }
  16581. proxy_res = Response();
  16582. if (!detail::process_client_socket(
  16583. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16584. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16585. start_time, [&](Stream &strm) {
  16586. Request req3;
  16587. req3.method = "CONNECT";
  16588. req3.path = connect_target;
  16589. if (retargeted) { req3.set_header("Host", connect_target); }
  16590. req3.headers.insert(detail::make_digest_authentication_header(
  16591. req3, make_request_target(req3), auth, 1,
  16592. detail::random_string(10), proxy_digest_auth_username_,
  16593. proxy_digest_auth_password_, true));
  16594. if (max_timeout_msec_ > 0) {
  16595. req3.start_time_ = std::chrono::steady_clock::now();
  16596. }
  16597. return process_request(strm, req3, proxy_res, false, error);
  16598. })) {
  16599. // Thread-safe to close everything because we are assuming there are
  16600. // no requests in flight
  16601. shutdown_ssl(socket, true);
  16602. shutdown_socket(socket);
  16603. close_socket(socket);
  16604. success = false;
  16605. return false;
  16606. }
  16607. }
  16608. }
  16609. }
  16610. // If status code is not 200, proxy request is failed.
  16611. // Set error to ProxyConnection. A 407 is returned as the response of the
  16612. // request, so the caller sees the proxy asks for credentials; any other
  16613. // status would read as the answer of the origin, which it never reached.
  16614. if (proxy_res.status != StatusCode::OK_200) {
  16615. error = Error::ProxyConnection;
  16616. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16617. res = std::move(proxy_res);
  16618. } else {
  16619. success = false;
  16620. }
  16621. // Thread-safe to close everything because we are assuming there are
  16622. // no requests in flight
  16623. shutdown_ssl(socket, true);
  16624. shutdown_socket(socket);
  16625. close_socket(socket);
  16626. return false;
  16627. }
  16628. return true;
  16629. }
  16630. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16631. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16632. if (is_proxy_enabled_for_host(host_)) { return true; }
  16633. if (!initialize_ssl(socket, error)) {
  16634. shutdown_socket(socket);
  16635. close_socket(socket);
  16636. return false;
  16637. }
  16638. return true;
  16639. }
  16640. // SSL HTTP client implementation
  16641. inline SSLClient::SSLClient(const std::string &host)
  16642. : SSLClient(host, 443, std::string(), std::string()) {}
  16643. inline SSLClient::SSLClient(const std::string &host, int port)
  16644. : SSLClient(host, port, std::string(), std::string()) {}
  16645. inline void SSLClient::init_ctx() {
  16646. ctx_ = tls::create_client_context();
  16647. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16648. }
  16649. inline void SSLClient::reset_ctx_on_error() {
  16650. last_backend_error_ = tls::get_error();
  16651. tls::free_context(ctx_);
  16652. ctx_ = nullptr;
  16653. }
  16654. inline SSLClient::SSLClient(const std::string &host, int port,
  16655. const std::string &client_cert_path,
  16656. const std::string &client_key_path,
  16657. const std::string &private_key_password)
  16658. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16659. init_ctx();
  16660. if (!ctx_) { return; }
  16661. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16662. const char *password =
  16663. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16664. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16665. client_key_path.c_str(), password)) {
  16666. reset_ctx_on_error();
  16667. }
  16668. }
  16669. }
  16670. inline SSLClient::SSLClient(const std::string &host, int port,
  16671. const PemMemory &pem)
  16672. : ClientImpl(host, port) {
  16673. init_ctx();
  16674. if (!ctx_) { return; }
  16675. if (pem.cert_pem && pem.key_pem) {
  16676. std::string cert_buf, key_buf;
  16677. if (!tls::set_client_cert_pem(
  16678. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16679. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16680. pem.private_key_password)) {
  16681. reset_ctx_on_error();
  16682. }
  16683. }
  16684. }
  16685. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16686. if (ca_cert_store && ctx_) {
  16687. // set_ca_store takes ownership of ca_cert_store
  16688. tls::set_ca_store(ctx_, ca_cert_store);
  16689. ca_cert_store_set_ = true;
  16690. } else if (ca_cert_store) {
  16691. tls::free_ca_store(ca_cert_store);
  16692. }
  16693. custom_ca_loaded_ = true;
  16694. tls_settings_changed();
  16695. }
  16696. inline void
  16697. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16698. if (!ctx_) { return; }
  16699. server_certificate_verifier_ = verifier;
  16700. {
  16701. // Under the lock that creating a session from ctx_ takes
  16702. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16703. tls::set_verify_callback(ctx_, std::move(verifier));
  16704. }
  16705. tls_settings_changed();
  16706. }
  16707. inline void SSLClient::set_session_verifier(
  16708. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16709. session_verifier_ = std::move(verifier);
  16710. tls_settings_changed();
  16711. }
  16712. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16713. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16714. if (enable_windows_cert_verification_ == enabled) { return; }
  16715. enable_windows_cert_verification_ = enabled;
  16716. tls_settings_changed();
  16717. }
  16718. #endif
  16719. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16720. std::size_t size) {
  16721. if (ctx_ && ca_cert && size > 0) {
  16722. // Every PEM loaded, for redirect transfer
  16723. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16724. ca_cert_pem_ += '\n';
  16725. }
  16726. ca_cert_pem_.append(ca_cert, size);
  16727. tls::load_ca_pem(ctx_, ca_cert, size);
  16728. }
  16729. custom_ca_loaded_ = true;
  16730. tls_settings_changed();
  16731. }
  16732. inline bool SSLClient::load_certs() {
  16733. auto ret = true;
  16734. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16735. // one client is shared across concurrent requests here.
  16736. std::call_once(initialize_cert_, [&]() {
  16737. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16738. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16739. ca_cert_dir_path_, custom_ca_loaded_,
  16740. system_ca_mode_, last_backend_error_);
  16741. });
  16742. return ret;
  16743. }
  16744. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16745. // Load CA certificates if server verification is enabled
  16746. if (server_certificate_verification_) {
  16747. if (!load_certs()) {
  16748. error = Error::SSLLoadingCerts;
  16749. return false;
  16750. }
  16751. }
  16752. detail::ClientTlsSessionOptions options;
  16753. options.server_hostname_verification = server_hostname_verification_;
  16754. options.session_verifier = session_verifier_;
  16755. options.ctx_mutex = &ctx_mutex_;
  16756. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16757. // Skip Schannel when a custom CA cert is specified, as the Windows
  16758. // certificate store would not know about user-provided CA certificates.
  16759. // Also skip when system CA trust is explicitly disabled.
  16760. options.windows_cert_verification =
  16761. enable_windows_cert_verification_ &&
  16762. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16763. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16764. // Only a verifier set through set_server_certificate_verifier() is seen
  16765. // here, not one installed with tls::set_verify_callback() directly.
  16766. options.server_certificate_verifier_set =
  16767. static_cast<bool>(server_certificate_verifier_);
  16768. #endif
  16769. tls::session_t session = nullptr;
  16770. // Use scope_exit to ensure session is freed on error paths
  16771. bool success = false;
  16772. auto session_guard = detail::scope_exit([&] {
  16773. if (!success) { tls::free_session(session); }
  16774. });
  16775. detail::ClientTlsSessionError tls_error;
  16776. if (!detail::setup_client_tls_session(
  16777. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16778. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16779. options)) {
  16780. error = tls_error.error;
  16781. last_ssl_error_ = tls_error.ssl_error;
  16782. last_backend_error_ = tls_error.backend_error;
  16783. return false;
  16784. }
  16785. success = true;
  16786. socket.ssl = session;
  16787. return true;
  16788. }
  16789. inline void Client::set_digest_auth(const std::string &username,
  16790. const std::string &password) {
  16791. cli_->set_digest_auth(username, password);
  16792. }
  16793. inline void Client::set_proxy_digest_auth(const std::string &username,
  16794. const std::string &password) {
  16795. cli_->set_proxy_digest_auth(username, password);
  16796. }
  16797. inline void Client::enable_server_certificate_verification(bool enabled) {
  16798. cli_->enable_server_certificate_verification(enabled);
  16799. }
  16800. inline void Client::enable_server_hostname_verification(bool enabled) {
  16801. cli_->enable_server_hostname_verification(enabled);
  16802. }
  16803. inline void Client::enable_system_ca(bool enabled) {
  16804. cli_->enable_system_ca(enabled);
  16805. }
  16806. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16807. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16808. if (is_ssl_) {
  16809. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16810. enabled);
  16811. }
  16812. }
  16813. #endif
  16814. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16815. const std::string &ca_cert_dir_path) {
  16816. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16817. }
  16818. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16819. if (is_ssl_) {
  16820. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16821. } else if (ca_cert_store) {
  16822. tls::free_ca_store(ca_cert_store);
  16823. }
  16824. }
  16825. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16826. if (is_ssl_) {
  16827. // Use the PEM-based path so the CA data is retained for redirect transfer
  16828. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16829. }
  16830. }
  16831. inline void
  16832. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16833. if (is_ssl_) {
  16834. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16835. std::move(verifier));
  16836. }
  16837. }
  16838. inline void Client::set_session_verifier(
  16839. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16840. if (is_ssl_) {
  16841. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16842. }
  16843. }
  16844. inline tls::ctx_t Client::tls_context() const {
  16845. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16846. return nullptr;
  16847. }
  16848. #endif // CPPHTTPLIB_SSL_ENABLED
  16849. /*
  16850. * Group 7: TLS abstraction layer - Common API
  16851. */
  16852. #ifdef CPPHTTPLIB_SSL_ENABLED
  16853. namespace tls {
  16854. // Helper for PeerCert construction
  16855. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16856. return PeerCert(get_peer_cert(session));
  16857. }
  16858. namespace impl {
  16859. // set_verify_callback() can replace a callback while handshakes on other
  16860. // threads run it, so they share it, and take their reference under this lock.
  16861. inline std::mutex &verify_callback_mutex() {
  16862. static std::mutex mutex;
  16863. return mutex;
  16864. }
  16865. // The TLS libraries are C, so an exception from a verify callback must not
  16866. // unwind through them. It rejects the certificate instead.
  16867. inline bool run_verify_callback(const VerifyCallback &callback,
  16868. const VerifyContext &ctx) {
  16869. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16870. return callback(ctx);
  16871. #else
  16872. try {
  16873. return callback(ctx);
  16874. } catch (...) { return false; }
  16875. #endif
  16876. }
  16877. // Check if a string is an IPv4 address
  16878. inline bool is_ipv4_address(const std::string &str) {
  16879. int dots = 0;
  16880. for (char c : str) {
  16881. if (c == '.') {
  16882. dots++;
  16883. } else if (!detail::is_ascii_digit(c)) {
  16884. return false;
  16885. }
  16886. }
  16887. return dots == 3;
  16888. }
  16889. // Parse IPv4 address string to bytes
  16890. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16891. const char *p = str.c_str();
  16892. for (int i = 0; i < 4; i++) {
  16893. if (i > 0) {
  16894. if (*p != '.') { return false; }
  16895. p++;
  16896. }
  16897. int val = 0;
  16898. int digits = 0;
  16899. while (detail::is_ascii_digit(*p)) {
  16900. val = val * 10 + (*p - '0');
  16901. if (val > 255) { return false; }
  16902. p++;
  16903. digits++;
  16904. }
  16905. if (digits == 0) { return false; }
  16906. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16907. if (digits > 1 && *(p - digits) == '0') { return false; }
  16908. out[i] = static_cast<unsigned char>(val);
  16909. }
  16910. return *p == '\0';
  16911. }
  16912. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16913. // `out` must have room for at least 16 bytes. Returns the address length
  16914. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16915. // literal. Used to match a host against iPAddress SANs the same way the
  16916. // OpenSSL backend does via X509_check_ip.
  16917. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16918. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16919. struct in6_addr addr6 = {};
  16920. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16921. memcpy(out, &addr6, 16);
  16922. return 16;
  16923. }
  16924. return 0;
  16925. }
  16926. #ifdef _WIN32
  16927. // Enumerate Windows system certificates and call callback with DER data
  16928. template <typename Callback>
  16929. inline bool enumerate_windows_system_certs(Callback cb) {
  16930. bool loaded = false;
  16931. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16932. for (auto store_name : store_names) {
  16933. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16934. if (hStore) {
  16935. PCCERT_CONTEXT pContext = nullptr;
  16936. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16937. nullptr) {
  16938. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16939. loaded = true;
  16940. }
  16941. }
  16942. CertCloseStore(hStore, 0);
  16943. }
  16944. }
  16945. return loaded;
  16946. }
  16947. #endif
  16948. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16949. // The trust a certificate's Trust Settings give it for SSL server
  16950. // verification (SecTrustSettings.h). An empty array trusts it as a root.
  16951. // Otherwise the first usage-constraints dictionary that applies decides: one
  16952. // naming a policy other than SSL, a host name or an application does not
  16953. // apply, and a result left out means TrustRoot. Keychain Access writes "Never
  16954. // Trust" as kSecTrustSettingsResultDeny.
  16955. inline SecTrustSettingsResult
  16956. macos_ssl_trust_settings_result(CFArrayRef trust_settings) {
  16957. auto count = CFArrayGetCount(trust_settings);
  16958. if (count == 0) { return kSecTrustSettingsResultTrustRoot; }
  16959. for (CFIndex i = 0; i < count; i++) {
  16960. auto value = CFArrayGetValueAtIndex(trust_settings, i);
  16961. if (!value || CFGetTypeID(value) != CFDictionaryGetTypeID()) { continue; }
  16962. auto constraint = static_cast<CFDictionaryRef>(value);
  16963. auto policy_value =
  16964. CFDictionaryGetValue(constraint, kSecTrustSettingsPolicy);
  16965. if (policy_value) {
  16966. auto policy = static_cast<SecPolicyRef>(const_cast<void *>(policy_value));
  16967. auto is_ssl = false;
  16968. if (auto properties = SecPolicyCopyProperties(policy)) {
  16969. auto oid = CFDictionaryGetValue(properties, kSecPolicyOid);
  16970. is_ssl = oid && CFEqual(oid, kSecPolicyAppleSSL);
  16971. CFRelease(properties);
  16972. }
  16973. if (!is_ssl) { continue; }
  16974. }
  16975. if (CFDictionaryContainsKey(constraint, kSecTrustSettingsPolicyString) ||
  16976. CFDictionaryContainsKey(constraint, kSecTrustSettingsApplication)) {
  16977. continue;
  16978. }
  16979. auto result = kSecTrustSettingsResultTrustRoot;
  16980. auto number = static_cast<CFNumberRef>(
  16981. CFDictionaryGetValue(constraint, kSecTrustSettingsResult));
  16982. if (number) {
  16983. SInt32 number_value = 0;
  16984. if (!CFNumberGetValue(number, kCFNumberSInt32Type, &number_value)) {
  16985. continue;
  16986. }
  16987. result = static_cast<SecTrustSettingsResult>(number_value);
  16988. }
  16989. if (result == kSecTrustSettingsResultTrustRoot ||
  16990. result == kSecTrustSettingsResultTrustAsRoot ||
  16991. result == kSecTrustSettingsResultDeny) {
  16992. return result;
  16993. }
  16994. }
  16995. return kSecTrustSettingsResultUnspecified;
  16996. }
  16997. // Enumerate the macOS Keychain certificates trusted for SSL and call callback
  16998. // with DER data. A certificate with Trust Settings is not trusted just by
  16999. // having them: the settings say whether it is, and a per-user setting
  17000. // overrides the admin domain's, which overrides the system domain's (whose
  17001. // roots are all trusted). So a system root the user set to "Never Trust" is
  17002. // left out, as is one trusted only for S/MIME or code signing.
  17003. template <typename Callback>
  17004. inline bool enumerate_macos_keychain_certs(Callback cb) {
  17005. const SecTrustSettingsDomain domains[] = {
  17006. kSecTrustSettingsDomainUser,
  17007. kSecTrustSettingsDomainAdmin,
  17008. kSecTrustSettingsDomainSystem,
  17009. };
  17010. std::set<std::string> decided;
  17011. std::vector<std::string> trusted;
  17012. for (auto domain : domains) {
  17013. CFArrayRef certs = nullptr;
  17014. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  17015. if (status != errSecSuccess || !certs) {
  17016. if (certs) CFRelease(certs);
  17017. continue;
  17018. }
  17019. CFIndex count = CFArrayGetCount(certs);
  17020. for (CFIndex i = 0; i < count; i++) {
  17021. SecCertificateRef cert =
  17022. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  17023. CFDataRef data = SecCertificateCopyData(cert);
  17024. if (!data) { continue; }
  17025. std::string der(reinterpret_cast<const char *>(CFDataGetBytePtr(data)),
  17026. static_cast<size_t>(CFDataGetLength(data)));
  17027. CFRelease(data);
  17028. // Decided by a domain that overrides this one
  17029. if (decided.find(der) != decided.end()) { continue; }
  17030. auto result = kSecTrustSettingsResultTrustRoot;
  17031. if (domain != kSecTrustSettingsDomainSystem) {
  17032. result = kSecTrustSettingsResultUnspecified;
  17033. CFArrayRef trust_settings = nullptr;
  17034. if (SecTrustSettingsCopyTrustSettings(cert, domain, &trust_settings) ==
  17035. errSecSuccess &&
  17036. trust_settings) {
  17037. result = macos_ssl_trust_settings_result(trust_settings);
  17038. }
  17039. if (trust_settings) CFRelease(trust_settings);
  17040. }
  17041. // Neither trusted nor distrusted here; a domain below may decide
  17042. if (result == kSecTrustSettingsResultUnspecified) { continue; }
  17043. decided.insert(der);
  17044. if (result == kSecTrustSettingsResultTrustRoot ||
  17045. result == kSecTrustSettingsResultTrustAsRoot) {
  17046. trusted.push_back(std::move(der));
  17047. }
  17048. }
  17049. CFRelease(certs);
  17050. }
  17051. bool loaded = false;
  17052. for (const auto &der : trusted) {
  17053. if (cb(reinterpret_cast<const unsigned char *>(der.data()), der.size())) {
  17054. loaded = true;
  17055. }
  17056. }
  17057. return loaded;
  17058. }
  17059. #endif
  17060. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  17061. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  17062. // Common CA certificate file paths on Linux/Unix
  17063. inline const char **system_ca_paths() {
  17064. static const char *paths[] = {
  17065. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  17066. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  17067. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  17068. "/etc/pki/tls/cacert.pem", // OpenELEC
  17069. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  17070. nullptr};
  17071. return paths;
  17072. }
  17073. // Common CA certificate directory paths on Linux/Unix
  17074. inline const char **system_ca_dirs() {
  17075. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  17076. "/etc/pki/tls/certs", // RHEL/CentOS
  17077. "/usr/share/ca-certificates", // Other
  17078. nullptr};
  17079. return dirs;
  17080. }
  17081. #endif
  17082. } // namespace impl
  17083. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  17084. const char *ca_dir) {
  17085. if (!ctx) { return false; }
  17086. bool success = true;
  17087. if (ca_file && *ca_file) {
  17088. if (!load_ca_file(ctx, ca_file)) { success = false; }
  17089. }
  17090. if (ca_dir && *ca_dir) {
  17091. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  17092. }
  17093. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17094. // Set CA list for client certificate request (CertificateRequest message)
  17095. if (ca_file && *ca_file) {
  17096. auto list = SSL_load_client_CA_file(ca_file);
  17097. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  17098. }
  17099. #endif
  17100. return success;
  17101. }
  17102. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17103. const char *password) {
  17104. return set_client_cert_pem(ctx, cert, key, password);
  17105. }
  17106. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  17107. const char *key_path, const char *password) {
  17108. return set_client_cert_file(ctx, cert_path, key_path, password);
  17109. }
  17110. // PeerCert implementation
  17111. inline PeerCert::PeerCert() = default;
  17112. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  17113. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  17114. other.cert_ = nullptr;
  17115. }
  17116. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  17117. if (this != &other) {
  17118. if (cert_) { free_cert(cert_); }
  17119. cert_ = other.cert_;
  17120. other.cert_ = nullptr;
  17121. }
  17122. return *this;
  17123. }
  17124. inline PeerCert::~PeerCert() {
  17125. if (cert_) { free_cert(cert_); }
  17126. }
  17127. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  17128. inline std::string PeerCert::subject_cn() const {
  17129. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  17130. }
  17131. inline std::string PeerCert::issuer_name() const {
  17132. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  17133. }
  17134. inline bool PeerCert::check_hostname(const char *hostname) const {
  17135. return cert_ ? verify_hostname(cert_, hostname) : false;
  17136. }
  17137. inline std::vector<SanEntry> PeerCert::sans() const {
  17138. std::vector<SanEntry> result;
  17139. if (cert_) { get_cert_sans(cert_, result); }
  17140. return result;
  17141. }
  17142. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  17143. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  17144. }
  17145. inline std::string PeerCert::serial() const {
  17146. return cert_ ? get_cert_serial(cert_) : std::string();
  17147. }
  17148. // VerifyContext method implementations
  17149. inline std::string VerifyContext::subject_cn() const {
  17150. return cert ? get_cert_subject_cn(cert) : std::string();
  17151. }
  17152. inline std::string VerifyContext::issuer_name() const {
  17153. return cert ? get_cert_issuer_name(cert) : std::string();
  17154. }
  17155. inline bool VerifyContext::check_hostname(const char *hostname) const {
  17156. return cert ? verify_hostname(cert, hostname) : false;
  17157. }
  17158. inline std::vector<SanEntry> VerifyContext::sans() const {
  17159. std::vector<SanEntry> result;
  17160. if (cert) { get_cert_sans(cert, result); }
  17161. return result;
  17162. }
  17163. inline bool VerifyContext::validity(time_t &not_before,
  17164. time_t &not_after) const {
  17165. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  17166. }
  17167. inline std::string VerifyContext::serial() const {
  17168. return cert ? get_cert_serial(cert) : std::string();
  17169. }
  17170. // TlsError static method implementation
  17171. inline std::string TlsError::verify_error_to_string(long error_code) {
  17172. return verify_error_string(error_code);
  17173. }
  17174. } // namespace tls
  17175. // Request::peer_cert() implementation
  17176. inline tls::PeerCert Request::peer_cert() const {
  17177. return tls::get_peer_cert_from_session(ssl);
  17178. }
  17179. // Request::sni() implementation
  17180. inline std::string Request::sni() const {
  17181. if (!ssl) { return std::string(); }
  17182. const char *s = tls::get_sni(ssl);
  17183. return s ? std::string(s) : std::string();
  17184. }
  17185. #endif // CPPHTTPLIB_SSL_ENABLED
  17186. /*
  17187. * Group 8: TLS abstraction layer - OpenSSL backend
  17188. */
  17189. /*
  17190. * OpenSSL Backend Implementation
  17191. */
  17192. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  17193. namespace tls {
  17194. namespace impl {
  17195. // Helper to map OpenSSL SSL_get_error to ErrorCode
  17196. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  17197. switch (ssl_error) {
  17198. case SSL_ERROR_NONE: return ErrorCode::Success;
  17199. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17200. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17201. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17202. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17203. case SSL_ERROR_SSL:
  17204. default: return ErrorCode::Fatal;
  17205. }
  17206. }
  17207. // Fills in a failed SSL_connect(). One that the server certificate's
  17208. // verification stopped reports the verify result, as the other backends and
  17209. // a check after the handshake do.
  17210. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  17211. auto ssl_err = SSL_get_error(ssl, ret);
  17212. auto error = ERR_get_error();
  17213. err.code = map_ssl_error(ssl_err, err.sys_errno);
  17214. err.backend_code = error;
  17215. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  17216. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  17217. return;
  17218. }
  17219. // A certificate only a verify callback turned down carries no verdict of
  17220. // its own, and fails as any other handshake does
  17221. auto verify_result = SSL_get_verify_result(ssl);
  17222. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  17223. return;
  17224. }
  17225. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  17226. ? ErrorCode::HostnameMismatch
  17227. : ErrorCode::CertVerifyFailed;
  17228. err.backend_code = static_cast<uint64_t>(verify_result);
  17229. }
  17230. // Helper: Create client CA list from PEM string
  17231. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  17232. // Caller takes ownership of returned list
  17233. inline STACK_OF(X509_NAME) *
  17234. create_client_ca_list_from_pem(const char *ca_pem) {
  17235. if (!ca_pem) { return nullptr; }
  17236. auto ca_list = sk_X509_NAME_new_null();
  17237. if (!ca_list) { return nullptr; }
  17238. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  17239. if (!bio) {
  17240. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  17241. return nullptr;
  17242. }
  17243. X509 *cert = nullptr;
  17244. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17245. nullptr) {
  17246. const X509_NAME *name = X509_get_subject_name(cert);
  17247. if (name) {
  17248. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  17249. }
  17250. X509_free(cert);
  17251. }
  17252. BIO_free(bio);
  17253. return ca_list;
  17254. }
  17255. inline void free_verify_callback(void * /*parent*/, void *ptr,
  17256. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  17257. long /*argl*/, void * /*argp*/) {
  17258. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  17259. }
  17260. // The SSL_CTX owns its verify callback, so each client or server sees only
  17261. // its own, on whichever thread runs the handshake.
  17262. inline int verify_callback_index() {
  17263. static const auto index = SSL_CTX_get_ex_new_index(
  17264. 0, nullptr, nullptr, nullptr, free_verify_callback);
  17265. return index;
  17266. }
  17267. // OpenSSL verify callback wrapper
  17268. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  17269. // Get SSL object from X509_STORE_CTX
  17270. auto ssl = static_cast<SSL *>(
  17271. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  17272. if (!ssl) { return preverify_ok; }
  17273. std::shared_ptr<VerifyCallback> callback;
  17274. {
  17275. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  17276. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  17277. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  17278. if (stored) { callback = *stored; }
  17279. }
  17280. if (!callback) { return preverify_ok; }
  17281. // Get current certificate and depth
  17282. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  17283. int depth = X509_STORE_CTX_get_error_depth(ctx);
  17284. int error = X509_STORE_CTX_get_error(ctx);
  17285. // Build context
  17286. VerifyContext verify_ctx;
  17287. verify_ctx.session = static_cast<session_t>(ssl);
  17288. verify_ctx.cert = static_cast<cert_t>(cert);
  17289. verify_ctx.depth = depth;
  17290. verify_ctx.preverify_ok = (preverify_ok != 0);
  17291. verify_ctx.error_code = error;
  17292. verify_ctx.error_string =
  17293. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  17294. auto accepted = run_verify_callback(*callback, verify_ctx);
  17295. // A client verifying the server during the handshake, which is what
  17296. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  17297. if (!SSL_is_server(ssl) &&
  17298. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  17299. accepted = accepted && preverify_ok;
  17300. }
  17301. return accepted ? 1 : 0;
  17302. }
  17303. // Sets the verify mode from whether the peer's certificate is required and
  17304. // whether a verify callback is set.
  17305. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  17306. auto has_callback =
  17307. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  17308. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  17309. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  17310. SSL_CTX_set_verify(ssl_ctx, mode,
  17311. has_callback ? openssl_verify_callback : nullptr);
  17312. }
  17313. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  17314. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  17315. // that must be released with release_store_objects
  17316. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  17317. OPENSSL_VERSION_NUMBER >= 0x30300000L
  17318. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17319. #endif
  17320. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  17321. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17322. return X509_STORE_get1_objects(store);
  17323. #else
  17324. return X509_STORE_get0_objects(store);
  17325. #endif
  17326. }
  17327. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17328. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17329. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17330. #else
  17331. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17332. #endif
  17333. }
  17334. } // namespace impl
  17335. inline ctx_t create_client_context() {
  17336. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17337. if (ctx) {
  17338. // Disable auto-retry to properly handle non-blocking I/O
  17339. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17340. // Set minimum TLS version
  17341. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17342. }
  17343. return static_cast<ctx_t>(ctx);
  17344. }
  17345. inline void free_context(ctx_t ctx) {
  17346. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17347. }
  17348. inline bool set_min_version(ctx_t ctx, Version version) {
  17349. if (!ctx) return false;
  17350. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17351. static_cast<uint16_t>(version)) == 1;
  17352. }
  17353. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17354. if (!ctx || !pem || len == 0) return false;
  17355. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17356. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17357. if (!store) return false;
  17358. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17359. if (!bio) return false;
  17360. bool ok = true;
  17361. X509 *cert = nullptr;
  17362. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17363. nullptr) {
  17364. if (X509_STORE_add_cert(store, cert) != 1) {
  17365. // Ignore duplicate errors
  17366. auto err = ERR_peek_last_error();
  17367. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17368. ok = false;
  17369. }
  17370. }
  17371. X509_free(cert);
  17372. if (!ok) break;
  17373. }
  17374. BIO_free(bio);
  17375. // Clear any "no more certificates" errors
  17376. ERR_clear_error();
  17377. return ok;
  17378. }
  17379. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17380. if (!ctx || !file_path) return false;
  17381. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17382. nullptr) == 1;
  17383. }
  17384. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17385. if (!ctx || !dir_path) return false;
  17386. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17387. dir_path) == 1;
  17388. }
  17389. inline bool load_system_certs(ctx_t ctx) {
  17390. if (!ctx) return false;
  17391. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17392. #ifdef _WIN32
  17393. // Windows: Load from system certificate store (ROOT and CA)
  17394. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17395. if (!store) return false;
  17396. bool loaded_any = false;
  17397. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17398. for (auto store_name : store_names) {
  17399. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17400. if (!hStore) continue;
  17401. PCCERT_CONTEXT pContext = nullptr;
  17402. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17403. nullptr) {
  17404. const unsigned char *data = pContext->pbCertEncoded;
  17405. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17406. if (x509) {
  17407. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17408. X509_free(x509);
  17409. }
  17410. }
  17411. CertCloseStore(hStore, 0);
  17412. }
  17413. return loaded_any;
  17414. #elif defined(__APPLE__)
  17415. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17416. // macOS: Load from Keychain
  17417. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17418. if (!store) return false;
  17419. auto loaded_any = impl::enumerate_macos_keychain_certs(
  17420. [&](const unsigned char *data, size_t len) {
  17421. auto x509 = d2i_X509(nullptr, &data, static_cast<long>(len));
  17422. if (!x509) { return false; }
  17423. auto added = X509_STORE_add_cert(store, x509) == 1;
  17424. X509_free(x509);
  17425. return added;
  17426. });
  17427. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17428. #else
  17429. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17430. #endif
  17431. #else
  17432. // Other Unix: use default verify paths
  17433. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17434. #endif
  17435. }
  17436. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17437. const char *password) {
  17438. if (!ctx || !cert || !key) return false;
  17439. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17440. // Load certificate
  17441. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17442. if (!cert_bio) return false;
  17443. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17444. BIO_free(cert_bio);
  17445. if (!x509) return false;
  17446. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17447. X509_free(x509);
  17448. if (!cert_ok) return false;
  17449. // Load private key
  17450. auto key_bio = BIO_new_mem_buf(key, -1);
  17451. if (!key_bio) return false;
  17452. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17453. password ? const_cast<char *>(password)
  17454. : nullptr);
  17455. BIO_free(key_bio);
  17456. if (!pkey) return false;
  17457. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17458. EVP_PKEY_free(pkey);
  17459. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17460. }
  17461. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17462. const char *key_path, const char *password) {
  17463. if (!ctx || !cert_path || !key_path) return false;
  17464. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17465. if (password && password[0] != '\0') {
  17466. SSL_CTX_set_default_passwd_cb_userdata(
  17467. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17468. }
  17469. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17470. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17471. }
  17472. inline ctx_t create_server_context() {
  17473. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17474. if (ctx) {
  17475. // No renegotiation, as on the other backends: it would run a handshake
  17476. // that SSLServer::update_certs_pem() does not wait for
  17477. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17478. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17479. SSL_OP_NO_RENEGOTIATION);
  17480. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17481. // Without one, a client resuming its session is sent a fatal alert once
  17482. // client certificates are verified.
  17483. static const unsigned char sid_ctx[] = "cpp-httplib";
  17484. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17485. }
  17486. return static_cast<ctx_t>(ctx);
  17487. }
  17488. inline void set_verify_client(ctx_t ctx, bool require) {
  17489. if (!ctx) return;
  17490. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17491. }
  17492. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17493. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17494. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17495. SSL *ssl = SSL_new(ssl_ctx);
  17496. if (!ssl) return nullptr;
  17497. // Disable auto-retry for proper non-blocking I/O handling
  17498. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17499. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17500. if (!bio) {
  17501. SSL_free(ssl);
  17502. return nullptr;
  17503. }
  17504. SSL_set_bio(ssl, bio, bio);
  17505. return static_cast<session_t>(ssl);
  17506. }
  17507. inline void free_session(session_t session) {
  17508. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17509. }
  17510. inline bool set_sni(session_t session, const char *hostname,
  17511. bool verify_hostname) {
  17512. if (!session || !hostname) return false;
  17513. auto ssl = static_cast<SSL *>(session);
  17514. // The handshake's chain verification then checks the name as well
  17515. if (verify_hostname) {
  17516. auto param = SSL_get0_param(ssl);
  17517. X509_VERIFY_PARAM_set_hostflags(param, X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
  17518. if (X509_VERIFY_PARAM_set1_host(param, hostname, strlen(hostname)) != 1) {
  17519. return false;
  17520. }
  17521. }
  17522. #if defined(OPENSSL_IS_BORINGSSL)
  17523. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17524. #else
  17525. // Direct call instead of macro to suppress -Wold-style-cast warning
  17526. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17527. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17528. #endif
  17529. }
  17530. inline TlsError connect(session_t session) {
  17531. if (!session) { return TlsError(); }
  17532. auto ssl = static_cast<SSL *>(session);
  17533. auto ret = SSL_connect(ssl);
  17534. TlsError err;
  17535. if (ret == 1) {
  17536. err.code = ErrorCode::Success;
  17537. } else {
  17538. impl::fill_connect_error(ssl, ret, err);
  17539. }
  17540. return err;
  17541. }
  17542. inline TlsError accept(session_t session) {
  17543. if (!session) { return TlsError(); }
  17544. auto ssl = static_cast<SSL *>(session);
  17545. auto ret = SSL_accept(ssl);
  17546. TlsError err;
  17547. if (ret == 1) {
  17548. err.code = ErrorCode::Success;
  17549. } else {
  17550. auto ssl_err = SSL_get_error(ssl, ret);
  17551. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17552. err.backend_code = ERR_get_error();
  17553. }
  17554. return err;
  17555. }
  17556. inline bool connect_nonblocking(session_t session, socket_t sock,
  17557. time_t timeout_sec, time_t timeout_usec,
  17558. TlsError *err) {
  17559. if (!session) {
  17560. if (err) { err->code = ErrorCode::Fatal; }
  17561. return false;
  17562. }
  17563. auto ssl = static_cast<SSL *>(session);
  17564. auto bio = SSL_get_rbio(ssl);
  17565. // Set non-blocking mode for handshake
  17566. detail::set_nonblocking(sock, true);
  17567. if (bio) { BIO_set_nbio(bio, 1); }
  17568. auto cleanup = detail::scope_exit([&]() {
  17569. // Restore blocking mode after handshake
  17570. if (bio) { BIO_set_nbio(bio, 0); }
  17571. detail::set_nonblocking(sock, false);
  17572. });
  17573. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17574. auto res = 0;
  17575. while ((res = SSL_connect(ssl)) != 1) {
  17576. auto ssl_err = SSL_get_error(ssl, res);
  17577. switch (ssl_err) {
  17578. case SSL_ERROR_WANT_READ:
  17579. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17580. break;
  17581. case SSL_ERROR_WANT_WRITE:
  17582. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17583. break;
  17584. default: break;
  17585. }
  17586. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17587. return false;
  17588. }
  17589. if (err) { err->code = ErrorCode::Success; }
  17590. return true;
  17591. }
  17592. inline bool accept_nonblocking(session_t session, socket_t sock,
  17593. time_t timeout_sec, time_t timeout_usec,
  17594. TlsError *err) {
  17595. if (!session) {
  17596. if (err) { err->code = ErrorCode::Fatal; }
  17597. return false;
  17598. }
  17599. auto ssl = static_cast<SSL *>(session);
  17600. auto bio = SSL_get_rbio(ssl);
  17601. // Set non-blocking mode for handshake
  17602. detail::set_nonblocking(sock, true);
  17603. if (bio) { BIO_set_nbio(bio, 1); }
  17604. auto cleanup = detail::scope_exit([&]() {
  17605. // Restore blocking mode after handshake
  17606. if (bio) { BIO_set_nbio(bio, 0); }
  17607. detail::set_nonblocking(sock, false);
  17608. });
  17609. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17610. auto res = 0;
  17611. while ((res = SSL_accept(ssl)) != 1) {
  17612. auto ssl_err = SSL_get_error(ssl, res);
  17613. switch (ssl_err) {
  17614. case SSL_ERROR_WANT_READ:
  17615. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17616. break;
  17617. case SSL_ERROR_WANT_WRITE:
  17618. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17619. break;
  17620. default: break;
  17621. }
  17622. if (err) {
  17623. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17624. err->backend_code = ERR_get_error();
  17625. }
  17626. return false;
  17627. }
  17628. if (err) { err->code = ErrorCode::Success; }
  17629. return true;
  17630. }
  17631. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17632. if (!session || !buf) {
  17633. err.code = ErrorCode::Fatal;
  17634. return -1;
  17635. }
  17636. auto ssl = static_cast<SSL *>(session);
  17637. constexpr auto max_len =
  17638. static_cast<size_t>((std::numeric_limits<int>::max)());
  17639. if (len > max_len) { len = max_len; }
  17640. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17641. if (ret > 0) {
  17642. err.code = ErrorCode::Success;
  17643. return ret;
  17644. }
  17645. auto ssl_err = SSL_get_error(ssl, ret);
  17646. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17647. if (err.code == ErrorCode::PeerClosed) {
  17648. return 0;
  17649. } // Gracefully handle the peer closed state.
  17650. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17651. return -1;
  17652. }
  17653. inline ssize_t write(session_t session, const void *buf, size_t len,
  17654. TlsError &err) {
  17655. if (!session || !buf) {
  17656. err.code = ErrorCode::Fatal;
  17657. return -1;
  17658. }
  17659. auto ssl = static_cast<SSL *>(session);
  17660. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17661. if (ret > 0) {
  17662. err.code = ErrorCode::Success;
  17663. return ret;
  17664. }
  17665. auto ssl_err = SSL_get_error(ssl, ret);
  17666. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17667. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17668. return -1;
  17669. }
  17670. inline int pending(const_session_t session) {
  17671. if (!session) return 0;
  17672. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17673. }
  17674. inline void shutdown(session_t session, bool graceful) {
  17675. if (!session) return;
  17676. auto ssl = static_cast<SSL *>(session);
  17677. if (graceful) {
  17678. // Send close_notify without waiting for the peer's. The connection is
  17679. // closed right after this, so a unidirectional shutdown is enough, and an
  17680. // idle peer that never answers would otherwise hold this thread until the
  17681. // read timeout. The other backends do not wait either.
  17682. SSL_shutdown(ssl);
  17683. }
  17684. }
  17685. inline bool is_peer_closed(session_t session, socket_t sock) {
  17686. if (!session) return true;
  17687. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17688. detail::set_nonblocking(sock, true);
  17689. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17690. auto ssl = static_cast<SSL *>(session);
  17691. char buf;
  17692. auto ret = SSL_peek(ssl, &buf, 1);
  17693. if (ret > 0) return false;
  17694. auto err = SSL_get_error(ssl, ret);
  17695. return err == SSL_ERROR_ZERO_RETURN;
  17696. }
  17697. inline cert_t get_peer_cert(const_session_t session) {
  17698. if (!session) return nullptr;
  17699. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17700. static_cast<SSL *>(const_cast<void *>(session))));
  17701. }
  17702. inline size_t get_peer_certs(const_session_t session,
  17703. std::vector<cert_t> &certs) {
  17704. certs.clear();
  17705. if (!session) { return 0; }
  17706. auto ssl = static_cast<const SSL *>(session);
  17707. // On the server side, the chain leaves out the peer's own certificate
  17708. if (SSL_is_server(ssl)) {
  17709. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17710. }
  17711. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17712. auto count = sk_X509_num(sk);
  17713. for (decltype(count) i = 0; i < count; i++) {
  17714. auto x509 = sk_X509_value(sk, i);
  17715. X509_up_ref(x509);
  17716. certs.push_back(static_cast<cert_t>(x509));
  17717. }
  17718. }
  17719. return certs.size();
  17720. }
  17721. inline void free_cert(cert_t cert) {
  17722. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17723. }
  17724. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17725. if (!cert || !hostname) return false;
  17726. auto x509 = static_cast<X509 *>(cert);
  17727. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17728. if (detail::is_ip_address(hostname)) {
  17729. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17730. }
  17731. return X509_check_host(x509, hostname, strlen(hostname),
  17732. X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, nullptr) == 1;
  17733. }
  17734. inline uint64_t hostname_mismatch_code() {
  17735. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17736. }
  17737. inline long get_verify_result(const_session_t session) {
  17738. if (!session) return X509_V_ERR_UNSPECIFIED;
  17739. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17740. }
  17741. inline std::string get_cert_subject_cn(cert_t cert) {
  17742. if (!cert) return "";
  17743. auto x509 = static_cast<X509 *>(cert);
  17744. auto subject_name = X509_get_subject_name(x509);
  17745. if (!subject_name) return "";
  17746. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17747. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17748. if (idx < 0) return "";
  17749. auto entry = X509_NAME_get_entry(subject_name, idx);
  17750. if (!entry) return "";
  17751. auto data = X509_NAME_ENTRY_get_data(entry);
  17752. if (!data) return "";
  17753. return std::string(
  17754. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17755. static_cast<size_t>(ASN1_STRING_length(data)));
  17756. }
  17757. inline std::string get_cert_issuer_name(cert_t cert) {
  17758. if (!cert) return "";
  17759. auto x509 = static_cast<X509 *>(cert);
  17760. auto issuer_name = X509_get_issuer_name(x509);
  17761. if (!issuer_name) return "";
  17762. char buf[256];
  17763. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17764. return std::string(buf);
  17765. }
  17766. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17767. sans.clear();
  17768. if (!cert) return false;
  17769. auto x509 = static_cast<X509 *>(cert);
  17770. auto names = static_cast<GENERAL_NAMES *>(
  17771. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17772. if (!names) return true; // No SANs is valid
  17773. auto count = sk_GENERAL_NAME_num(names);
  17774. for (decltype(count) i = 0; i < count; i++) {
  17775. auto gen = sk_GENERAL_NAME_value(names, i);
  17776. if (!gen) continue;
  17777. SanEntry entry;
  17778. switch (gen->type) {
  17779. case GEN_DNS:
  17780. entry.type = SanType::DNS;
  17781. if (gen->d.dNSName) {
  17782. entry.value = std::string(
  17783. reinterpret_cast<const char *>(
  17784. ASN1_STRING_get0_data(gen->d.dNSName)),
  17785. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17786. }
  17787. break;
  17788. case GEN_IPADD:
  17789. entry.type = SanType::IP;
  17790. if (gen->d.iPAddress) {
  17791. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17792. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17793. if (len == 4) {
  17794. // IPv4
  17795. char buf[INET_ADDRSTRLEN];
  17796. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17797. entry.value = buf;
  17798. } else if (len == 16) {
  17799. // IPv6
  17800. char buf[INET6_ADDRSTRLEN];
  17801. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17802. entry.value = buf;
  17803. }
  17804. }
  17805. break;
  17806. case GEN_EMAIL:
  17807. entry.type = SanType::EMAIL;
  17808. if (gen->d.rfc822Name) {
  17809. entry.value = std::string(
  17810. reinterpret_cast<const char *>(
  17811. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17812. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17813. }
  17814. break;
  17815. case GEN_URI:
  17816. entry.type = SanType::URI;
  17817. if (gen->d.uniformResourceIdentifier) {
  17818. entry.value = std::string(
  17819. reinterpret_cast<const char *>(
  17820. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17821. static_cast<size_t>(
  17822. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17823. }
  17824. break;
  17825. default: entry.type = SanType::OTHER; break;
  17826. }
  17827. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17828. }
  17829. GENERAL_NAMES_free(names);
  17830. return true;
  17831. }
  17832. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17833. time_t &not_after) {
  17834. if (!cert) return false;
  17835. auto x509 = static_cast<X509 *>(cert);
  17836. auto nb = X509_get0_notBefore(x509);
  17837. auto na = X509_get0_notAfter(x509);
  17838. if (!nb || !na) return false;
  17839. ASN1_TIME *epoch = ASN1_TIME_new();
  17840. if (!epoch) return false;
  17841. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17842. if (!ASN1_TIME_set(epoch, 0)) return false;
  17843. int pday, psec;
  17844. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17845. not_before = 86400 * (time_t)pday + psec;
  17846. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17847. not_after = 86400 * (time_t)pday + psec;
  17848. return true;
  17849. }
  17850. inline std::string get_cert_serial(cert_t cert) {
  17851. if (!cert) return "";
  17852. auto x509 = static_cast<X509 *>(cert);
  17853. auto serial = X509_get_serialNumber(x509);
  17854. if (!serial) return "";
  17855. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17856. if (!bn) return "";
  17857. auto hex = BN_bn2hex(bn);
  17858. BN_free(bn);
  17859. if (!hex) return "";
  17860. std::string result(hex);
  17861. OPENSSL_free(hex);
  17862. return result;
  17863. }
  17864. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17865. if (!cert) return false;
  17866. auto x509 = static_cast<X509 *>(cert);
  17867. auto len = i2d_X509(x509, nullptr);
  17868. if (len < 0) return false;
  17869. der.resize(static_cast<size_t>(len));
  17870. auto p = der.data();
  17871. i2d_X509(x509, &p);
  17872. return true;
  17873. }
  17874. inline const char *get_sni(const_session_t session) {
  17875. if (!session) return nullptr;
  17876. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17877. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17878. }
  17879. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17880. inline uint64_t get_error() { return ERR_get_error(); }
  17881. inline std::string error_string(uint64_t code) {
  17882. char buf[256];
  17883. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17884. sizeof(buf));
  17885. return std::string(buf);
  17886. }
  17887. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17888. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17889. if (!mem) { return nullptr; }
  17890. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17891. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17892. if (!inf) { return nullptr; }
  17893. auto store = X509_STORE_new();
  17894. if (store) {
  17895. auto count = sk_X509_INFO_num(inf);
  17896. for (decltype(count) i = 0; i < count; i++) {
  17897. auto itmp = sk_X509_INFO_value(inf, i);
  17898. if (!itmp) { continue; }
  17899. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17900. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17901. }
  17902. }
  17903. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17904. return static_cast<ca_store_t>(store);
  17905. }
  17906. inline void free_ca_store(ca_store_t store) {
  17907. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17908. }
  17909. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17910. if (!ctx || !store) { return false; }
  17911. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17912. auto x509_store = static_cast<X509_STORE *>(store);
  17913. // Check if same store is already set
  17914. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17915. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17916. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17917. return true;
  17918. }
  17919. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17920. certs.clear();
  17921. if (!ctx) { return 0; }
  17922. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17923. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17924. if (!store) { return 0; }
  17925. auto objs = impl::get_store_objects(store);
  17926. if (!objs) { return 0; }
  17927. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17928. auto count = sk_X509_OBJECT_num(objs);
  17929. for (decltype(count) i = 0; i < count; i++) {
  17930. auto obj = sk_X509_OBJECT_value(objs, i);
  17931. if (!obj) { continue; }
  17932. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17933. auto x509 = X509_OBJECT_get0_X509(obj);
  17934. if (x509) {
  17935. // Increment reference count so caller can free it
  17936. X509_up_ref(x509);
  17937. certs.push_back(static_cast<cert_t>(x509));
  17938. }
  17939. }
  17940. }
  17941. return certs.size();
  17942. }
  17943. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17944. std::vector<std::string> names;
  17945. if (!ctx) { return names; }
  17946. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17947. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17948. if (!store) { return names; }
  17949. auto objs = impl::get_store_objects(store);
  17950. if (!objs) { return names; }
  17951. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17952. auto count = sk_X509_OBJECT_num(objs);
  17953. for (decltype(count) i = 0; i < count; i++) {
  17954. auto obj = sk_X509_OBJECT_value(objs, i);
  17955. if (!obj) { continue; }
  17956. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17957. auto x509 = X509_OBJECT_get0_X509(obj);
  17958. if (x509) {
  17959. auto subject = X509_get_subject_name(x509);
  17960. if (subject) {
  17961. char buf[512];
  17962. X509_NAME_oneline(subject, buf, sizeof(buf));
  17963. names.push_back(buf);
  17964. }
  17965. }
  17966. }
  17967. }
  17968. return names;
  17969. }
  17970. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17971. const char *key_pem, const char *password) {
  17972. if (!ctx || !cert_pem || !key_pem) { return false; }
  17973. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17974. // Load certificate from PEM
  17975. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17976. if (!cert_bio) { return false; }
  17977. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17978. BIO_free(cert_bio);
  17979. if (!cert) { return false; }
  17980. // Load private key from PEM
  17981. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17982. if (!key_bio) {
  17983. X509_free(cert);
  17984. return false;
  17985. }
  17986. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17987. password ? const_cast<char *>(password)
  17988. : nullptr);
  17989. BIO_free(key_bio);
  17990. if (!key) {
  17991. X509_free(cert);
  17992. return false;
  17993. }
  17994. // Update certificate and key
  17995. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17996. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17997. X509_free(cert);
  17998. EVP_PKEY_free(key);
  17999. return ret;
  18000. }
  18001. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18002. if (!ctx || !ca_pem) { return false; }
  18003. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18004. // Create new X509_STORE from PEM
  18005. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  18006. if (!store) { return false; }
  18007. // A resumed session is not verified again, so the ticket keys from before
  18008. // go, or a client verified under the old CAs could go on resuming.
  18009. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  18010. unsigned char ticket_keys[48];
  18011. #else
  18012. unsigned char ticket_keys[80];
  18013. #endif
  18014. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  18015. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  18016. sizeof(ticket_keys)) != 1) {
  18017. free_ca_store(store);
  18018. return false;
  18019. }
  18020. // SSL_CTX_set_cert_store takes ownership
  18021. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  18022. // Set client CA list for client certificate request
  18023. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  18024. if (ca_list) {
  18025. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  18026. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  18027. }
  18028. // The cached sessions go for the same reason.
  18029. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  18030. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  18031. #else
  18032. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  18033. #endif
  18034. return true;
  18035. }
  18036. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18037. if (!ctx) { return false; }
  18038. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  18039. auto index = impl::verify_callback_index();
  18040. if (index < 0) { return false; }
  18041. std::shared_ptr<VerifyCallback> *stored = nullptr;
  18042. if (callback) {
  18043. stored = new std::shared_ptr<VerifyCallback>(
  18044. std::make_shared<VerifyCallback>(std::move(callback)));
  18045. }
  18046. std::shared_ptr<VerifyCallback> *previous = nullptr;
  18047. {
  18048. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  18049. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  18050. SSL_CTX_get_ex_data(ssl_ctx, index));
  18051. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  18052. delete stored;
  18053. return false;
  18054. }
  18055. }
  18056. // A handshake running the previous callback keeps it until it returns.
  18057. delete previous;
  18058. // A resumed handshake shows no certificate to run the callback on.
  18059. if (stored) {
  18060. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  18061. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  18062. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  18063. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  18064. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  18065. #endif
  18066. }
  18067. // Keep requiring the peer's certificate if set_verify_client() asked for it
  18068. auto require =
  18069. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  18070. impl::apply_verify_mode(ssl_ctx, require);
  18071. return true;
  18072. }
  18073. inline long get_verify_error(const_session_t session) {
  18074. if (!session) { return -1; }
  18075. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  18076. return SSL_get_verify_result(ssl);
  18077. }
  18078. inline std::string verify_error_string(long error_code) {
  18079. if (error_code == X509_V_OK) { return ""; }
  18080. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  18081. return str ? str : "unknown error";
  18082. }
  18083. } // namespace tls
  18084. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  18085. /*
  18086. * Group 9: TLS abstraction layer - Mbed TLS backend
  18087. */
  18088. /*
  18089. * Mbed TLS Backend Implementation
  18090. */
  18091. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  18092. namespace tls {
  18093. namespace impl {
  18094. // Mbed TLS session wrapper
  18095. struct MbedTlsSession {
  18096. mbedtls_ssl_context ssl;
  18097. socket_t sock = INVALID_SOCKET;
  18098. std::string hostname; // For client: set via set_sni
  18099. std::string sni_hostname; // For server: received from client via SNI callback
  18100. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  18101. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  18102. // (e.g. a response that arrived while this side was still in its post-write
  18103. // check), the byte is pushed back here and served by the next read().
  18104. unsigned char peeked_byte = 0;
  18105. bool has_peeked_byte = false;
  18106. // Set by set_sni() when the caller disabled hostname verification, so the
  18107. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  18108. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  18109. // OpenSSL and wolfSSL keep them independent).
  18110. bool suppress_hostname_mismatch = false;
  18111. // Copied from the owning MbedTlsContext at creation, so a handshake only
  18112. // ever runs the callback of its own context.
  18113. VerifyCallback verify_callback;
  18114. bool is_server = false;
  18115. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  18116. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  18117. MbedTlsSession(const MbedTlsSession &) = delete;
  18118. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  18119. };
  18120. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  18121. // queue)
  18122. inline int &mbedtls_last_error() {
  18123. static thread_local int err = 0;
  18124. return err;
  18125. }
  18126. // Helper to map Mbed TLS error to ErrorCode
  18127. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  18128. uint32_t verify_flags) {
  18129. if (ret == 0) { return ErrorCode::Success; }
  18130. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  18131. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  18132. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  18133. return ErrorCode::PeerClosed;
  18134. }
  18135. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  18136. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  18137. out_errno = errno;
  18138. return ErrorCode::SyscallError;
  18139. }
  18140. if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
  18141. // EOF without close_notify
  18142. out_errno = 0;
  18143. return ErrorCode::SyscallError;
  18144. }
  18145. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  18146. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  18147. // the handshake's chain verification (see set_sni()); a mismatch there
  18148. // is reported the same way as any other verify_flags bit. Report it as
  18149. // HostnameMismatch, matching the other backends and the post-handshake
  18150. // identity check below, but only when naming is the sole problem -
  18151. // if the chain itself is also untrusted/expired/etc., that takes
  18152. // priority over the naming detail.
  18153. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  18154. return ErrorCode::HostnameMismatch;
  18155. }
  18156. return ErrorCode::CertVerifyFailed;
  18157. }
  18158. return ErrorCode::Fatal;
  18159. }
  18160. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  18161. // return value, including the verify-flags-dependent HostnameMismatch
  18162. // mapping; shared by connect() and connect_nonblocking() so the
  18163. // backend_code policy for that mapping only lives in one place.
  18164. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  18165. int ret) {
  18166. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  18167. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  18168. err.backend_code = err.code == ErrorCode::HostnameMismatch
  18169. ? static_cast<uint64_t>(verify_flags)
  18170. : static_cast<uint64_t>(-ret);
  18171. }
  18172. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  18173. // non-fatal notification delivered between records, not an error and not
  18174. // application data, so I/O calls that see it should just be retried. Kept in
  18175. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  18176. // splitting the closing brace across an #if.
  18177. inline bool mbedtls_is_session_ticket(int ret) {
  18178. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  18179. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  18180. #else
  18181. (void)ret;
  18182. return false;
  18183. #endif
  18184. }
  18185. // BIO-like send callback for Mbed TLS
  18186. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  18187. size_t len) {
  18188. auto sock = *static_cast<socket_t *>(ctx);
  18189. #ifdef _WIN32
  18190. auto ret =
  18191. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  18192. if (ret == SOCKET_ERROR) {
  18193. int err = WSAGetLastError();
  18194. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  18195. return MBEDTLS_ERR_NET_SEND_FAILED;
  18196. }
  18197. #else
  18198. auto ret = send(sock, buf, len, 0);
  18199. if (ret < 0) {
  18200. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18201. return MBEDTLS_ERR_SSL_WANT_WRITE;
  18202. }
  18203. return MBEDTLS_ERR_NET_SEND_FAILED;
  18204. }
  18205. #endif
  18206. return static_cast<int>(ret);
  18207. }
  18208. // BIO-like recv callback for Mbed TLS
  18209. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  18210. auto sock = *static_cast<socket_t *>(ctx);
  18211. #ifdef _WIN32
  18212. auto ret =
  18213. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  18214. if (ret == SOCKET_ERROR) {
  18215. int err = WSAGetLastError();
  18216. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  18217. return MBEDTLS_ERR_NET_RECV_FAILED;
  18218. }
  18219. #else
  18220. auto ret = recv(sock, buf, len, 0);
  18221. if (ret < 0) {
  18222. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  18223. return MBEDTLS_ERR_SSL_WANT_READ;
  18224. }
  18225. return MBEDTLS_ERR_NET_RECV_FAILED;
  18226. }
  18227. #endif
  18228. // EOF is MBEDTLS_ERR_SSL_CONN_EOF; only a close_notify is a clean end
  18229. return static_cast<int>(ret);
  18230. }
  18231. // MbedTlsContext constructor/destructor implementations
  18232. inline MbedTlsContext::MbedTlsContext() {
  18233. mbedtls_ssl_config_init(&conf);
  18234. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18235. mbedtls_entropy_init(&entropy);
  18236. mbedtls_ctr_drbg_init(&ctr_drbg);
  18237. #endif
  18238. mbedtls_x509_crt_init(&ca_chain);
  18239. mbedtls_x509_crt_init(&own_cert);
  18240. mbedtls_pk_init(&own_key);
  18241. }
  18242. inline MbedTlsContext::~MbedTlsContext() {
  18243. mbedtls_pk_free(&own_key);
  18244. mbedtls_x509_crt_free(&own_cert);
  18245. mbedtls_x509_crt_free(&ca_chain);
  18246. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18247. mbedtls_ctr_drbg_free(&ctr_drbg);
  18248. mbedtls_entropy_free(&entropy);
  18249. #endif
  18250. mbedtls_ssl_config_free(&conf);
  18251. }
  18252. // Thread-local storage for SNI captured during handshake
  18253. // This is needed because the SNI callback doesn't have a way to pass
  18254. // session-specific data before the session is fully set up
  18255. inline std::string &mbedpending_sni() {
  18256. static thread_local std::string sni;
  18257. return sni;
  18258. }
  18259. // SNI callback for Mbed TLS server to capture client's SNI hostname
  18260. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  18261. const unsigned char *name, size_t name_len) {
  18262. (void)p_ctx;
  18263. (void)ssl;
  18264. // Store SNI name in thread-local storage
  18265. // It will be retrieved and stored in the session after handshake
  18266. if (name && name_len > 0) {
  18267. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  18268. } else {
  18269. mbedpending_sni().clear();
  18270. }
  18271. return 0; // Accept any SNI
  18272. }
  18273. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  18274. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  18275. }
  18276. // MbedTLS verify callback wrapper
  18277. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  18278. int cert_depth, uint32_t *flags) {
  18279. // data points to the MbedTlsSession
  18280. auto *session = static_cast<MbedTlsSession *>(data);
  18281. // set_sni() disabled hostname verification for this session: ignore the
  18282. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  18283. // pass/fail decision still comes from the remaining flags (and, below, from
  18284. // the user's own verify callback).
  18285. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  18286. const auto &callback = session->verify_callback;
  18287. if (!callback) { return 0; } // Continue with default verification
  18288. // Build context
  18289. VerifyContext verify_ctx;
  18290. verify_ctx.session = static_cast<session_t>(session);
  18291. verify_ctx.cert = static_cast<cert_t>(crt);
  18292. verify_ctx.depth = cert_depth;
  18293. verify_ctx.preverify_ok = (*flags == 0);
  18294. verify_ctx.error_code = static_cast<long>(*flags);
  18295. // Convert Mbed TLS flags to error string
  18296. static thread_local char error_buf[256];
  18297. if (*flags != 0) {
  18298. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  18299. verify_ctx.error_string = error_buf;
  18300. } else {
  18301. verify_ctx.error_string = nullptr;
  18302. }
  18303. bool accepted = run_verify_callback(callback, verify_ctx);
  18304. if (accepted) {
  18305. // Overrides the built-in verification only on a server, as on OpenSSL and
  18306. // wolfSSL, whose clients check the verify result after the handshake
  18307. if (session->is_server) { *flags = 0; }
  18308. return 0;
  18309. }
  18310. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  18311. }
  18312. // Sets the authentication mode from whether the peer's certificate is required
  18313. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18314. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18315. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18316. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18317. if (mctx.verify_client) {
  18318. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18319. } else if (mctx.verify_callback) {
  18320. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18321. }
  18322. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18323. }
  18324. } // namespace impl
  18325. inline ctx_t create_client_context() {
  18326. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18327. if (!ctx) { return nullptr; }
  18328. ctx->is_server = false;
  18329. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18330. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18331. if (!detail::ensure_mbedtls_psa_crypto()) {
  18332. delete ctx;
  18333. return nullptr;
  18334. }
  18335. int ret;
  18336. #else
  18337. // Seed the random number generator
  18338. const char *pers = "httplib_client";
  18339. int ret = mbedtls_ctr_drbg_seed(
  18340. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18341. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18342. if (ret != 0) {
  18343. impl::mbedtls_last_error() = ret;
  18344. delete ctx;
  18345. return nullptr;
  18346. }
  18347. #endif
  18348. // Set up SSL config for client
  18349. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18350. MBEDTLS_SSL_TRANSPORT_STREAM,
  18351. MBEDTLS_SSL_PRESET_DEFAULT);
  18352. if (ret != 0) {
  18353. impl::mbedtls_last_error() = ret;
  18354. delete ctx;
  18355. return nullptr;
  18356. }
  18357. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18358. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18359. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18360. #endif
  18361. // Default: verify peer certificate
  18362. ctx->verify_client = true;
  18363. impl::apply_verify_mode(*ctx);
  18364. // Set minimum TLS version to 1.2
  18365. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18366. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18367. #else
  18368. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18369. MBEDTLS_SSL_MINOR_VERSION_3);
  18370. #endif
  18371. return static_cast<ctx_t>(ctx);
  18372. }
  18373. inline ctx_t create_server_context() {
  18374. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18375. if (!ctx) { return nullptr; }
  18376. ctx->is_server = true;
  18377. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18378. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18379. if (!detail::ensure_mbedtls_psa_crypto()) {
  18380. delete ctx;
  18381. return nullptr;
  18382. }
  18383. int ret;
  18384. #else
  18385. // Seed the random number generator
  18386. const char *pers = "httplib_server";
  18387. int ret = mbedtls_ctr_drbg_seed(
  18388. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18389. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18390. if (ret != 0) {
  18391. impl::mbedtls_last_error() = ret;
  18392. delete ctx;
  18393. return nullptr;
  18394. }
  18395. #endif
  18396. // Set up SSL config for server
  18397. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18398. MBEDTLS_SSL_TRANSPORT_STREAM,
  18399. MBEDTLS_SSL_PRESET_DEFAULT);
  18400. if (ret != 0) {
  18401. impl::mbedtls_last_error() = ret;
  18402. delete ctx;
  18403. return nullptr;
  18404. }
  18405. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18406. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18407. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18408. #endif
  18409. // Default: don't verify client
  18410. impl::apply_verify_mode(*ctx);
  18411. // Set minimum TLS version to 1.2
  18412. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18413. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18414. #else
  18415. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18416. MBEDTLS_SSL_MINOR_VERSION_3);
  18417. #endif
  18418. // Set SNI callback to capture client's SNI hostname
  18419. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18420. return static_cast<ctx_t>(ctx);
  18421. }
  18422. inline void free_context(ctx_t ctx) {
  18423. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18424. }
  18425. inline bool set_min_version(ctx_t ctx, Version version) {
  18426. if (!ctx) { return false; }
  18427. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18428. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18429. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18430. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18431. if (version >= Version::TLS1_3) {
  18432. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18433. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18434. #endif
  18435. }
  18436. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18437. #else
  18438. // Mbed TLS 2.x uses major/minor version numbers
  18439. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18440. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18441. if (version >= Version::TLS1_3) {
  18442. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18443. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18444. #else
  18445. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18446. #endif
  18447. }
  18448. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18449. #endif
  18450. return true;
  18451. }
  18452. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18453. if (!ctx || !pem) { return false; }
  18454. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18455. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18456. // Add null terminator if not present
  18457. std::string pem_str(pem, len);
  18458. int ret = mbedtls_x509_crt_parse(
  18459. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18460. pem_str.size() + 1);
  18461. if (ret != 0) {
  18462. impl::mbedtls_last_error() = ret;
  18463. return false;
  18464. }
  18465. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18466. return true;
  18467. }
  18468. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18469. if (!ctx || !file_path) { return false; }
  18470. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18471. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18472. if (ret != 0) {
  18473. impl::mbedtls_last_error() = ret;
  18474. return false;
  18475. }
  18476. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18477. return true;
  18478. }
  18479. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18480. if (!ctx || !dir_path) { return false; }
  18481. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18482. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18483. if (ret < 0) { // Returns number of certs on success, negative on error
  18484. impl::mbedtls_last_error() = ret;
  18485. return false;
  18486. }
  18487. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18488. return true;
  18489. }
  18490. inline bool load_system_certs(ctx_t ctx) {
  18491. if (!ctx) { return false; }
  18492. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18493. bool loaded = false;
  18494. #ifdef _WIN32
  18495. loaded = impl::enumerate_windows_system_certs(
  18496. [&](const unsigned char *data, size_t len) {
  18497. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18498. });
  18499. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18500. loaded = impl::enumerate_macos_keychain_certs(
  18501. [&](const unsigned char *data, size_t len) {
  18502. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18503. });
  18504. #else
  18505. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18506. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18507. loaded = true;
  18508. break;
  18509. }
  18510. }
  18511. if (!loaded) {
  18512. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18513. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18514. loaded = true;
  18515. break;
  18516. }
  18517. }
  18518. }
  18519. #endif
  18520. if (loaded) {
  18521. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18522. }
  18523. return loaded;
  18524. }
  18525. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18526. const char *password) {
  18527. if (!ctx || !cert || !key) { return false; }
  18528. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18529. // Parse certificate
  18530. std::string cert_str(cert);
  18531. int ret = mbedtls_x509_crt_parse(
  18532. &mctx->own_cert,
  18533. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18534. cert_str.size() + 1);
  18535. if (ret != 0) {
  18536. impl::mbedtls_last_error() = ret;
  18537. return false;
  18538. }
  18539. // Parse private key
  18540. std::string key_str(key);
  18541. const unsigned char *pwd =
  18542. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18543. size_t pwd_len = password ? strlen(password) : 0;
  18544. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18545. ret = mbedtls_pk_parse_key(
  18546. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18547. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18548. &mctx->ctr_drbg);
  18549. #else
  18550. ret = mbedtls_pk_parse_key(
  18551. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18552. key_str.size() + 1, pwd, pwd_len);
  18553. #endif
  18554. if (ret != 0) {
  18555. impl::mbedtls_last_error() = ret;
  18556. return false;
  18557. }
  18558. // Verify that the certificate and private key match.
  18559. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18560. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18561. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18562. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18563. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18564. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18565. #else
  18566. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18567. #endif
  18568. if (ret != 0) {
  18569. impl::mbedtls_last_error() = ret;
  18570. return false;
  18571. }
  18572. #endif
  18573. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18574. if (ret != 0) {
  18575. impl::mbedtls_last_error() = ret;
  18576. return false;
  18577. }
  18578. return true;
  18579. }
  18580. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18581. const char *key_path, const char *password) {
  18582. if (!ctx || !cert_path || !key_path) { return false; }
  18583. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18584. // Parse certificate file
  18585. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18586. if (ret != 0) {
  18587. impl::mbedtls_last_error() = ret;
  18588. return false;
  18589. }
  18590. // Parse private key file
  18591. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18592. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18593. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18594. #else
  18595. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18596. #endif
  18597. if (ret != 0) {
  18598. impl::mbedtls_last_error() = ret;
  18599. return false;
  18600. }
  18601. // Verify that the certificate and private key match.
  18602. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18603. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18604. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18605. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18606. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18607. #else
  18608. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18609. #endif
  18610. if (ret != 0) {
  18611. impl::mbedtls_last_error() = ret;
  18612. return false;
  18613. }
  18614. #endif
  18615. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18616. if (ret != 0) {
  18617. impl::mbedtls_last_error() = ret;
  18618. return false;
  18619. }
  18620. return true;
  18621. }
  18622. inline void set_verify_client(ctx_t ctx, bool require) {
  18623. if (!ctx) { return; }
  18624. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18625. mctx->verify_client = require;
  18626. impl::apply_verify_mode(*mctx);
  18627. }
  18628. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18629. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18630. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18631. auto session = new (std::nothrow) impl::MbedTlsSession();
  18632. if (!session) { return nullptr; }
  18633. session->sock = sock;
  18634. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18635. if (ret != 0) {
  18636. impl::mbedtls_last_error() = ret;
  18637. delete session;
  18638. return nullptr;
  18639. }
  18640. // Explicitly opt out of in-handshake hostname verification by default;
  18641. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18642. // fails outright when no hostname was set. set_sni() installs the real
  18643. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18644. // caller verifies the certificate identity post-handshake via
  18645. // verify_hostname().
  18646. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18647. // Set BIO callbacks
  18648. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18649. impl::mbedtls_net_recv_cb, nullptr);
  18650. // Installed always, as it also masks the hostname mismatch that set_sni()
  18651. // may ask for. The session runs its own copy of the user's callback, which
  18652. // set_verify_callback() cannot replace under a handshake.
  18653. session->verify_callback = mctx->verify_callback;
  18654. session->is_server = mctx->is_server;
  18655. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18656. return static_cast<session_t>(session);
  18657. }
  18658. inline void free_session(session_t session) {
  18659. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18660. }
  18661. inline bool set_sni(session_t session, const char *hostname,
  18662. bool verify_hostname) {
  18663. if (!session || !hostname) { return false; }
  18664. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18665. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18666. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18667. // independently, so a disabled hostname check is handled below by masking
  18668. // the resulting mismatch flag instead of skipping this call.
  18669. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18670. if (ret != 0) {
  18671. impl::mbedtls_last_error() = ret;
  18672. return false;
  18673. }
  18674. msession->hostname = hostname;
  18675. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18676. return true;
  18677. }
  18678. inline TlsError connect(session_t session) {
  18679. TlsError err;
  18680. if (!session) {
  18681. err.code = ErrorCode::Fatal;
  18682. return err;
  18683. }
  18684. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18685. int ret;
  18686. do {
  18687. ret = mbedtls_ssl_handshake(&msession->ssl);
  18688. } while (impl::mbedtls_is_session_ticket(ret));
  18689. if (ret == 0) {
  18690. err.code = ErrorCode::Success;
  18691. } else {
  18692. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18693. impl::mbedtls_last_error() = ret;
  18694. }
  18695. return err;
  18696. }
  18697. inline TlsError accept(session_t session) {
  18698. // A failed handshake leaves its SNI behind, so start without it
  18699. impl::mbedpending_sni().clear();
  18700. // Same as connect for Mbed TLS - handshake works for both client and server
  18701. auto result = connect(session);
  18702. // After successful handshake, capture SNI from thread-local storage
  18703. if (result.code == ErrorCode::Success && session) {
  18704. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18705. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18706. }
  18707. return result;
  18708. }
  18709. inline bool connect_nonblocking(session_t session, socket_t sock,
  18710. time_t timeout_sec, time_t timeout_usec,
  18711. TlsError *err) {
  18712. if (!session) {
  18713. if (err) { err->code = ErrorCode::Fatal; }
  18714. return false;
  18715. }
  18716. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18717. // Set socket to non-blocking mode
  18718. detail::set_nonblocking(sock, true);
  18719. auto cleanup =
  18720. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18721. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18722. int ret;
  18723. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18724. // Non-fatal TLS 1.3 ticket; retry immediately.
  18725. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18726. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18727. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18728. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18729. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18730. }
  18731. // TlsError or timeout
  18732. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18733. impl::mbedtls_last_error() = ret;
  18734. return false;
  18735. }
  18736. if (err) { err->code = ErrorCode::Success; }
  18737. return true;
  18738. }
  18739. inline bool accept_nonblocking(session_t session, socket_t sock,
  18740. time_t timeout_sec, time_t timeout_usec,
  18741. TlsError *err) {
  18742. // A failed handshake leaves its SNI behind, so start without it
  18743. impl::mbedpending_sni().clear();
  18744. // Same implementation as connect for Mbed TLS
  18745. bool result =
  18746. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18747. // After successful handshake, capture SNI from thread-local storage
  18748. if (result && session) {
  18749. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18750. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18751. }
  18752. return result;
  18753. }
  18754. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18755. if (!session || !buf) {
  18756. err.code = ErrorCode::Fatal;
  18757. return -1;
  18758. }
  18759. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18760. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18761. if (msession->has_peeked_byte) {
  18762. if (len == 0) { return 0; }
  18763. auto p = static_cast<unsigned char *>(buf);
  18764. p[0] = msession->peeked_byte;
  18765. msession->has_peeked_byte = false;
  18766. size_t n = 1;
  18767. // Top up with any already-decrypted bytes without risking a block.
  18768. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18769. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18770. if (extra > 0) { n += static_cast<size_t>(extra); }
  18771. }
  18772. err.code = ErrorCode::Success;
  18773. return static_cast<ssize_t>(n);
  18774. }
  18775. int ret;
  18776. do {
  18777. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18778. len);
  18779. } while (impl::mbedtls_is_session_ticket(ret));
  18780. if (ret > 0) {
  18781. err.code = ErrorCode::Success;
  18782. return static_cast<ssize_t>(ret);
  18783. }
  18784. // 0 means EOF without close_notify, which is an error as on OpenSSL
  18785. if (ret == 0) { ret = MBEDTLS_ERR_SSL_CONN_EOF; }
  18786. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18787. err.backend_code = static_cast<uint64_t>(-ret);
  18788. impl::mbedtls_last_error() = ret;
  18789. // mbedTLS signals a clean close_notify via a negative error code rather
  18790. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18791. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18792. return -1;
  18793. }
  18794. inline ssize_t write(session_t session, const void *buf, size_t len,
  18795. TlsError &err) {
  18796. if (!session || !buf) {
  18797. err.code = ErrorCode::Fatal;
  18798. return -1;
  18799. }
  18800. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18801. int ret;
  18802. do {
  18803. ret = mbedtls_ssl_write(&msession->ssl,
  18804. static_cast<const unsigned char *>(buf), len);
  18805. } while (impl::mbedtls_is_session_ticket(ret));
  18806. if (ret > 0) {
  18807. err.code = ErrorCode::Success;
  18808. return static_cast<ssize_t>(ret);
  18809. }
  18810. if (ret == 0) {
  18811. err.code = ErrorCode::PeerClosed;
  18812. return 0;
  18813. }
  18814. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18815. err.backend_code = static_cast<uint64_t>(-ret);
  18816. impl::mbedtls_last_error() = ret;
  18817. return -1;
  18818. }
  18819. inline int pending(const_session_t session) {
  18820. if (!session) { return 0; }
  18821. auto msession =
  18822. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18823. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18824. (msession->has_peeked_byte ? 1 : 0);
  18825. }
  18826. inline void shutdown(session_t session, bool graceful) {
  18827. if (!session) { return; }
  18828. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18829. if (graceful) {
  18830. // Try to send close_notify, but don't block forever
  18831. int ret;
  18832. int attempts = 0;
  18833. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18834. attempts < 3) {
  18835. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18836. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18837. break;
  18838. }
  18839. attempts++;
  18840. }
  18841. }
  18842. }
  18843. inline bool is_peer_closed(session_t session, socket_t sock) {
  18844. if (!session || sock == INVALID_SOCKET) { return true; }
  18845. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18846. // Check if there's already decrypted or pushed-back data available.
  18847. // If so, the connection is definitely alive.
  18848. if (msession->has_peeked_byte ||
  18849. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18850. return false;
  18851. }
  18852. // Set socket to non-blocking to avoid blocking on read
  18853. detail::set_nonblocking(sock, true);
  18854. auto cleanup =
  18855. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18856. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18857. // on application data — e.g. a response that already arrived — push the
  18858. // byte back so the next read() delivers it instead of losing it.
  18859. unsigned char buf;
  18860. int ret;
  18861. do {
  18862. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18863. } while (impl::mbedtls_is_session_ticket(ret));
  18864. // If we got data or WANT_READ (would block), connection is alive
  18865. if (ret > 0) {
  18866. msession->peeked_byte = buf;
  18867. msession->has_peeked_byte = true;
  18868. return false;
  18869. }
  18870. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18871. // If we get a peer close notify or a connection reset, the peer is closed
  18872. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18873. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18874. }
  18875. inline cert_t get_peer_cert(const_session_t session) {
  18876. if (!session) { return nullptr; }
  18877. auto msession =
  18878. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18879. // Mbed TLS returns a pointer to the internal peer cert chain.
  18880. // WARNING: This pointer is only valid while the session is active.
  18881. // Do not use the certificate after calling free_session().
  18882. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18883. return const_cast<mbedtls_x509_crt *>(cert);
  18884. }
  18885. inline size_t get_peer_certs(const_session_t session,
  18886. std::vector<cert_t> &certs) {
  18887. certs.clear();
  18888. // Mbed TLS parses the whole received chain into a list headed by the peer
  18889. // certificate, owned by the session like get_peer_cert()'s result
  18890. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18891. crt && crt->raw.len > 0; crt = crt->next) {
  18892. certs.push_back(static_cast<cert_t>(crt));
  18893. }
  18894. return certs.size();
  18895. }
  18896. inline void free_cert(cert_t cert) {
  18897. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18898. // chain, so there is nothing to free. Callers still call this for the other
  18899. // backends.
  18900. (void)cert;
  18901. }
  18902. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18903. if (!cert || !hostname) { return false; }
  18904. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18905. std::string host_str(hostname);
  18906. // Check if hostname is an IP address (IPv4 or IPv6)
  18907. unsigned char ip_bytes[16];
  18908. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18909. auto is_ip = ip_len > 0;
  18910. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18911. // in buf.tag and the raw value in buf.p / buf.len.
  18912. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18913. if (!san->buf.p || san->buf.len == 0) { continue; }
  18914. const unsigned char *p = san->buf.p;
  18915. size_t len = san->buf.len;
  18916. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18917. if (is_ip) {
  18918. // For an IP host, only a matching iPAddress SAN of the same family
  18919. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18920. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18921. memcmp(p, ip_bytes, ip_len) == 0) {
  18922. return true;
  18923. }
  18924. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18925. std::string san_name(reinterpret_cast<const char *>(p), len);
  18926. if (detail::match_hostname(san_name, host_str)) { return true; }
  18927. }
  18928. }
  18929. return false;
  18930. }
  18931. inline uint64_t hostname_mismatch_code() {
  18932. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18933. }
  18934. inline long get_verify_result(const_session_t session) {
  18935. if (!session) { return -1; }
  18936. auto msession =
  18937. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18938. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18939. // Return 0 (X509_V_OK equivalent) if verification passed
  18940. return flags == 0 ? 0 : static_cast<long>(flags);
  18941. }
  18942. inline std::string get_cert_subject_cn(cert_t cert) {
  18943. if (!cert) return "";
  18944. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18945. // Find the CN in the subject
  18946. const mbedtls_x509_name *name = &x509->subject;
  18947. while (name != nullptr) {
  18948. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18949. return std::string(reinterpret_cast<const char *>(name->val.p),
  18950. name->val.len);
  18951. }
  18952. name = name->next;
  18953. }
  18954. return "";
  18955. }
  18956. inline std::string get_cert_issuer_name(cert_t cert) {
  18957. if (!cert) return "";
  18958. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18959. // Build a human-readable issuer name string
  18960. char buf[512];
  18961. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18962. if (ret < 0) return "";
  18963. return std::string(buf);
  18964. }
  18965. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18966. sans.clear();
  18967. if (!cert) return false;
  18968. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18969. // Parse the Subject Alternative Name extension
  18970. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18971. while (cur != nullptr) {
  18972. if (cur->buf.len > 0) {
  18973. const unsigned char *p = cur->buf.p;
  18974. size_t value_len = cur->buf.len;
  18975. SanEntry entry;
  18976. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18977. case MBEDTLS_X509_SAN_DNS_NAME:
  18978. entry.type = SanType::DNS;
  18979. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18980. break;
  18981. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18982. entry.type = SanType::IP;
  18983. if (value_len == 4) {
  18984. // IPv4
  18985. char buf[16];
  18986. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18987. entry.value = buf;
  18988. } else if (value_len == 16) {
  18989. // IPv6
  18990. char buf[64];
  18991. snprintf(buf, sizeof(buf),
  18992. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18993. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18994. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18995. p[10], p[11], p[12], p[13], p[14], p[15]);
  18996. entry.value = buf;
  18997. }
  18998. break;
  18999. case MBEDTLS_X509_SAN_RFC822_NAME:
  19000. entry.type = SanType::EMAIL;
  19001. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19002. break;
  19003. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  19004. entry.type = SanType::URI;
  19005. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  19006. break;
  19007. default: entry.type = SanType::OTHER; break;
  19008. }
  19009. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19010. }
  19011. cur = cur->next;
  19012. }
  19013. return true;
  19014. }
  19015. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19016. time_t &not_after) {
  19017. if (!cert) return false;
  19018. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19019. // Convert mbedtls_x509_time to time_t
  19020. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  19021. struct tm tm_time = {};
  19022. tm_time.tm_year = t.year - 1900;
  19023. tm_time.tm_mon = t.mon - 1;
  19024. tm_time.tm_mday = t.day;
  19025. tm_time.tm_hour = t.hour;
  19026. tm_time.tm_min = t.min;
  19027. tm_time.tm_sec = t.sec;
  19028. #ifdef _WIN32
  19029. return _mkgmtime(&tm_time);
  19030. #else
  19031. return timegm(&tm_time);
  19032. #endif
  19033. };
  19034. not_before = to_time_t(x509->valid_from);
  19035. not_after = to_time_t(x509->valid_to);
  19036. return true;
  19037. }
  19038. inline std::string get_cert_serial(cert_t cert) {
  19039. if (!cert) return "";
  19040. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  19041. // Convert serial number to hex string
  19042. std::string result;
  19043. result.reserve(x509->serial.len * 2);
  19044. for (size_t i = 0; i < x509->serial.len; i++) {
  19045. char hex[3];
  19046. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  19047. result += hex;
  19048. }
  19049. return result;
  19050. }
  19051. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19052. if (!cert) return false;
  19053. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  19054. if (!crt->raw.p || crt->raw.len == 0) return false;
  19055. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  19056. return true;
  19057. }
  19058. inline const char *get_sni(const_session_t session) {
  19059. if (!session) return nullptr;
  19060. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  19061. // For server: return SNI received from client during handshake
  19062. if (!msession->sni_hostname.empty()) {
  19063. return msession->sni_hostname.c_str();
  19064. }
  19065. // For client: return the hostname set via set_sni
  19066. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  19067. return nullptr;
  19068. }
  19069. inline uint64_t peek_error() {
  19070. // Mbed TLS doesn't have an error queue, return the last error
  19071. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  19072. }
  19073. inline uint64_t get_error() {
  19074. // Mbed TLS doesn't have an error queue, return and clear the last error
  19075. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  19076. impl::mbedtls_last_error() = 0;
  19077. return err;
  19078. }
  19079. inline std::string error_string(uint64_t code) {
  19080. char buf[256];
  19081. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  19082. return std::string(buf);
  19083. }
  19084. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19085. #ifdef CPPHTTPLIB_MBEDTLS_V4
  19086. // Parsing certificates needs PSA Crypto, and no context may exist yet
  19087. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  19088. #endif
  19089. if (!pem) { return nullptr; }
  19090. // mbedtls_x509_crt_parse expects null-terminated PEM
  19091. std::string pem_str(pem, len);
  19092. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  19093. if (!ca_chain) { return nullptr; }
  19094. mbedtls_x509_crt_init(ca_chain);
  19095. auto ret = mbedtls_x509_crt_parse(
  19096. ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  19097. pem_str.size() + 1);
  19098. if (ret != 0) {
  19099. mbedtls_x509_crt_free(ca_chain);
  19100. delete ca_chain;
  19101. return nullptr;
  19102. }
  19103. return static_cast<ca_store_t>(ca_chain);
  19104. }
  19105. inline void free_ca_store(ca_store_t store) {
  19106. if (store) {
  19107. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19108. mbedtls_x509_crt_free(ca_chain);
  19109. delete ca_chain;
  19110. }
  19111. }
  19112. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19113. if (!ctx || !store) { return false; }
  19114. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19115. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  19116. // Free existing CA chain
  19117. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  19118. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  19119. // Copy the CA chain (deep copy)
  19120. // Parse from the raw data of the source cert
  19121. mbedtls_x509_crt *src = ca_chain;
  19122. while (src != nullptr) {
  19123. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  19124. src->raw.len);
  19125. if (ret != 0) {
  19126. free_ca_store(store);
  19127. return false;
  19128. }
  19129. src = src->next;
  19130. }
  19131. // This function takes ownership of the store; the chain was deep-copied
  19132. // above, so release the source
  19133. free_ca_store(store);
  19134. // Update the SSL config to use the new CA chain
  19135. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19136. return true;
  19137. }
  19138. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19139. certs.clear();
  19140. if (!ctx) { return 0; }
  19141. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19142. // Owned by the context; see free_cert()
  19143. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  19144. cert = cert->next) {
  19145. certs.push_back(static_cast<cert_t>(cert));
  19146. }
  19147. return certs.size();
  19148. }
  19149. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19150. std::vector<std::string> names;
  19151. if (!ctx) { return names; }
  19152. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19153. // Iterate through the CA chain
  19154. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  19155. while (cert != nullptr && cert->raw.len > 0) {
  19156. char buf[512];
  19157. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  19158. if (ret > 0) { names.push_back(buf); }
  19159. cert = cert->next;
  19160. }
  19161. return names;
  19162. }
  19163. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19164. const char *key_pem, const char *password) {
  19165. if (!ctx || !cert_pem || !key_pem) { return false; }
  19166. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19167. // Parse into new objects first, so that a bad pair leaves the old one in
  19168. // place, and swap them in after; the old ones are freed on the way out.
  19169. mbedtls_x509_crt cert;
  19170. mbedtls_pk_context key;
  19171. mbedtls_x509_crt_init(&cert);
  19172. mbedtls_pk_init(&key);
  19173. auto se = detail::scope_exit([&] {
  19174. mbedtls_x509_crt_free(&cert);
  19175. mbedtls_pk_free(&key);
  19176. });
  19177. // Parse certificate PEM
  19178. int ret = mbedtls_x509_crt_parse(
  19179. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  19180. strlen(cert_pem) + 1);
  19181. if (ret != 0) {
  19182. impl::mbedtls_last_error() = ret;
  19183. return false;
  19184. }
  19185. // Parse private key PEM
  19186. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  19187. ret = mbedtls_pk_parse_key(
  19188. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19189. strlen(key_pem) + 1,
  19190. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19191. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  19192. &mbed_ctx->ctr_drbg);
  19193. #else
  19194. ret = mbedtls_pk_parse_key(
  19195. &key, reinterpret_cast<const unsigned char *>(key_pem),
  19196. strlen(key_pem) + 1,
  19197. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  19198. password ? strlen(password) : 0);
  19199. #endif
  19200. if (ret != 0) {
  19201. impl::mbedtls_last_error() = ret;
  19202. return false;
  19203. }
  19204. std::swap(mbed_ctx->own_cert, cert);
  19205. std::swap(mbed_ctx->own_key, key);
  19206. // Configure SSL to use the new certificate and key
  19207. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  19208. &mbed_ctx->own_key);
  19209. if (ret != 0) {
  19210. impl::mbedtls_last_error() = ret;
  19211. return false;
  19212. }
  19213. return true;
  19214. }
  19215. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19216. if (!ctx || !ca_pem) { return false; }
  19217. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19218. // Parse into a new chain first, so that a bad one leaves the old in place
  19219. mbedtls_x509_crt chain;
  19220. mbedtls_x509_crt_init(&chain);
  19221. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  19222. // Parse CA PEM
  19223. int ret = mbedtls_x509_crt_parse(
  19224. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  19225. strlen(ca_pem) + 1);
  19226. if (ret != 0) {
  19227. impl::mbedtls_last_error() = ret;
  19228. return false;
  19229. }
  19230. std::swap(mbed_ctx->ca_chain, chain);
  19231. // Update SSL config to use new CA chain
  19232. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  19233. return true;
  19234. }
  19235. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19236. if (!ctx) { return false; }
  19237. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  19238. // create_session() hands each session its own copy to run.
  19239. mbed_ctx->verify_callback = std::move(callback);
  19240. impl::apply_verify_mode(*mbed_ctx);
  19241. return true;
  19242. }
  19243. inline long get_verify_error(const_session_t session) {
  19244. if (!session) { return -1; }
  19245. auto *msession =
  19246. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  19247. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  19248. }
  19249. inline std::string verify_error_string(long error_code) {
  19250. if (error_code == 0) { return ""; }
  19251. char buf[256];
  19252. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  19253. static_cast<uint32_t>(error_code));
  19254. // Remove trailing newline if present
  19255. std::string result(buf);
  19256. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  19257. result.pop_back();
  19258. }
  19259. return result;
  19260. }
  19261. } // namespace tls
  19262. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  19263. /*
  19264. * Group 10: TLS abstraction layer - wolfSSL backend
  19265. */
  19266. /*
  19267. * wolfSSL Backend Implementation
  19268. */
  19269. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  19270. namespace tls {
  19271. namespace impl {
  19272. // wolfSSL session wrapper
  19273. struct WolfSSLSession {
  19274. WOLFSSL *ssl = nullptr;
  19275. socket_t sock = INVALID_SOCKET;
  19276. std::string hostname; // For client: set via set_sni
  19277. std::string sni_hostname; // For server: received from client via SNI callback
  19278. WolfSSLSession() = default;
  19279. ~WolfSSLSession() {
  19280. if (ssl) { wolfSSL_free(ssl); }
  19281. }
  19282. WolfSSLSession(const WolfSSLSession &) = delete;
  19283. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  19284. };
  19285. // Thread-local error code accessor for wolfSSL
  19286. inline uint64_t &wolfssl_last_error() {
  19287. static thread_local uint64_t err = 0;
  19288. return err;
  19289. }
  19290. // Helper to map wolfSSL error to ErrorCode.
  19291. // ssl_error is the value from wolfSSL_get_error().
  19292. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  19293. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19294. int &out_errno) {
  19295. switch (ssl_error) {
  19296. case SSL_ERROR_NONE: return ErrorCode::Success;
  19297. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19298. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19299. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19300. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19301. // EOF without close_notify
  19302. case SOCKET_PEER_CLOSED_E: out_errno = 0; return ErrorCode::SyscallError;
  19303. default:
  19304. if (ssl) {
  19305. // wolfSSL stores the low-level error code as a negative value.
  19306. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19307. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19308. if (low_err == DOMAIN_NAME_MISMATCH) {
  19309. return ErrorCode::HostnameMismatch;
  19310. }
  19311. // Check verify result to distinguish cert verification from generic SSL
  19312. // errors.
  19313. long vr = wolfSSL_get_verify_result(ssl);
  19314. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19315. }
  19316. return ErrorCode::Fatal;
  19317. }
  19318. }
  19319. // WolfSSLContext constructor/destructor implementations
  19320. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19321. inline WolfSSLContext::~WolfSSLContext() {
  19322. if (ctx) { wolfSSL_CTX_free(ctx); }
  19323. }
  19324. // Thread-local storage for SNI captured during handshake
  19325. inline std::string &wolfssl_pending_sni() {
  19326. static thread_local std::string sni;
  19327. return sni;
  19328. }
  19329. // SNI callback for wolfSSL server to capture client's SNI hostname
  19330. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19331. (void)ret;
  19332. (void)exArg;
  19333. void *name_data = nullptr;
  19334. unsigned short name_len =
  19335. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19336. if (name_data && name_len > 0) {
  19337. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19338. name_len);
  19339. } else {
  19340. wolfssl_pending_sni().clear();
  19341. }
  19342. return 0; // Continue regardless
  19343. }
  19344. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19345. // runs the verify callback of its own context.
  19346. inline int context_ex_data_index() {
  19347. static const auto index =
  19348. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19349. return index;
  19350. }
  19351. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19352. // other tls:: function takes.
  19353. inline int session_ex_data_index() {
  19354. static const auto index =
  19355. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19356. return index;
  19357. }
  19358. // A resumed session skips the client's certificate, so a server that checks
  19359. // one would let in a certificate checked against another server's CA, as
  19360. // wolfSSL shares its session cache between contexts, or against a CA since
  19361. // replaced by update_server_client_ca().
  19362. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19363. if (!wctx->is_server) { return; }
  19364. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19365. #ifdef HAVE_SESSION_TICKET
  19366. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19367. #endif
  19368. }
  19369. // wolfSSL verify callback wrapper
  19370. inline int wolfssl_verify_callback(int preverify_ok,
  19371. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19372. // Get the WOLFSSL object from the X509_STORE_CTX
  19373. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19374. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19375. if (!ssl) { return preverify_ok; }
  19376. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19377. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19378. if (!wctx) { return preverify_ok; }
  19379. std::shared_ptr<VerifyCallback> callback;
  19380. {
  19381. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19382. callback = wctx->verify_callback;
  19383. }
  19384. if (!callback) { return preverify_ok; }
  19385. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19386. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19387. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19388. VerifyContext verify_ctx;
  19389. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19390. verify_ctx.cert = static_cast<cert_t>(cert);
  19391. verify_ctx.depth = depth;
  19392. verify_ctx.preverify_ok = (preverify_ok != 0);
  19393. verify_ctx.error_code = static_cast<long>(err);
  19394. if (err != 0) {
  19395. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19396. } else {
  19397. verify_ctx.error_string = nullptr;
  19398. }
  19399. auto accepted = run_verify_callback(*callback, verify_ctx);
  19400. // A client verifying the server during the handshake, which is what
  19401. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19402. if (!wolfSSL_is_server(ssl) &&
  19403. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19404. accepted = accepted && preverify_ok;
  19405. }
  19406. return accepted ? 1 : 0;
  19407. }
  19408. // Sets the verify mode from whether the peer's certificate is required and
  19409. // whether a verify callback is set.
  19410. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19411. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19412. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19413. auto mode = wctx.verify_client
  19414. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19415. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19416. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19417. has_callback ? wolfssl_verify_callback : nullptr);
  19418. }
  19419. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19420. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19421. wolfSSL_CTX_set_default_passwd_cb(
  19422. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19423. auto *pwd = static_cast<const char *>(userdata);
  19424. if (!pwd) return 0;
  19425. auto len = static_cast<int>(strlen(pwd));
  19426. if (len > size) len = size;
  19427. memcpy(buf, pwd, static_cast<size_t>(len));
  19428. return len;
  19429. });
  19430. }
  19431. } // namespace impl
  19432. inline ctx_t create_client_context() {
  19433. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19434. if (!ctx) { return nullptr; }
  19435. ctx->is_server = false;
  19436. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19437. if (!method) {
  19438. delete ctx;
  19439. return nullptr;
  19440. }
  19441. ctx->ctx = wolfSSL_CTX_new(method);
  19442. if (!ctx->ctx ||
  19443. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19444. WOLFSSL_SUCCESS) {
  19445. delete ctx;
  19446. return nullptr;
  19447. }
  19448. // Default: verify peer certificate
  19449. ctx->verify_client = true;
  19450. impl::apply_verify_mode(*ctx);
  19451. return static_cast<ctx_t>(ctx);
  19452. }
  19453. inline ctx_t create_server_context() {
  19454. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19455. if (!ctx) { return nullptr; }
  19456. ctx->is_server = true;
  19457. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19458. if (!method) {
  19459. delete ctx;
  19460. return nullptr;
  19461. }
  19462. ctx->ctx = wolfSSL_CTX_new(method);
  19463. if (!ctx->ctx ||
  19464. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19465. WOLFSSL_SUCCESS) {
  19466. delete ctx;
  19467. return nullptr;
  19468. }
  19469. // Default: don't verify client
  19470. impl::apply_verify_mode(*ctx);
  19471. // Enable SNI on server
  19472. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19473. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19474. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19475. return static_cast<ctx_t>(ctx);
  19476. }
  19477. inline void free_context(ctx_t ctx) {
  19478. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19479. }
  19480. inline bool set_min_version(ctx_t ctx, Version version) {
  19481. if (!ctx) { return false; }
  19482. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19483. int min_ver = WOLFSSL_TLSV1_2;
  19484. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19485. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19486. }
  19487. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19488. if (!ctx || !pem) { return false; }
  19489. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19490. int ret = wolfSSL_CTX_load_verify_buffer(
  19491. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19492. static_cast<long>(len), SSL_FILETYPE_PEM);
  19493. if (ret != SSL_SUCCESS) {
  19494. impl::wolfssl_last_error() =
  19495. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19496. return false;
  19497. }
  19498. wctx->ca_pem_data_.append(pem, len);
  19499. return true;
  19500. }
  19501. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19502. if (!ctx || !file_path) { return false; }
  19503. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19504. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19505. if (ret != SSL_SUCCESS) {
  19506. impl::wolfssl_last_error() =
  19507. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19508. return false;
  19509. }
  19510. return true;
  19511. }
  19512. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19513. if (!ctx || !dir_path) { return false; }
  19514. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19515. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19516. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19517. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19518. // immediately. Return true even on failure since the CA file may have
  19519. // already been loaded, matching OpenSSL's lenient behavior.
  19520. (void)ret;
  19521. return true;
  19522. }
  19523. inline bool load_system_certs(ctx_t ctx) {
  19524. if (!ctx) { return false; }
  19525. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19526. bool loaded = false;
  19527. #ifdef _WIN32
  19528. loaded = impl::enumerate_windows_system_certs(
  19529. [&](const unsigned char *data, size_t len) {
  19530. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19531. static_cast<long>(len),
  19532. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19533. });
  19534. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19535. loaded = impl::enumerate_macos_keychain_certs(
  19536. [&](const unsigned char *data, size_t len) {
  19537. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19538. static_cast<long>(len),
  19539. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19540. });
  19541. #else
  19542. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19543. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19544. SSL_SUCCESS) {
  19545. loaded = true;
  19546. break;
  19547. }
  19548. }
  19549. if (!loaded) {
  19550. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19551. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19552. SSL_SUCCESS) {
  19553. loaded = true;
  19554. break;
  19555. }
  19556. }
  19557. }
  19558. #endif
  19559. return loaded;
  19560. }
  19561. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19562. const char *password) {
  19563. if (!ctx || !cert || !key) { return false; }
  19564. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19565. // Load certificate
  19566. int ret = wolfSSL_CTX_use_certificate_buffer(
  19567. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19568. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19569. if (ret != SSL_SUCCESS) {
  19570. impl::wolfssl_last_error() =
  19571. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19572. return false;
  19573. }
  19574. // Set password callback if password is provided
  19575. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19576. // Load private key
  19577. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19578. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19579. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19580. if (ret != SSL_SUCCESS) {
  19581. impl::wolfssl_last_error() =
  19582. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19583. return false;
  19584. }
  19585. // Verify that the certificate and private key match
  19586. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19587. }
  19588. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19589. const char *key_path, const char *password) {
  19590. if (!ctx || !cert_path || !key_path) { return false; }
  19591. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19592. // Load certificate file
  19593. int ret =
  19594. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19595. if (ret != SSL_SUCCESS) {
  19596. impl::wolfssl_last_error() =
  19597. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19598. return false;
  19599. }
  19600. // Set password callback if password is provided
  19601. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19602. // Load private key file
  19603. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19604. if (ret != SSL_SUCCESS) {
  19605. impl::wolfssl_last_error() =
  19606. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19607. return false;
  19608. }
  19609. // Verify that the certificate and private key match
  19610. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19611. }
  19612. inline void set_verify_client(ctx_t ctx, bool require) {
  19613. if (!ctx) { return; }
  19614. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19615. wctx->verify_client = require;
  19616. impl::apply_verify_mode(*wctx);
  19617. }
  19618. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19619. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19620. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19621. auto session = new (std::nothrow) impl::WolfSSLSession();
  19622. if (!session) { return nullptr; }
  19623. session->sock = sock;
  19624. session->ssl = wolfSSL_new(wctx->ctx);
  19625. if (!session->ssl) {
  19626. impl::wolfssl_last_error() =
  19627. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19628. delete session;
  19629. return nullptr;
  19630. }
  19631. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19632. session) != WOLFSSL_SUCCESS) {
  19633. delete session;
  19634. return nullptr;
  19635. }
  19636. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19637. return static_cast<session_t>(session);
  19638. }
  19639. inline void free_session(session_t session) {
  19640. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19641. }
  19642. inline bool set_sni(session_t session, const char *hostname,
  19643. bool verify_hostname) {
  19644. if (!session || !hostname) { return false; }
  19645. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19646. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19647. static_cast<word16>(strlen(hostname)));
  19648. if (ret != WOLFSSL_SUCCESS) {
  19649. impl::wolfssl_last_error() =
  19650. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19651. return false;
  19652. }
  19653. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19654. // separately from the SNI extension sent above; skip it when hostname
  19655. // verification is disabled so only the chain is checked, matching OpenSSL.
  19656. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19657. wsession->hostname = hostname;
  19658. return true;
  19659. }
  19660. inline TlsError connect(session_t session) {
  19661. TlsError err;
  19662. if (!session) {
  19663. err.code = ErrorCode::Fatal;
  19664. return err;
  19665. }
  19666. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19667. int ret = wolfSSL_connect(wsession->ssl);
  19668. if (ret == SSL_SUCCESS) {
  19669. err.code = ErrorCode::Success;
  19670. } else {
  19671. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19672. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19673. err.backend_code = static_cast<uint64_t>(ssl_error);
  19674. impl::wolfssl_last_error() = err.backend_code;
  19675. }
  19676. return err;
  19677. }
  19678. inline TlsError accept(session_t session) {
  19679. TlsError err;
  19680. if (!session) {
  19681. err.code = ErrorCode::Fatal;
  19682. return err;
  19683. }
  19684. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19685. int ret = wolfSSL_accept(wsession->ssl);
  19686. if (ret == SSL_SUCCESS) {
  19687. err.code = ErrorCode::Success;
  19688. // Capture SNI from thread-local storage after successful handshake
  19689. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19690. impl::wolfssl_pending_sni().clear();
  19691. } else {
  19692. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19693. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19694. err.backend_code = static_cast<uint64_t>(ssl_error);
  19695. impl::wolfssl_last_error() = err.backend_code;
  19696. }
  19697. return err;
  19698. }
  19699. inline bool connect_nonblocking(session_t session, socket_t sock,
  19700. time_t timeout_sec, time_t timeout_usec,
  19701. TlsError *err) {
  19702. if (!session) {
  19703. if (err) { err->code = ErrorCode::Fatal; }
  19704. return false;
  19705. }
  19706. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19707. // Set socket to non-blocking mode
  19708. detail::set_nonblocking(sock, true);
  19709. auto cleanup =
  19710. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19711. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19712. int ret;
  19713. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19714. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19715. if (ssl_error == SSL_ERROR_WANT_READ) {
  19716. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19717. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19718. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19719. }
  19720. // Error or timeout
  19721. if (err) {
  19722. err->code =
  19723. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19724. err->backend_code = static_cast<uint64_t>(ssl_error);
  19725. }
  19726. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19727. return false;
  19728. }
  19729. if (err) { err->code = ErrorCode::Success; }
  19730. return true;
  19731. }
  19732. inline bool accept_nonblocking(session_t session, socket_t sock,
  19733. time_t timeout_sec, time_t timeout_usec,
  19734. TlsError *err) {
  19735. if (!session) {
  19736. if (err) { err->code = ErrorCode::Fatal; }
  19737. return false;
  19738. }
  19739. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19740. // Set socket to non-blocking mode
  19741. detail::set_nonblocking(sock, true);
  19742. auto cleanup =
  19743. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19744. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19745. int ret;
  19746. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19747. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19748. if (ssl_error == SSL_ERROR_WANT_READ) {
  19749. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19750. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19751. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19752. }
  19753. // Error or timeout
  19754. if (err) {
  19755. err->code =
  19756. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19757. err->backend_code = static_cast<uint64_t>(ssl_error);
  19758. }
  19759. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19760. return false;
  19761. }
  19762. if (err) { err->code = ErrorCode::Success; }
  19763. // Capture SNI from thread-local storage after successful handshake
  19764. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19765. impl::wolfssl_pending_sni().clear();
  19766. return true;
  19767. }
  19768. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19769. if (!session || !buf) {
  19770. err.code = ErrorCode::Fatal;
  19771. return -1;
  19772. }
  19773. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19774. constexpr auto max_len =
  19775. static_cast<size_t>((std::numeric_limits<int>::max)());
  19776. if (len > max_len) { len = max_len; }
  19777. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19778. if (ret > 0) {
  19779. err.code = ErrorCode::Success;
  19780. return static_cast<ssize_t>(ret);
  19781. }
  19782. // 0 is also returned for EOF without close_notify; get_error tells them apart
  19783. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19784. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19785. if (err.code == ErrorCode::PeerClosed) { return 0; }
  19786. err.backend_code = static_cast<uint64_t>(ssl_error);
  19787. impl::wolfssl_last_error() = err.backend_code;
  19788. return -1;
  19789. }
  19790. inline ssize_t write(session_t session, const void *buf, size_t len,
  19791. TlsError &err) {
  19792. if (!session || !buf) {
  19793. err.code = ErrorCode::Fatal;
  19794. return -1;
  19795. }
  19796. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19797. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19798. if (ret > 0) {
  19799. err.code = ErrorCode::Success;
  19800. return static_cast<ssize_t>(ret);
  19801. }
  19802. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19803. // Treat this as an error (return -1) so callers don't spin in a
  19804. // write loop adding zero to the offset.
  19805. if (ret == 0) {
  19806. err.code = ErrorCode::PeerClosed;
  19807. return -1;
  19808. }
  19809. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19810. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19811. err.backend_code = static_cast<uint64_t>(ssl_error);
  19812. impl::wolfssl_last_error() = err.backend_code;
  19813. return -1;
  19814. }
  19815. inline int pending(const_session_t session) {
  19816. if (!session) { return 0; }
  19817. auto wsession =
  19818. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19819. return wolfSSL_pending(wsession->ssl);
  19820. }
  19821. inline void shutdown(session_t session, bool graceful) {
  19822. if (!session) { return; }
  19823. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19824. if (graceful) {
  19825. int ret;
  19826. int attempts = 0;
  19827. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19828. attempts < 3) {
  19829. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19830. if (ssl_error != SSL_ERROR_WANT_READ &&
  19831. ssl_error != SSL_ERROR_WANT_WRITE) {
  19832. break;
  19833. }
  19834. attempts++;
  19835. }
  19836. } else {
  19837. wolfSSL_shutdown(wsession->ssl);
  19838. }
  19839. }
  19840. inline bool is_peer_closed(session_t session, socket_t sock) {
  19841. if (!session || sock == INVALID_SOCKET) { return true; }
  19842. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19843. // Check if there's already decrypted data available
  19844. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19845. // Set socket to non-blocking to avoid blocking on read
  19846. detail::set_nonblocking(sock, true);
  19847. auto cleanup =
  19848. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19849. // Peek 1 byte to check connection status without consuming data
  19850. unsigned char buf;
  19851. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19852. // If we got data or WANT_READ (would block), connection is alive
  19853. if (ret > 0) { return false; }
  19854. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19855. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19856. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19857. ret == 0;
  19858. }
  19859. inline cert_t get_peer_cert(const_session_t session) {
  19860. if (!session) { return nullptr; }
  19861. auto wsession =
  19862. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19863. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19864. return static_cast<cert_t>(cert);
  19865. }
  19866. inline size_t get_peer_certs(const_session_t session,
  19867. std::vector<cert_t> &certs) {
  19868. certs.clear();
  19869. if (!session) { return 0; }
  19870. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19871. #ifdef SESSION_CERTS
  19872. auto wsession =
  19873. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19874. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19875. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19876. for (int i = 0; i < count; i++) {
  19877. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19878. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19879. }
  19880. #endif
  19881. return certs.size();
  19882. }
  19883. inline void free_cert(cert_t cert) {
  19884. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19885. }
  19886. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19887. if (!cert || !hostname) { return false; }
  19888. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19889. std::string host_str(hostname);
  19890. // Check if hostname is an IP address (IPv4 or IPv6)
  19891. unsigned char ip_bytes[16];
  19892. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19893. auto is_ip = ip_len > 0;
  19894. // Check Subject Alternative Names
  19895. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19896. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19897. if (san_names) {
  19898. int san_count = wolfSSL_sk_num(san_names);
  19899. for (int i = 0; i < san_count; i++) {
  19900. auto *names =
  19901. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19902. if (!names) continue;
  19903. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19904. // DNS name
  19905. unsigned char *dns_name = nullptr;
  19906. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19907. if (dns_name && dns_len > 0) {
  19908. std::string san_name(reinterpret_cast<char *>(dns_name),
  19909. static_cast<size_t>(dns_len));
  19910. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19911. if (detail::match_hostname(san_name, host_str)) {
  19912. wolfSSL_sk_free(san_names);
  19913. return true;
  19914. }
  19915. }
  19916. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19917. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19918. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19919. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19920. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19921. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19922. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19923. wolfSSL_sk_free(san_names);
  19924. return true;
  19925. }
  19926. }
  19927. }
  19928. wolfSSL_sk_free(san_names);
  19929. }
  19930. return false;
  19931. }
  19932. inline uint64_t hostname_mismatch_code() {
  19933. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19934. }
  19935. inline long get_verify_result(const_session_t session) {
  19936. if (!session) { return -1; }
  19937. auto wsession =
  19938. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19939. long result = wolfSSL_get_verify_result(wsession->ssl);
  19940. return result;
  19941. }
  19942. inline std::string get_cert_subject_cn(cert_t cert) {
  19943. if (!cert) return "";
  19944. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19945. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19946. if (!subject) return "";
  19947. char cn[256] = {};
  19948. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19949. sizeof(cn));
  19950. if (cn_len <= 0) return "";
  19951. return std::string(cn, static_cast<size_t>(cn_len));
  19952. }
  19953. inline std::string get_cert_issuer_name(cert_t cert) {
  19954. if (!cert) return "";
  19955. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19956. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19957. if (!issuer) return "";
  19958. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19959. if (!name_str) return "";
  19960. std::string result(name_str);
  19961. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19962. return result;
  19963. }
  19964. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19965. sans.clear();
  19966. if (!cert) return false;
  19967. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19968. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19969. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19970. if (!san_names) return true; // No SANs is not an error
  19971. int count = wolfSSL_sk_num(san_names);
  19972. for (int i = 0; i < count; i++) {
  19973. auto *name =
  19974. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19975. if (!name) continue;
  19976. SanEntry entry;
  19977. switch (name->type) {
  19978. case WOLFSSL_GEN_DNS: {
  19979. entry.type = SanType::DNS;
  19980. unsigned char *dns_name = nullptr;
  19981. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19982. if (dns_name && dns_len > 0) {
  19983. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19984. static_cast<size_t>(dns_len));
  19985. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19986. }
  19987. break;
  19988. }
  19989. case WOLFSSL_GEN_IPADD: {
  19990. entry.type = SanType::IP;
  19991. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19992. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19993. if (ip_data && ip_len == 4) {
  19994. char buf[16];
  19995. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19996. ip_data[2], ip_data[3]);
  19997. entry.value = buf;
  19998. } else if (ip_data && ip_len == 16) {
  19999. char buf[64];
  20000. snprintf(buf, sizeof(buf),
  20001. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  20002. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  20003. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  20004. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  20005. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  20006. ip_data[14], ip_data[15]);
  20007. entry.value = buf;
  20008. }
  20009. break;
  20010. }
  20011. case WOLFSSL_GEN_EMAIL:
  20012. entry.type = SanType::EMAIL;
  20013. {
  20014. unsigned char *email = nullptr;
  20015. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  20016. if (email && email_len > 0) {
  20017. entry.value = std::string(reinterpret_cast<char *>(email),
  20018. static_cast<size_t>(email_len));
  20019. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  20020. }
  20021. }
  20022. break;
  20023. case WOLFSSL_GEN_URI:
  20024. entry.type = SanType::URI;
  20025. {
  20026. unsigned char *uri = nullptr;
  20027. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  20028. &uri, name->d.uniformResourceIdentifier);
  20029. if (uri && uri_len > 0) {
  20030. entry.value = std::string(reinterpret_cast<char *>(uri),
  20031. static_cast<size_t>(uri_len));
  20032. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  20033. }
  20034. }
  20035. break;
  20036. default: entry.type = SanType::OTHER; break;
  20037. }
  20038. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  20039. }
  20040. wolfSSL_sk_free(san_names);
  20041. return true;
  20042. }
  20043. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  20044. time_t &not_after) {
  20045. if (!cert) return false;
  20046. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20047. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  20048. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  20049. if (!nb || !na) return false;
  20050. // wolfSSL_ASN1_TIME_to_tm is available
  20051. struct tm tm_nb = {}, tm_na = {};
  20052. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  20053. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  20054. #ifdef _WIN32
  20055. not_before = _mkgmtime(&tm_nb);
  20056. not_after = _mkgmtime(&tm_na);
  20057. #else
  20058. not_before = timegm(&tm_nb);
  20059. not_after = timegm(&tm_na);
  20060. #endif
  20061. return true;
  20062. }
  20063. inline std::string get_cert_serial(cert_t cert) {
  20064. if (!cert) return "";
  20065. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20066. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  20067. if (!serial_asn1) return "";
  20068. // Get the serial number data
  20069. int len = serial_asn1->length;
  20070. unsigned char *data = serial_asn1->data;
  20071. if (!data || len <= 0) return "";
  20072. std::string result;
  20073. result.reserve(static_cast<size_t>(len) * 2);
  20074. for (int i = 0; i < len; i++) {
  20075. char hex[3];
  20076. snprintf(hex, sizeof(hex), "%02X", data[i]);
  20077. result += hex;
  20078. }
  20079. return result;
  20080. }
  20081. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  20082. if (!cert) return false;
  20083. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  20084. int der_len = 0;
  20085. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  20086. if (!der_data || der_len <= 0) return false;
  20087. der.assign(der_data, der_data + der_len);
  20088. return true;
  20089. }
  20090. inline const char *get_sni(const_session_t session) {
  20091. if (!session) return nullptr;
  20092. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  20093. // For server: return SNI received from client during handshake
  20094. if (!wsession->sni_hostname.empty()) {
  20095. return wsession->sni_hostname.c_str();
  20096. }
  20097. // For client: return the hostname set via set_sni
  20098. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  20099. return nullptr;
  20100. }
  20101. inline uint64_t peek_error() {
  20102. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  20103. }
  20104. inline uint64_t get_error() {
  20105. uint64_t err = impl::wolfssl_last_error();
  20106. impl::wolfssl_last_error() = 0;
  20107. return err;
  20108. }
  20109. inline std::string error_string(uint64_t code) {
  20110. char buf[256];
  20111. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  20112. return std::string(buf);
  20113. }
  20114. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  20115. if (!pem || len == 0) { return nullptr; }
  20116. // Validate by attempting to load into a temporary ctx
  20117. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  20118. if (!tmp_ctx) { return nullptr; }
  20119. int ret = wolfSSL_CTX_load_verify_buffer(
  20120. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  20121. static_cast<long>(len), SSL_FILETYPE_PEM);
  20122. wolfSSL_CTX_free(tmp_ctx);
  20123. if (ret != SSL_SUCCESS) { return nullptr; }
  20124. return static_cast<ca_store_t>(
  20125. new impl::WolfSSLCAStore{std::string(pem, len)});
  20126. }
  20127. inline void free_ca_store(ca_store_t store) {
  20128. delete static_cast<impl::WolfSSLCAStore *>(store);
  20129. }
  20130. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  20131. if (!ctx || !store) { return false; }
  20132. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20133. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  20134. int ret = wolfSSL_CTX_load_verify_buffer(
  20135. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  20136. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  20137. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  20138. // This function takes ownership of the store; the PEM data was copied into
  20139. // the context, so release the source
  20140. free_ca_store(store);
  20141. return ret == SSL_SUCCESS;
  20142. }
  20143. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  20144. certs.clear();
  20145. if (!ctx) { return 0; }
  20146. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20147. if (wctx->ca_pem_data_.empty()) { return 0; }
  20148. const std::string &pem = wctx->ca_pem_data_;
  20149. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20150. const std::string end_marker = "-----END CERTIFICATE-----";
  20151. size_t pos = 0;
  20152. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20153. size_t end_pos = pem.find(end_marker, pos);
  20154. if (end_pos == std::string::npos) { break; }
  20155. end_pos += end_marker.size();
  20156. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20157. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20158. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20159. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20160. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  20161. pos = end_pos;
  20162. }
  20163. return certs.size();
  20164. }
  20165. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  20166. std::vector<std::string> names;
  20167. if (!ctx) { return names; }
  20168. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20169. if (wctx->ca_pem_data_.empty()) { return names; }
  20170. const std::string &pem = wctx->ca_pem_data_;
  20171. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  20172. const std::string end_marker = "-----END CERTIFICATE-----";
  20173. size_t pos = 0;
  20174. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  20175. size_t end_pos = pem.find(end_marker, pos);
  20176. if (end_pos == std::string::npos) { break; }
  20177. end_pos += end_marker.size();
  20178. std::string cert_pem = pem.substr(pos, end_pos - pos);
  20179. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  20180. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  20181. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  20182. if (x509) {
  20183. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  20184. if (subject) {
  20185. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  20186. if (name_str) {
  20187. names.push_back(name_str);
  20188. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  20189. }
  20190. }
  20191. wolfSSL_X509_free(x509);
  20192. }
  20193. pos = end_pos;
  20194. }
  20195. return names;
  20196. }
  20197. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  20198. const char *key_pem, const char *password) {
  20199. if (!ctx || !cert_pem || !key_pem) { return false; }
  20200. // Try the pair on a scratch context first, so that a bad one leaves the
  20201. // server's certificate and key as they were
  20202. auto tmp = create_server_context();
  20203. if (!tmp) { return false; }
  20204. auto se = detail::scope_exit([&] { free_context(tmp); });
  20205. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  20206. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  20207. }
  20208. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  20209. if (!ctx || !ca_pem) { return false; }
  20210. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20211. // Replace the CAs rather than add to them, as the other backends do, once
  20212. // the new ones are known to load
  20213. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  20214. if (!store) { return false; }
  20215. free_ca_store(store);
  20216. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  20217. wctx->ca_pem_data_.clear();
  20218. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  20219. }
  20220. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  20221. if (!ctx) { return false; }
  20222. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  20223. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  20224. : nullptr;
  20225. {
  20226. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  20227. // A handshake running the previous callback keeps it until it returns.
  20228. wctx->verify_callback.swap(stored);
  20229. }
  20230. impl::apply_verify_mode(*wctx);
  20231. return true;
  20232. }
  20233. inline long get_verify_error(const_session_t session) {
  20234. if (!session) { return -1; }
  20235. auto *wsession =
  20236. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  20237. return wolfSSL_get_verify_result(wsession->ssl);
  20238. }
  20239. inline std::string verify_error_string(long error_code) {
  20240. if (error_code == 0) { return ""; }
  20241. const char *str =
  20242. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  20243. return str ? std::string(str) : std::string();
  20244. }
  20245. } // namespace tls
  20246. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  20247. // WebSocket implementation
  20248. namespace ws {
  20249. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  20250. bool fin) {
  20251. std::lock_guard<std::mutex> lock(write_mutex_);
  20252. if (closed_) { return false; }
  20253. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  20254. }
  20255. inline ReadResult WebSocket::read(std::string &msg) {
  20256. // Answers a control frame; any other opcode here is a protocol error.
  20257. // Returns false when the connection is done.
  20258. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  20259. switch (op) {
  20260. case Opcode::Ping: {
  20261. std::lock_guard<std::mutex> lock(write_mutex_);
  20262. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  20263. payload.size(), true, !is_server_);
  20264. return true;
  20265. }
  20266. case Opcode::Pong: {
  20267. std::lock_guard<std::mutex> lock(ping_mutex_);
  20268. unacked_pings_ = 0;
  20269. return true;
  20270. }
  20271. case Opcode::Close: {
  20272. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  20273. // malformed, which is answered with a protocol error instead.
  20274. if (closed_.exchange(true)) { return false; }
  20275. auto reply = payload;
  20276. if (!impl::is_valid_close_payload(payload)) {
  20277. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  20278. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  20279. }
  20280. std::lock_guard<std::mutex> lock(write_mutex_);
  20281. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  20282. reply.size(), true, !is_server_);
  20283. return false;
  20284. }
  20285. default: closed_ = true; return false;
  20286. }
  20287. };
  20288. std::unique_lock<std::mutex> read_lock(read_mutex_);
  20289. while (!closed_) {
  20290. Opcode opcode;
  20291. std::string payload;
  20292. bool fin;
  20293. impl::FrameRead r =
  20294. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  20295. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  20296. // A timeout landed on a frame boundary of an open connection: it is
  20297. // untouched and still usable, so hand control back without closing it.
  20298. // That is only useful to a caller who asked for the timeout; the
  20299. // compile-time default is a backstop against a peer gone quiet, and
  20300. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  20301. // ends. A wait that a pong timeout cut short finds the connection closed.
  20302. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20303. return Timeout;
  20304. }
  20305. if (r != impl::FrameRead::Ok) {
  20306. closed_ = true;
  20307. return Fail;
  20308. }
  20309. switch (opcode) {
  20310. case Opcode::Text:
  20311. case Opcode::Binary: {
  20312. auto result = opcode == Opcode::Text ? Text : Binary;
  20313. msg = std::move(payload);
  20314. // Handle fragmentation
  20315. if (!fin) {
  20316. while (true) {
  20317. Opcode cont_opcode;
  20318. std::string cont_payload;
  20319. bool cont_fin;
  20320. // Only what is left of the limit, but room for a control frame,
  20321. // which may come between the fragments.
  20322. auto max_len =
  20323. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  20324. ? size_t(0)
  20325. : (std::max)(size_t(125),
  20326. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20327. msg.size());
  20328. // A timeout is not reportable here: half of a fragmented message is
  20329. // already in `msg` and read() has no way to resume it, so it is a
  20330. // failure like any other. Timeouts are only ever seen on a message
  20331. // boundary.
  20332. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  20333. cont_fin, is_server_,
  20334. max_len) != impl::FrameRead::Ok) {
  20335. closed_ = true;
  20336. return Fail;
  20337. }
  20338. // RFC 6455 5.4: the fragments are continuation frames, with only
  20339. // control frames between them.
  20340. if (cont_opcode != Opcode::Continuation) {
  20341. if (handle_control(cont_opcode, cont_payload)) { continue; }
  20342. return Fail;
  20343. }
  20344. msg += cont_payload;
  20345. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20346. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20347. closed_ = true;
  20348. return Fail;
  20349. }
  20350. if (cont_fin) { break; }
  20351. }
  20352. }
  20353. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20354. if (result == Text && !impl::is_valid_utf8(msg)) {
  20355. // close() takes the read lock to wait for the peer's Close reply, so
  20356. // it must not run while this thread still holds it.
  20357. read_lock.unlock();
  20358. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20359. return Fail;
  20360. }
  20361. return result;
  20362. }
  20363. default:
  20364. if (handle_control(opcode, payload)) { continue; }
  20365. return Fail;
  20366. }
  20367. }
  20368. return Fail;
  20369. }
  20370. inline bool WebSocket::send(const std::string &data) {
  20371. return send_frame(Opcode::Text, data.data(), data.size());
  20372. }
  20373. inline bool WebSocket::send(const char *data, size_t len) {
  20374. return send_frame(Opcode::Binary, data, len);
  20375. }
  20376. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20377. if (closed_.exchange(true)) { return; }
  20378. ping_cv_.notify_all();
  20379. std::string payload;
  20380. auto code = static_cast<uint16_t>(status);
  20381. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20382. payload.push_back(static_cast<char>(code & 0xFF));
  20383. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20384. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20385. // cut back to a whole UTF-8 character
  20386. auto short_reason = reason.substr(0, 123);
  20387. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20388. short_reason.pop_back();
  20389. }
  20390. payload += short_reason;
  20391. // A code that may not be sent, such as NoStatus, goes without a payload
  20392. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20393. {
  20394. std::lock_guard<std::mutex> lock(write_mutex_);
  20395. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20396. payload.size(), true, !is_server_);
  20397. }
  20398. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20399. // Close response before closing the TCP connection.
  20400. //
  20401. // Wait only when no other thread is parsing frames. When one is, it is the
  20402. // thread positioned to see the peer's reply, and reading here would take
  20403. // bytes out of the message it is assembling. Bailing out also leaves the
  20404. // stream, including its read timeout, entirely to that thread.
  20405. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20406. if (!read_lock.owns_lock()) { return; }
  20407. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20408. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20409. Opcode op;
  20410. std::string resp;
  20411. bool fin;
  20412. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20413. impl::FrameRead::Ok) {
  20414. if (op == Opcode::Close) { break; }
  20415. }
  20416. }
  20417. inline WebSocket::~WebSocket() {
  20418. {
  20419. std::lock_guard<std::mutex> lock(ping_mutex_);
  20420. closed_ = true;
  20421. }
  20422. ping_cv_.notify_all();
  20423. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20424. // A server's stream outlives this object
  20425. strm_.set_read_interrupt(nullptr);
  20426. }
  20427. inline void WebSocket::start_heartbeat() {
  20428. if (ping_interval_sec_ <= 0) { return; }
  20429. // A pong timeout ends a read() blocked on the silent peer
  20430. if (max_missed_pongs_ > 0) {
  20431. strm_.set_read_interrupt([this] { return pong_timed_out_.load(); });
  20432. }
  20433. ping_thread_ = std::thread([this]() {
  20434. std::unique_lock<std::mutex> lock(ping_mutex_);
  20435. // The predicate keeps a spurious wakeup from sending a ping early
  20436. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20437. [this]() { return closed_.load(); })) {
  20438. // If the peer has failed to respond to the previous pings, give up.
  20439. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20440. // opt-in liveness check controlled by max_missed_pongs_.
  20441. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20442. lock.unlock();
  20443. close(CloseStatus::GoingAway, "pong timeout");
  20444. pong_timed_out_ = true;
  20445. return;
  20446. }
  20447. lock.unlock();
  20448. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20449. lock.lock();
  20450. closed_ = true;
  20451. break;
  20452. }
  20453. lock.lock();
  20454. unacked_pings_++;
  20455. }
  20456. });
  20457. }
  20458. inline const Request &WebSocket::request() const { return req_; }
  20459. inline bool WebSocket::is_open() const { return !closed_; }
  20460. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20461. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20462. // poll(), where 0 would instead mean "return immediately", so hand it the
  20463. // negative poll uses for an unbounded wait.
  20464. if (sec == 0 && usec == 0) { sec = -1; }
  20465. strm_.set_read_timeout(sec, usec);
  20466. read_timeout_set_ = true;
  20467. }
  20468. // WebSocketClient implementation
  20469. inline WebSocketClient::WebSocketClient(
  20470. const std::string &scheme_host_port_path, const Headers &headers)
  20471. : headers_(headers) {
  20472. detail::UrlComponents uc;
  20473. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20474. !uc.host.empty() && !uc.path.empty()) {
  20475. auto &scheme = uc.scheme;
  20476. #ifdef CPPHTTPLIB_SSL_ENABLED
  20477. if (scheme != "ws" && scheme != "wss") {
  20478. #else
  20479. if (scheme != "ws") {
  20480. #endif
  20481. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20482. std::string msg = "'" + scheme + "' scheme is not supported.";
  20483. throw std::invalid_argument(msg);
  20484. #endif
  20485. return;
  20486. }
  20487. auto is_ssl = scheme == "wss";
  20488. host_ = std::move(uc.host);
  20489. port_ = is_ssl ? 443 : 80;
  20490. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20491. path_ = std::move(uc.path);
  20492. if (!uc.query.empty()) { path_ += uc.query; }
  20493. #ifdef CPPHTTPLIB_SSL_ENABLED
  20494. is_ssl_ = is_ssl;
  20495. if (is_ssl_) {
  20496. // The context lives as long as the client so that CA configuration
  20497. // survives reconnects; sessions are created per connection.
  20498. tls_ctx_ = tls::create_client_context();
  20499. if (!tls_ctx_) { return; }
  20500. }
  20501. #else
  20502. if (is_ssl) { return; }
  20503. #endif
  20504. is_valid_ = true;
  20505. }
  20506. }
  20507. #ifdef CPPHTTPLIB_SSL_ENABLED
  20508. inline WebSocketClient::WebSocketClient(
  20509. const std::string &scheme_host_port_path, const PemMemory &pem,
  20510. const Headers &headers)
  20511. : WebSocketClient(scheme_host_port_path, headers) {
  20512. // For ws:// URLs the client certificate is silently ignored, consistent
  20513. // with the TLS-only setters such as set_ca_cert_path().
  20514. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20515. std::string cert_buf, key_buf;
  20516. if (!tls::set_client_cert_pem(
  20517. tls_ctx_,
  20518. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20519. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20520. pem.private_key_password)) {
  20521. tls::free_context(tls_ctx_);
  20522. tls_ctx_ = nullptr;
  20523. is_valid_ = false;
  20524. }
  20525. }
  20526. }
  20527. #endif
  20528. inline WebSocketClient::~WebSocketClient() {
  20529. shutdown_and_close();
  20530. #ifdef CPPHTTPLIB_SSL_ENABLED
  20531. if (tls_ctx_) {
  20532. tls::free_context(tls_ctx_);
  20533. tls_ctx_ = nullptr;
  20534. }
  20535. #endif
  20536. }
  20537. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20538. inline void WebSocketClient::shutdown_and_close() {
  20539. // Send the close frame while the TLS session is still alive: ws_ holds an
  20540. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20541. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20542. if (ws_ && ws_->is_open()) { ws_->close(); }
  20543. ws_.reset();
  20544. #ifdef CPPHTTPLIB_SSL_ENABLED
  20545. if (is_ssl_) {
  20546. if (tls_session_) {
  20547. tls::shutdown(tls_session_, true);
  20548. tls::free_session(tls_session_);
  20549. tls_session_ = nullptr;
  20550. }
  20551. }
  20552. #endif
  20553. if (sock_ != INVALID_SOCKET) {
  20554. detail::shutdown_socket(sock_);
  20555. detail::close_socket(sock_);
  20556. sock_ = INVALID_SOCKET;
  20557. }
  20558. }
  20559. // The handshakes belong to establishing the connection, so an unset read
  20560. // timeout leaves them bounded by the connection timeout instead of forever.
  20561. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20562. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20563. return {connection_timeout_sec_, connection_timeout_usec_};
  20564. }
  20565. return {read_timeout_sec_, read_timeout_usec_};
  20566. }
  20567. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20568. Error &error, int &ssl_error,
  20569. uint64_t &ssl_backend_error) {
  20570. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20571. // The streams wait with poll(), where 0 instead means "return immediately",
  20572. // so they are given the negative poll uses for an unbounded wait.
  20573. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20574. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20575. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20576. #ifdef CPPHTTPLIB_SSL_ENABLED
  20577. if (is_ssl_) {
  20578. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20579. // is not safe to call concurrently on one client to begin with, since
  20580. // nothing else here is guarded either.
  20581. if (server_certificate_verification_ && !certs_loaded_) {
  20582. uint64_t backend_error = 0;
  20583. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20584. ca_cert_dir_path_, custom_ca_loaded_,
  20585. system_ca_mode_, backend_error);
  20586. certs_loaded_ = true;
  20587. }
  20588. detail::ClientTlsSessionOptions options;
  20589. options.server_hostname_verification = server_hostname_verification_;
  20590. options.session_verifier = session_verifier_;
  20591. auto timeout = handshake_timeout();
  20592. detail::ClientTlsSessionError tls_error;
  20593. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20594. server_certificate_verification_,
  20595. timeout.first, timeout.second,
  20596. &tls_error, options)) {
  20597. error = tls_error.error;
  20598. ssl_error = tls_error.ssl_error;
  20599. ssl_backend_error = tls_error.backend_error;
  20600. return false;
  20601. }
  20602. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20603. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20604. write_timeout_usec_));
  20605. return true;
  20606. }
  20607. #else
  20608. (void)error;
  20609. (void)ssl_error;
  20610. (void)ssl_backend_error;
  20611. #endif
  20612. strm = std::unique_ptr<Stream>(
  20613. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20614. write_timeout_sec_, write_timeout_usec_));
  20615. return true;
  20616. }
  20617. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20618. #ifdef CPPHTTPLIB_SSL_ENABLED
  20619. auto is_ssl = is_ssl_;
  20620. #else
  20621. auto is_ssl = false;
  20622. #endif
  20623. if (!req.has_header("Host")) {
  20624. req.headers.emplace("Host", detail::make_default_host_header_value(
  20625. host_, port_, is_ssl, address_family_));
  20626. }
  20627. detail::add_default_user_agent_header(req);
  20628. detail::add_authorization_header(req, basic_auth_username_,
  20629. basic_auth_password_,
  20630. bearer_token_auth_token_, false);
  20631. }
  20632. inline Result WebSocketClient::connect() {
  20633. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20634. shutdown_and_close();
  20635. auto error = Error::Success;
  20636. if (!create_and_connect_socket(error)) {
  20637. return Result{error, -1, Headers{}};
  20638. }
  20639. if (is_proxy_enabled()) {
  20640. Response proxy_res;
  20641. if (!connect_with_proxy(proxy_res, error)) {
  20642. shutdown_and_close();
  20643. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20644. }
  20645. }
  20646. std::unique_ptr<Stream> strm;
  20647. auto stream_error = Error::SSLConnection;
  20648. int ssl_error = 0;
  20649. uint64_t ssl_backend_error = 0;
  20650. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20651. shutdown_and_close();
  20652. #ifdef CPPHTTPLIB_SSL_ENABLED
  20653. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20654. #else
  20655. return Result{stream_error, -1, Headers{}};
  20656. #endif
  20657. }
  20658. Request req;
  20659. req.method = "GET";
  20660. req.path = path_;
  20661. req.headers = headers_;
  20662. prepare_default_headers(req);
  20663. detail::WebSocketUpgradeResponse upgrade;
  20664. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20665. shutdown_and_close();
  20666. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20667. }
  20668. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20669. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20670. websocket_ping_interval_sec_,
  20671. websocket_max_missed_pongs_));
  20672. // The stream was created with the timeout already; tell the WebSocket
  20673. // whether it came from the caller, so read() knows to report it as Timeout.
  20674. ws_->read_timeout_set_ = read_timeout_set_;
  20675. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20676. }
  20677. inline ReadResult WebSocketClient::read(std::string &msg) {
  20678. if (!ws_) { return Fail; }
  20679. return ws_->read(msg);
  20680. }
  20681. inline bool WebSocketClient::send(const std::string &data) {
  20682. if (!ws_) { return false; }
  20683. return ws_->send(data);
  20684. }
  20685. inline bool WebSocketClient::send(const char *data, size_t len) {
  20686. if (!ws_) { return false; }
  20687. return ws_->send(data, len);
  20688. }
  20689. inline void WebSocketClient::close(CloseStatus status,
  20690. const std::string &reason) {
  20691. if (ws_) { ws_->close(status, reason); }
  20692. }
  20693. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20694. inline const std::string &WebSocketClient::subprotocol() const {
  20695. return subprotocol_;
  20696. }
  20697. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20698. read_timeout_sec_ = sec;
  20699. read_timeout_usec_ = usec;
  20700. read_timeout_set_ = true;
  20701. // The members above only seed the next connect(); read() consults the
  20702. // stream, so an already-open connection has to be told directly.
  20703. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20704. }
  20705. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20706. write_timeout_sec_ = sec;
  20707. write_timeout_usec_ = usec;
  20708. }
  20709. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20710. websocket_ping_interval_sec_ = sec;
  20711. }
  20712. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20713. websocket_max_missed_pongs_ = count;
  20714. }
  20715. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20716. inline void WebSocketClient::set_address_family(int family) {
  20717. address_family_ = family;
  20718. }
  20719. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20720. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20721. socket_options_ = std::move(socket_options);
  20722. }
  20723. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20724. connection_timeout_sec_ = sec;
  20725. connection_timeout_usec_ = usec;
  20726. }
  20727. inline void WebSocketClient::set_interface(const std::string &intf) {
  20728. interface_ = intf;
  20729. }
  20730. inline void WebSocketClient::set_hostname_addr_map(
  20731. std::map<std::string, std::string> addr_map) {
  20732. set_direct_hostname_addr_map(std::move(addr_map));
  20733. }
  20734. inline void WebSocketClient::set_direct_hostname_addr_map(
  20735. std::map<std::string, std::string> addr_map) {
  20736. addr_map_ = std::move(addr_map);
  20737. }
  20738. inline void WebSocketClient::set_tunnel_hostname_addr_map(
  20739. std::map<std::string, std::string> addr_map) {
  20740. tunnel_addr_map_ = std::move(addr_map);
  20741. }
  20742. inline bool WebSocketClient::is_proxy_enabled() const {
  20743. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20744. if (no_proxy_entries_.empty()) { return true; }
  20745. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20746. no_proxy_entries_);
  20747. }
  20748. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20749. std::string connect_host;
  20750. std::string ip;
  20751. auto port = port_;
  20752. if (is_proxy_enabled()) {
  20753. connect_host = proxy_host_;
  20754. port = proxy_port_;
  20755. } else {
  20756. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20757. }
  20758. sock_ = detail::create_client_socket(
  20759. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20760. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20761. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20762. write_timeout_usec_, interface_, error);
  20763. if (sock_ != INVALID_SOCKET) { return true; }
  20764. if (error == Error::Success) { error = Error::Connection; }
  20765. return false;
  20766. }
  20767. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20768. Response &proxy_res,
  20769. Error &error) {
  20770. auto timeout = handshake_timeout();
  20771. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20772. write_timeout_sec_, write_timeout_usec_);
  20773. if (!detail::write_request_head(strm, req, error)) { return false; }
  20774. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20775. error = Error::Read;
  20776. return false;
  20777. }
  20778. return true;
  20779. }
  20780. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20781. // forward an Upgrade request.
  20782. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20783. Error &error) {
  20784. Request req;
  20785. req.method = "CONNECT";
  20786. req.path =
  20787. detail::make_connect_request_target(tunnel_addr_map_, host_, port_);
  20788. req.headers.emplace("Host", req.path);
  20789. detail::add_default_user_agent_header(req);
  20790. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20791. proxy_basic_auth_password_,
  20792. proxy_bearer_token_auth_token_, true);
  20793. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20794. #ifdef CPPHTTPLIB_SSL_ENABLED
  20795. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20796. std::map<std::string, std::string> auth;
  20797. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20798. !proxy_digest_auth_username_.empty() &&
  20799. !proxy_digest_auth_password_.empty() &&
  20800. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20801. proxy_res = Response();
  20802. shutdown_and_close();
  20803. if (!create_and_connect_socket(error)) { return false; }
  20804. req.headers.erase("Proxy-Authorization");
  20805. req.headers.insert(detail::make_digest_authentication_header(
  20806. req, req.path, auth, 1, detail::random_string(10),
  20807. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20808. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20809. }
  20810. #endif
  20811. if (proxy_res.status != StatusCode::OK_200) {
  20812. error = Error::ProxyConnection;
  20813. return false;
  20814. }
  20815. return true;
  20816. }
  20817. inline void WebSocketClient::set_basic_auth(const std::string &username,
  20818. const std::string &password) {
  20819. basic_auth_username_ = username;
  20820. basic_auth_password_ = password;
  20821. }
  20822. inline void WebSocketClient::set_bearer_token_auth(const std::string &token) {
  20823. bearer_token_auth_token_ = token;
  20824. }
  20825. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20826. proxy_host_ = host;
  20827. proxy_port_ = port;
  20828. }
  20829. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20830. const std::string &password) {
  20831. proxy_basic_auth_username_ = username;
  20832. proxy_basic_auth_password_ = password;
  20833. }
  20834. inline void
  20835. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20836. proxy_bearer_token_auth_token_ = token;
  20837. }
  20838. inline void
  20839. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20840. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20841. }
  20842. #ifdef CPPHTTPLIB_SSL_ENABLED
  20843. inline void
  20844. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20845. const std::string &ca_cert_dir_path) {
  20846. ca_cert_file_path_ = ca_cert_file_path;
  20847. ca_cert_dir_path_ = ca_cert_dir_path;
  20848. }
  20849. inline void
  20850. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20851. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20852. }
  20853. inline void WebSocketClient::set_session_verifier(
  20854. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20855. session_verifier_ = std::move(verifier);
  20856. }
  20857. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20858. if (store && tls_ctx_) {
  20859. // set_ca_store takes ownership of store
  20860. tls::set_ca_store(tls_ctx_, store);
  20861. } else if (store) {
  20862. tls::free_ca_store(store);
  20863. }
  20864. custom_ca_loaded_ = true;
  20865. }
  20866. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20867. std::size_t size) {
  20868. if (tls_ctx_ && ca_cert && size > 0) {
  20869. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20870. }
  20871. custom_ca_loaded_ = true;
  20872. }
  20873. inline void
  20874. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20875. server_certificate_verification_ = enabled;
  20876. }
  20877. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20878. server_hostname_verification_ = enabled;
  20879. }
  20880. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20881. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20882. }
  20883. inline void
  20884. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20885. const std::string &password) {
  20886. proxy_digest_auth_username_ = username;
  20887. proxy_digest_auth_password_ = password;
  20888. }
  20889. #endif // CPPHTTPLIB_SSL_ENABLED
  20890. } // namespace ws
  20891. // ----------------------------------------------------------------------------
  20892. } // namespace httplib
  20893. #endif // CPPHTTPLIB_HTTPLIB_H