1
0

httplib.h 811 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645
  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.61.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003d00"
  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_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  104. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  105. #endif
  106. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  107. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  108. #endif
  109. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  110. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  111. #endif
  112. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  113. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  114. #endif
  115. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  116. // 1400 rather than a round number: a body that already fits in one 1500-byte
  117. // MTU gains nothing from being made smaller.
  118. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  119. #endif
  120. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  121. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  122. #endif
  123. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  124. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  125. #endif
  126. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  127. // recurses roughly once per matched character for quantified patterns such
  128. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  129. // a default ~8MB thread stack that has been observed to take on the order of
  130. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  131. // margin below that (well under the 8192-byte request URI limit) while still
  132. // fitting any realistic route segment; raise it if a route legitimately needs
  133. // longer paths. Regex routes are never applied to paths longer than this.
  134. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  135. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  136. #endif
  137. #ifndef CPPHTTPLIB_TCP_NODELAY
  138. #define CPPHTTPLIB_TCP_NODELAY false
  139. #endif
  140. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  141. #define CPPHTTPLIB_IPV6_V6ONLY false
  142. #endif
  143. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  144. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  145. #endif
  146. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  147. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  150. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  151. #endif
  152. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  153. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  154. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  155. ? std::thread::hardware_concurrency() - 1 \
  156. : 0))
  157. #endif
  158. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  159. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  160. #endif
  161. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  162. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  163. #endif
  164. #ifndef CPPHTTPLIB_RECV_FLAGS
  165. #define CPPHTTPLIB_RECV_FLAGS 0
  166. #endif
  167. #ifndef CPPHTTPLIB_SEND_FLAGS
  168. #define CPPHTTPLIB_SEND_FLAGS 0
  169. #endif
  170. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  171. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  172. #endif
  173. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  174. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  175. #endif
  176. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  177. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  178. #endif
  179. // One macro used to set the read timeout for both sides. They want different
  180. // defaults: a client's read timeout is the caller's own tool (it waits forever
  181. // until asked not to), while a server keeps a ceiling that reclaims a worker
  182. // from a peer that has gone quiet. The old name still works and sets both.
  183. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  184. #pragma message( \
  185. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  186. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  187. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  188. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  189. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  190. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  191. #endif
  192. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  194. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  195. #endif
  196. #endif
  197. // 0 waits forever. A read timeout is how a caller gets control back to send on
  198. // the same connection; it is not a liveness check (that is ping/pong). Only a
  199. // timeout set at runtime through set_read_timeout() is reported as
  200. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  201. // ws::Fail and closes the connection.
  202. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  203. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  204. #endif
  205. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  207. #endif
  208. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  209. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  210. #endif
  211. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  212. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  213. #endif
  214. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  215. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  216. #endif
  217. /*
  218. * Headers
  219. */
  220. #ifdef _WIN32
  221. #ifndef _CRT_SECURE_NO_WARNINGS
  222. #define _CRT_SECURE_NO_WARNINGS
  223. #endif //_CRT_SECURE_NO_WARNINGS
  224. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  225. #define _CRT_NONSTDC_NO_DEPRECATE
  226. #endif //_CRT_NONSTDC_NO_DEPRECATE
  227. #if defined(_MSC_VER)
  228. #if _MSC_VER < 1900
  229. #error Sorry, Visual Studio versions prior to 2015 are not supported
  230. #endif
  231. #pragma comment(lib, "ws2_32.lib")
  232. #ifndef _SSIZE_T_DEFINED
  233. using ssize_t = __int64;
  234. #define _SSIZE_T_DEFINED
  235. #endif
  236. #endif // _MSC_VER
  237. #ifndef S_ISREG
  238. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  239. #endif // S_ISREG
  240. #ifndef S_ISDIR
  241. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  242. #endif // S_ISDIR
  243. #ifndef NOMINMAX
  244. #define NOMINMAX
  245. #endif // NOMINMAX
  246. #include <io.h>
  247. #include <winsock2.h>
  248. #include <ws2tcpip.h>
  249. #if defined(__has_include)
  250. #if __has_include(<afunix.h>)
  251. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  252. #include <afunix.h>
  253. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  254. #endif
  255. #endif
  256. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  257. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  258. #endif
  259. using nfds_t = unsigned long;
  260. using socket_t = SOCKET;
  261. using socklen_t = int;
  262. #else // not _WIN32
  263. #include <arpa/inet.h>
  264. #if !defined(_AIX) && !defined(__MVS__)
  265. #include <ifaddrs.h>
  266. #endif
  267. #ifdef __MVS__
  268. #include <strings.h>
  269. #ifndef NI_MAXHOST
  270. #define NI_MAXHOST 1025
  271. #endif
  272. #endif
  273. #include <net/if.h>
  274. #include <netdb.h>
  275. #include <netinet/in.h>
  276. #ifdef __linux__
  277. #include <resolv.h>
  278. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  279. #endif
  280. #include <csignal>
  281. #include <netinet/tcp.h>
  282. #include <poll.h>
  283. #include <pthread.h>
  284. #include <sys/mman.h>
  285. #include <sys/socket.h>
  286. #include <sys/un.h>
  287. #include <unistd.h>
  288. using socket_t = int;
  289. #ifndef INVALID_SOCKET
  290. #define INVALID_SOCKET (-1)
  291. #endif
  292. #endif //_WIN32
  293. #if defined(__APPLE__)
  294. #include <TargetConditionals.h>
  295. #endif
  296. #include <algorithm>
  297. #include <array>
  298. #include <atomic>
  299. #include <cassert>
  300. #include <chrono>
  301. #include <climits>
  302. #include <condition_variable>
  303. #include <cstdlib>
  304. #include <cstring>
  305. #include <errno.h>
  306. #include <exception>
  307. #include <fcntl.h>
  308. #include <fstream>
  309. #include <functional>
  310. #include <iomanip>
  311. #include <iostream>
  312. #include <iterator>
  313. #include <list>
  314. #include <map>
  315. #include <memory>
  316. #include <mutex>
  317. #include <random>
  318. #include <regex>
  319. #include <set>
  320. #include <sstream>
  321. #include <string>
  322. #include <sys/stat.h>
  323. #include <system_error>
  324. #include <thread>
  325. #include <type_traits>
  326. #include <unordered_map>
  327. #include <unordered_set>
  328. #include <utility>
  329. #include <vector>
  330. // On macOS with a TLS backend, enable Keychain root certificates by default
  331. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  332. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  333. // only; on those platforms the user must provide a CA bundle explicitly.
  334. #if defined(__APPLE__) && defined(__clang__) && \
  335. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  336. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  337. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  338. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  339. #if TARGET_OS_OSX
  340. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  341. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  342. #endif
  343. #endif
  344. #endif
  345. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  346. defined(__APPLE__) && !TARGET_OS_OSX
  347. #error \
  348. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  349. #endif
  350. // On Windows, enable Schannel certificate verification by default
  351. // unless the user explicitly opts out.
  352. #if defined(_WIN32) && \
  353. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  354. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  355. #endif
  356. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  357. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  358. #if TARGET_OS_MAC && defined(__clang__)
  359. #include <CFNetwork/CFHost.h>
  360. #include <CoreFoundation/CoreFoundation.h>
  361. #endif
  362. #endif
  363. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  364. #ifdef _WIN32
  365. #include <wincrypt.h>
  366. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  367. // used
  368. #undef X509_NAME
  369. #undef X509_CERT_PAIR
  370. #undef X509_EXTENSIONS
  371. #undef PKCS7_SIGNER_INFO
  372. #ifdef _MSC_VER
  373. #pragma comment(lib, "crypt32.lib")
  374. #endif
  375. #endif // _WIN32
  376. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  377. #if TARGET_OS_OSX
  378. #include <Security/Security.h>
  379. #endif
  380. #endif
  381. #include <openssl/err.h>
  382. #include <openssl/evp.h>
  383. #include <openssl/rand.h>
  384. #include <openssl/ssl.h>
  385. #include <openssl/x509v3.h>
  386. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  387. #include <openssl/applink.c>
  388. #endif
  389. #include <iostream>
  390. #include <sstream>
  391. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  392. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  393. #error Please use OpenSSL or a current version of BoringSSL
  394. #endif
  395. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  396. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  397. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  398. #endif
  399. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  400. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  401. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  402. // in with this first include group so the version gating below can use it.
  403. #include <mbedtls/error.h>
  404. #include <mbedtls/net_sockets.h>
  405. #include <mbedtls/oid.h>
  406. #include <mbedtls/pk.h>
  407. #include <mbedtls/ssl.h>
  408. #include <mbedtls/version.h>
  409. #include <mbedtls/x509_crt.h>
  410. #if MBEDTLS_VERSION_MAJOR >= 4
  411. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  412. #include <psa/crypto.h>
  413. #else
  414. #include <mbedtls/ctr_drbg.h>
  415. #include <mbedtls/entropy.h>
  416. #include <mbedtls/md5.h>
  417. #include <mbedtls/sha1.h>
  418. #include <mbedtls/sha256.h>
  419. #include <mbedtls/sha512.h>
  420. #endif
  421. #ifdef _WIN32
  422. #include <wincrypt.h>
  423. #ifdef _MSC_VER
  424. #pragma comment(lib, "crypt32.lib")
  425. #endif
  426. #endif // _WIN32
  427. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  428. #if TARGET_OS_OSX
  429. #include <Security/Security.h>
  430. #endif
  431. #endif
  432. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  433. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  434. #if MBEDTLS_VERSION_MAJOR >= 4
  435. #define CPPHTTPLIB_MBEDTLS_V4
  436. #endif
  437. #if MBEDTLS_VERSION_MAJOR >= 3
  438. #define CPPHTTPLIB_MBEDTLS_V3
  439. #endif
  440. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  441. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  442. #include <wolfssl/options.h>
  443. #include <wolfssl/openssl/x509v3.h>
  444. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  445. #ifndef WOLFSSL_GEN_EMAIL
  446. #define WOLFSSL_GEN_EMAIL 1
  447. #endif
  448. #ifndef WOLFSSL_GEN_DNS
  449. #define WOLFSSL_GEN_DNS 2
  450. #endif
  451. #ifndef WOLFSSL_GEN_URI
  452. #define WOLFSSL_GEN_URI 6
  453. #endif
  454. #ifndef WOLFSSL_GEN_IPADD
  455. #define WOLFSSL_GEN_IPADD 7
  456. #endif
  457. #include <wolfssl/ssl.h>
  458. #include <wolfssl/wolfcrypt/hash.h>
  459. #include <wolfssl/wolfcrypt/md5.h>
  460. #include <wolfssl/wolfcrypt/sha256.h>
  461. #include <wolfssl/wolfcrypt/sha512.h>
  462. #ifdef _WIN32
  463. #include <wincrypt.h>
  464. #ifdef _MSC_VER
  465. #pragma comment(lib, "crypt32.lib")
  466. #endif
  467. #endif // _WIN32
  468. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  469. #if TARGET_OS_OSX
  470. #include <Security/Security.h>
  471. #endif
  472. #endif
  473. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  474. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  475. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  476. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  477. #define CPPHTTPLIB_SSL_ENABLED
  478. #endif
  479. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  480. #include <zlib.h>
  481. #endif
  482. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  483. #include <brotli/decode.h>
  484. #include <brotli/encode.h>
  485. #endif
  486. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  487. #include <zstd.h>
  488. #endif
  489. /*
  490. * Declaration
  491. */
  492. namespace httplib {
  493. namespace ws {
  494. class WebSocket;
  495. } // namespace ws
  496. namespace detail {
  497. /*
  498. * Backport std::make_unique from C++14.
  499. *
  500. * NOTE: This code came up with the following stackoverflow post:
  501. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  502. *
  503. */
  504. template <class T, class... Args>
  505. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  506. make_unique(Args &&...args) {
  507. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  508. }
  509. template <class T>
  510. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  511. make_unique(std::size_t n) {
  512. typedef typename std::remove_extent<T>::type RT;
  513. return std::unique_ptr<T>(new RT[n]);
  514. }
  515. // Locale-independent ASCII character classification. The <cctype>
  516. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  517. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  518. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  519. // classified without regard to the locale.
  520. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  521. inline bool is_ascii_alpha(char c) {
  522. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  523. }
  524. inline bool is_ascii_alnum(char c) {
  525. return is_ascii_digit(c) || is_ascii_alpha(c);
  526. }
  527. namespace case_ignore {
  528. inline unsigned char to_lower(int c) {
  529. const static unsigned char table[256] = {
  530. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  531. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  532. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  533. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  534. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  535. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  536. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  537. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  538. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  539. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  540. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  541. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  542. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  543. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  544. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  545. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  546. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  547. 255,
  548. };
  549. return table[(unsigned char)(char)c];
  550. }
  551. inline std::string to_lower(const std::string &s) {
  552. std::string result = s;
  553. std::transform(
  554. result.begin(), result.end(), result.begin(),
  555. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  556. return result;
  557. }
  558. inline bool equal(const std::string &a, const std::string &b) {
  559. return a.size() == b.size() &&
  560. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  561. return to_lower(ca) == to_lower(cb);
  562. });
  563. }
  564. // For a literal, without building a std::string from it.
  565. template <size_t N>
  566. inline bool equal(const std::string &a, const char (&b)[N]) {
  567. return a.size() == N - 1 &&
  568. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  569. return to_lower(ca) == to_lower(cb);
  570. });
  571. }
  572. struct equal_to {
  573. bool operator()(const std::string &a, const std::string &b) const {
  574. return equal(a, b);
  575. }
  576. };
  577. struct hash {
  578. size_t operator()(const std::string &key) const {
  579. size_t h = 0;
  580. for (auto c : key) {
  581. // Unsets the 6 high bits of h, therefore no overflow happens
  582. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  583. static_cast<unsigned char>(to_lower(c));
  584. }
  585. return h;
  586. }
  587. };
  588. template <typename T>
  589. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  590. detail::case_ignore::equal_to>;
  591. } // namespace case_ignore
  592. // This is based on
  593. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  594. struct scope_exit {
  595. explicit scope_exit(std::function<void(void)> &&f)
  596. : exit_function(std::move(f)), execute_on_destruction{true} {}
  597. scope_exit(scope_exit &&rhs) noexcept
  598. : exit_function(std::move(rhs.exit_function)),
  599. execute_on_destruction{rhs.execute_on_destruction} {
  600. rhs.release();
  601. }
  602. ~scope_exit() {
  603. if (execute_on_destruction) { this->exit_function(); }
  604. }
  605. void release() { this->execute_on_destruction = false; }
  606. private:
  607. scope_exit(const scope_exit &) = delete;
  608. void operator=(const scope_exit &) = delete;
  609. scope_exit &operator=(scope_exit &&) = delete;
  610. std::function<void(void)> exit_function;
  611. bool execute_on_destruction;
  612. };
  613. // Simple from_chars implementation for integer and double types (C++17
  614. // substitute)
  615. template <typename T> struct from_chars_result {
  616. const char *ptr;
  617. std::errc ec;
  618. };
  619. template <typename T>
  620. inline from_chars_result<T> from_chars(const char *first, const char *last,
  621. T &value, int base = 10) {
  622. value = 0;
  623. const char *p = first;
  624. bool negative = false;
  625. if (p != last && *p == '-') {
  626. negative = true;
  627. ++p;
  628. }
  629. if (p == last) { return {first, std::errc::invalid_argument}; }
  630. T result = 0;
  631. for (; p != last; ++p) {
  632. char c = *p;
  633. int digit = -1;
  634. if (is_ascii_digit(c)) {
  635. digit = c - '0';
  636. } else if ('a' <= c && c <= 'z') {
  637. digit = c - 'a' + 10;
  638. } else if ('A' <= c && c <= 'Z') {
  639. digit = c - 'A' + 10;
  640. } else {
  641. break;
  642. }
  643. if (digit < 0 || digit >= base) { break; }
  644. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  645. return {p, std::errc::result_out_of_range};
  646. }
  647. result = result * base + digit;
  648. }
  649. if (p == first || (negative && p == first + 1)) {
  650. return {first, std::errc::invalid_argument};
  651. }
  652. value = negative ? T(0) - result : result;
  653. return {p, std::errc{}};
  654. }
  655. // from_chars for double (hand-written, locale-independent)
  656. //
  657. // The only double consumed by this library is the HTTP quality value, whose
  658. // grammar is (RFC 9110 12.4.2):
  659. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  660. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  661. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  662. // '.' always the decimal separator (std::strtod would instead read it from the
  663. // global C locale, mis-parsing q-values once an embedder calls
  664. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  665. // the result to [0, 1], so inputs outside that range need not be distinguished
  666. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  667. // cases that exponent and wide-range handling would introduce.
  668. inline from_chars_result<double> from_chars(const char *first, const char *last,
  669. double &value) {
  670. value = 0.0;
  671. const char *p = first;
  672. // Each 1eN is exactly representable, so a single final division by the
  673. // matching entry yields a correctly-rounded result.
  674. static const double powers_of_ten[] = {
  675. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  676. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  677. const int max_frac_digits =
  678. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  679. // Accumulate digits into a 64-bit integer and remember how many were
  680. // fractional. Two independent caps keep this bounded and safe:
  681. // * accumulation saturates before mantissa could overflow uint64_t, and
  682. // * frac_digits is capped at max_frac_digits so it is always a valid index
  683. // into powers_of_ten (without this an input like "0.000...0" would never
  684. // grow mantissa, so the saturation cap alone would not bound it).
  685. // Both caps only drop digits far beyond the precision a q-value needs; any
  686. // value they would change is well outside [0, 1] and rejected by the caller.
  687. uint64_t mantissa = 0;
  688. int frac_digits = 0;
  689. bool seen_digit = false;
  690. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  691. auto accumulate = [&](char c) {
  692. if (mantissa <= limit) {
  693. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  694. return true;
  695. }
  696. return false;
  697. };
  698. for (; p != last && is_ascii_digit(*p); ++p) {
  699. seen_digit = true;
  700. accumulate(*p);
  701. }
  702. if (p != last && *p == '.') {
  703. ++p;
  704. for (; p != last && is_ascii_digit(*p); ++p) {
  705. seen_digit = true;
  706. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  707. }
  708. }
  709. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  710. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  711. return {p, std::errc{}};
  712. }
  713. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  714. int &out) {
  715. int val = 0;
  716. auto r = from_chars(s, s + len, val);
  717. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  718. return false;
  719. }
  720. out = val;
  721. return true;
  722. }
  723. inline bool parse_port(const char *s, size_t len, int &port) {
  724. return parse_int_in_range(s, len, 1, 65535, port);
  725. }
  726. inline bool parse_port(const std::string &s, int &port) {
  727. return parse_port(s.data(), s.size(), port);
  728. }
  729. struct UrlComponents {
  730. std::string scheme;
  731. std::string host;
  732. std::string port;
  733. std::string path;
  734. std::string query;
  735. };
  736. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  737. uc = {};
  738. size_t pos = 0;
  739. auto sep = url.find("://");
  740. if (sep != std::string::npos) {
  741. uc.scheme = url.substr(0, sep);
  742. // Scheme must be [a-z]+ only
  743. if (uc.scheme.empty()) { return false; }
  744. for (auto c : uc.scheme) {
  745. if (c < 'a' || c > 'z') { return false; }
  746. }
  747. pos = sep + 3;
  748. } else if (url.compare(0, 2, "//") == 0) {
  749. pos = 2;
  750. }
  751. auto has_authority_prefix = pos > 0;
  752. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  753. url[0] != '?' && url[0] != '#');
  754. if (has_authority) {
  755. // userinfo is not supported, and a backslash that some parsers take for
  756. // '/' would leave them seeing another host than this one.
  757. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  758. return false;
  759. }
  760. if (pos < url.size() && url[pos] == '[') {
  761. auto close = url.find(']', pos);
  762. if (close == std::string::npos) { return false; }
  763. uc.host = url.substr(pos + 1, close - pos - 1);
  764. // IPv6 host must be [a-fA-F0-9:]+ only
  765. if (uc.host.empty()) { return false; }
  766. for (auto c : uc.host) {
  767. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  768. (c >= 'A' && c <= 'F') || c == ':')) {
  769. return false;
  770. }
  771. }
  772. pos = close + 1;
  773. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  774. // path, query or fragment delimiter (or the end of input). Otherwise the
  775. // trailing bytes would be folded into the path while the connection
  776. // still targets the bracketed address.
  777. if (pos < url.size()) {
  778. auto c = url[pos];
  779. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  780. }
  781. } else {
  782. auto end = url.find_first_of(":/?#", pos);
  783. if (end == std::string::npos) { end = url.size(); }
  784. uc.host = url.substr(pos, end - pos);
  785. pos = end;
  786. }
  787. if (pos < url.size() && url[pos] == ':') {
  788. ++pos;
  789. auto end = url.find_first_of("/?#", pos);
  790. if (end == std::string::npos) { end = url.size(); }
  791. uc.port = url.substr(pos, end - pos);
  792. pos = end;
  793. }
  794. // Without :// or //, the entire input must be consumed as host[:port].
  795. // If there is leftover (path, query, etc.), this is not a valid
  796. // host[:port] string — clear and reparse as a plain path.
  797. if (!has_authority_prefix && pos < url.size()) {
  798. uc.host.clear();
  799. uc.port.clear();
  800. pos = 0;
  801. }
  802. }
  803. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  804. auto end = url.find_first_of("?#", pos);
  805. if (end == std::string::npos) { end = url.size(); }
  806. uc.path = url.substr(pos, end - pos);
  807. pos = end;
  808. }
  809. if (pos < url.size() && url[pos] == '?') {
  810. auto end = url.find('#', pos);
  811. if (end == std::string::npos) { end = url.size(); }
  812. uc.query = url.substr(pos, end - pos);
  813. }
  814. return true;
  815. }
  816. // Resolves a relative-path or query-only Location value against the path of
  817. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  818. // references starting with '/' are returned unchanged.
  819. inline std::string resolve_relative_location(const std::string &location,
  820. const std::string &base) {
  821. if (location.empty() || location[0] == '/') { return location; }
  822. // A ':' in the first segment means the value has a scheme.
  823. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  824. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  825. auto base_path = base.substr(0, base.find_first_of("?#"));
  826. if (location[0] == '?') { return base_path + location; }
  827. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  828. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  829. // Remove "." and ".." segments from the merged path.
  830. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  831. std::string path;
  832. size_t i = 0;
  833. while (i < path_end) {
  834. auto next = (std::min)(merged.find('/', i + 1), path_end);
  835. auto segment = merged.substr(i + 1, next - i - 1);
  836. auto is_last = next == path_end;
  837. if (segment == "." || segment == "..") {
  838. if (segment == "..") {
  839. path.erase((std::min)(path.rfind('/'), path.size()));
  840. }
  841. if (is_last) { path += '/'; }
  842. } else {
  843. path += '/';
  844. path += segment;
  845. }
  846. i = next;
  847. }
  848. if (path.empty()) { path = "/"; }
  849. return path + merged.substr(path_end);
  850. }
  851. } // namespace detail
  852. enum class SSLVerifierResponse {
  853. // no decision has been made, use the built-in certificate verifier
  854. NoDecisionMade,
  855. // connection certificate is verified and accepted
  856. CertificateAccepted,
  857. // connection certificate was processed but is rejected
  858. CertificateRejected
  859. };
  860. // System CA loading policy for SSL clients. Auto (the default) loads system
  861. // CA certs only when no custom CA is configured; enable_system_ca() switches
  862. // to an explicit policy.
  863. enum class SystemCAMode { Auto, Enabled, Disabled };
  864. enum StatusCode {
  865. // Information responses
  866. Continue_100 = 100,
  867. SwitchingProtocol_101 = 101,
  868. Processing_102 = 102,
  869. EarlyHints_103 = 103,
  870. // Successful responses
  871. OK_200 = 200,
  872. Created_201 = 201,
  873. Accepted_202 = 202,
  874. NonAuthoritativeInformation_203 = 203,
  875. NoContent_204 = 204,
  876. ResetContent_205 = 205,
  877. PartialContent_206 = 206,
  878. MultiStatus_207 = 207,
  879. AlreadyReported_208 = 208,
  880. IMUsed_226 = 226,
  881. // Redirection messages
  882. MultipleChoices_300 = 300,
  883. MovedPermanently_301 = 301,
  884. Found_302 = 302,
  885. SeeOther_303 = 303,
  886. NotModified_304 = 304,
  887. UseProxy_305 = 305,
  888. unused_306 = 306,
  889. TemporaryRedirect_307 = 307,
  890. PermanentRedirect_308 = 308,
  891. // Client error responses
  892. BadRequest_400 = 400,
  893. Unauthorized_401 = 401,
  894. PaymentRequired_402 = 402,
  895. Forbidden_403 = 403,
  896. NotFound_404 = 404,
  897. MethodNotAllowed_405 = 405,
  898. NotAcceptable_406 = 406,
  899. ProxyAuthenticationRequired_407 = 407,
  900. RequestTimeout_408 = 408,
  901. Conflict_409 = 409,
  902. Gone_410 = 410,
  903. LengthRequired_411 = 411,
  904. PreconditionFailed_412 = 412,
  905. PayloadTooLarge_413 = 413,
  906. UriTooLong_414 = 414,
  907. UnsupportedMediaType_415 = 415,
  908. RangeNotSatisfiable_416 = 416,
  909. ExpectationFailed_417 = 417,
  910. ImATeapot_418 = 418,
  911. MisdirectedRequest_421 = 421,
  912. UnprocessableContent_422 = 422,
  913. Locked_423 = 423,
  914. FailedDependency_424 = 424,
  915. TooEarly_425 = 425,
  916. UpgradeRequired_426 = 426,
  917. PreconditionRequired_428 = 428,
  918. TooManyRequests_429 = 429,
  919. RequestHeaderFieldsTooLarge_431 = 431,
  920. UnavailableForLegalReasons_451 = 451,
  921. // Server error responses
  922. InternalServerError_500 = 500,
  923. NotImplemented_501 = 501,
  924. BadGateway_502 = 502,
  925. ServiceUnavailable_503 = 503,
  926. GatewayTimeout_504 = 504,
  927. HttpVersionNotSupported_505 = 505,
  928. VariantAlsoNegotiates_506 = 506,
  929. InsufficientStorage_507 = 507,
  930. LoopDetected_508 = 508,
  931. NotExtended_510 = 510,
  932. NetworkAuthenticationRequired_511 = 511,
  933. };
  934. namespace detail {
  935. // A multimap that keeps its entries in the order they were inserted.
  936. //
  937. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  938. // fields sharing a field name significant and forbids a proxy from reordering
  939. // them, and a query string's parameters are meaningful in the order the caller
  940. // wrote them. Neither standard container expresses it: std::unordered_multimap
  941. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  942. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  943. // key, which would drop control data such as Host behind whatever else the
  944. // message carries and alphabetise a query string.
  945. //
  946. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  947. // scan, which beats hashing for the handful of entries a message carries
  948. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  949. //
  950. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  951. // Params, whose parameter names are case-sensitive, not.
  952. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  953. public:
  954. using key_type = std::string;
  955. using mapped_type = Mapped;
  956. using value_type = std::pair<std::string, Mapped>;
  957. using size_type = std::size_t;
  958. using difference_type = std::ptrdiff_t;
  959. using reference = value_type &;
  960. using const_reference = const value_type &;
  961. private:
  962. static size_type npos() { return static_cast<size_type>(-1); }
  963. static bool keys_equal(const std::string &a, const std::string &b) {
  964. return KeyEqual()(a, b);
  965. }
  966. // Iterating yields every entry in insertion order, but equal_range() and
  967. // find() have to walk only the entries sharing one key, which are not
  968. // adjacent. Both are the same iterator type: key_idx_ selects between the
  969. // two traversals, and since equality compares only the position, an iterator
  970. // restricted to one key still compares equal to end().
  971. template <typename V> class iterator_t {
  972. public:
  973. using iterator_category = std::bidirectional_iterator_tag;
  974. using value_type = insertion_ordered_multimap::value_type;
  975. using difference_type = insertion_ordered_multimap::difference_type;
  976. using pointer = V *;
  977. using reference = V &;
  978. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  979. template <typename U,
  980. typename std::enable_if<std::is_convertible<U *, V *>::value,
  981. int>::type = 0>
  982. iterator_t(const iterator_t<U> &rhs)
  983. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  984. key_idx_(rhs.key_idx_) {}
  985. reference operator*() const { return data_[idx_]; }
  986. pointer operator->() const { return data_ + idx_; }
  987. iterator_t &operator++() {
  988. // Saturating, so that advancing past the last entry of a key stays at
  989. // end() instead of running off the container.
  990. if (idx_ >= size_) { return *this; }
  991. ++idx_;
  992. if (key_idx_ != npos()) {
  993. while (idx_ < size_ && !matches(idx_)) {
  994. ++idx_;
  995. }
  996. }
  997. return *this;
  998. }
  999. iterator_t operator++(int) {
  1000. auto tmp = *this;
  1001. ++*this;
  1002. return tmp;
  1003. }
  1004. iterator_t &operator--() {
  1005. if (idx_ == 0) { return *this; }
  1006. --idx_;
  1007. if (key_idx_ != npos()) {
  1008. while (idx_ > 0 && !matches(idx_)) {
  1009. --idx_;
  1010. }
  1011. }
  1012. return *this;
  1013. }
  1014. iterator_t operator--(int) {
  1015. auto tmp = *this;
  1016. --*this;
  1017. return tmp;
  1018. }
  1019. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1020. return idx_ == rhs.idx_;
  1021. }
  1022. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1023. return idx_ != rhs.idx_;
  1024. }
  1025. private:
  1026. friend class insertion_ordered_multimap;
  1027. template <typename> friend class iterator_t;
  1028. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1029. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1030. bool matches(size_type i) const {
  1031. return keys_equal(data_[i].first, data_[key_idx_].first);
  1032. }
  1033. V *data_;
  1034. size_type idx_;
  1035. size_type size_;
  1036. size_type key_idx_;
  1037. };
  1038. public:
  1039. using iterator = iterator_t<value_type>;
  1040. using const_iterator = iterator_t<const value_type>;
  1041. insertion_ordered_multimap() = default;
  1042. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1043. : entries_(il) {}
  1044. template <typename InputIt>
  1045. insertion_ordered_multimap(InputIt first, InputIt last)
  1046. : entries_(first, last) {}
  1047. iterator begin() { return make_iter(0, npos()); }
  1048. iterator end() { return make_iter(entries_.size(), npos()); }
  1049. const_iterator begin() const { return make_citer(0, npos()); }
  1050. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1051. const_iterator cbegin() const { return begin(); }
  1052. const_iterator cend() const { return end(); }
  1053. bool empty() const { return entries_.empty(); }
  1054. size_type size() const { return entries_.size(); }
  1055. void clear() { entries_.clear(); }
  1056. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1057. iterator insert(const value_type &val) {
  1058. entries_.push_back(val);
  1059. return make_iter(entries_.size() - 1, npos());
  1060. }
  1061. iterator insert(value_type &&val) {
  1062. entries_.push_back(std::move(val));
  1063. return make_iter(entries_.size() - 1, npos());
  1064. }
  1065. template <typename... Args> iterator emplace(Args &&...args) {
  1066. entries_.emplace_back(std::forward<Args>(args)...);
  1067. return make_iter(entries_.size() - 1, npos());
  1068. }
  1069. // For entries that have to lead the message, such as the Host header field
  1070. // (RFC 9110 5.3 recommends sending control data first).
  1071. template <typename... Args> iterator emplace_front(Args &&...args) {
  1072. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1073. return make_iter(0, npos());
  1074. }
  1075. iterator find(const std::string &key) {
  1076. auto i = index_of(key);
  1077. return i == npos() ? end() : make_iter(i, i);
  1078. }
  1079. const_iterator find(const std::string &key) const {
  1080. auto i = index_of(key);
  1081. return i == npos() ? end() : make_citer(i, i);
  1082. }
  1083. size_type count(const std::string &key) const {
  1084. size_type n = 0;
  1085. for (const auto &entry : entries_) {
  1086. if (keys_equal(entry.first, key)) { n++; }
  1087. }
  1088. return n;
  1089. }
  1090. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1091. auto i = index_of(key);
  1092. return i == npos() ? std::make_pair(end(), end())
  1093. : std::make_pair(make_iter(i, i), end());
  1094. }
  1095. std::pair<const_iterator, const_iterator>
  1096. equal_range(const std::string &key) const {
  1097. auto i = index_of(key);
  1098. return i == npos() ? std::make_pair(end(), end())
  1099. : std::make_pair(make_citer(i, i), end());
  1100. }
  1101. size_type erase(const std::string &key) {
  1102. auto before = entries_.size();
  1103. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1104. [&](const value_type &entry) {
  1105. return keys_equal(entry.first, key);
  1106. }),
  1107. entries_.end());
  1108. return before - entries_.size();
  1109. }
  1110. iterator erase(const_iterator pos) {
  1111. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1112. return make_iter(pos.idx_, npos());
  1113. }
  1114. // Erases what iterating [first, last) would actually visit, so erasing an
  1115. // equal_range() removes only the entries with that key, not everything
  1116. // positioned between them.
  1117. iterator erase(const_iterator first, const_iterator last) {
  1118. auto from = first.idx_;
  1119. auto to = last.idx_;
  1120. if (from >= to) { return make_iter(from, npos()); }
  1121. auto begin_it = entries_.begin();
  1122. auto from_it = begin_it + static_cast<difference_type>(from);
  1123. auto to_it = begin_it + static_cast<difference_type>(to);
  1124. if (first.key_idx_ == npos()) {
  1125. entries_.erase(from_it, to_it);
  1126. } else {
  1127. auto key = entries_[first.key_idx_].first;
  1128. auto keep = from_it;
  1129. for (auto it = from_it; it != to_it; ++it) {
  1130. if (!keys_equal(it->first, key)) {
  1131. if (keep != it) { *keep = std::move(*it); }
  1132. ++keep;
  1133. }
  1134. }
  1135. if (keep != to_it) {
  1136. keep = std::move(to_it, entries_.end(), keep);
  1137. } else {
  1138. keep = entries_.end();
  1139. }
  1140. entries_.erase(keep, entries_.end());
  1141. }
  1142. return make_iter(from, npos());
  1143. }
  1144. friend bool operator==(const insertion_ordered_multimap &lhs,
  1145. const insertion_ordered_multimap &rhs) {
  1146. return lhs.entries_ == rhs.entries_;
  1147. }
  1148. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1149. const insertion_ordered_multimap &rhs) {
  1150. return !(lhs == rhs);
  1151. }
  1152. private:
  1153. size_type index_of(const std::string &key) const {
  1154. for (size_type i = 0; i < entries_.size(); i++) {
  1155. if (keys_equal(entries_[i].first, key)) { return i; }
  1156. }
  1157. return npos();
  1158. }
  1159. iterator make_iter(size_type idx, size_type key_idx) {
  1160. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1161. }
  1162. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1163. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1164. }
  1165. std::vector<value_type> entries_;
  1166. };
  1167. } // namespace detail
  1168. using Headers =
  1169. detail::insertion_ordered_multimap<std::string,
  1170. detail::case_ignore::equal_to>;
  1171. // Query parameter names are case-sensitive, unlike header field names.
  1172. using Params =
  1173. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1174. using Match = std::smatch;
  1175. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1176. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1177. /*
  1178. * detail: type-erased storage used by UserData.
  1179. * ABI-stable regardless of C++ standard — always uses this custom
  1180. * implementation instead of std::any.
  1181. */
  1182. namespace detail {
  1183. using any_type_id = const void *;
  1184. template <typename T> any_type_id any_typeid() noexcept {
  1185. static const char id = 0;
  1186. return &id;
  1187. }
  1188. struct any_storage {
  1189. virtual ~any_storage() = default;
  1190. virtual std::unique_ptr<any_storage> clone() const = 0;
  1191. virtual any_type_id type_id() const noexcept = 0;
  1192. };
  1193. template <typename T> struct any_value final : any_storage {
  1194. T value;
  1195. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1196. std::unique_ptr<any_storage> clone() const override {
  1197. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1198. }
  1199. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1200. };
  1201. } // namespace detail
  1202. class UserData {
  1203. public:
  1204. UserData() = default;
  1205. UserData(UserData &&) noexcept = default;
  1206. UserData &operator=(UserData &&) noexcept = default;
  1207. UserData(const UserData &o) {
  1208. for (const auto &e : o.entries_) {
  1209. if (e.second) { entries_[e.first] = e.second->clone(); }
  1210. }
  1211. }
  1212. UserData &operator=(const UserData &o) {
  1213. if (this != &o) {
  1214. entries_.clear();
  1215. for (const auto &e : o.entries_) {
  1216. if (e.second) { entries_[e.first] = e.second->clone(); }
  1217. }
  1218. }
  1219. return *this;
  1220. }
  1221. template <typename T> void set(const std::string &key, T &&value) {
  1222. using D = typename std::decay<T>::type;
  1223. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1224. }
  1225. template <typename T> T *get(const std::string &key) noexcept {
  1226. auto it = entries_.find(key);
  1227. if (it == entries_.end() || !it->second) { return nullptr; }
  1228. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1229. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1230. }
  1231. template <typename T> const T *get(const std::string &key) const noexcept {
  1232. auto it = entries_.find(key);
  1233. if (it == entries_.end() || !it->second) { return nullptr; }
  1234. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1235. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1236. }
  1237. bool has(const std::string &key) const noexcept {
  1238. return entries_.find(key) != entries_.end();
  1239. }
  1240. void erase(const std::string &key) { entries_.erase(key); }
  1241. void clear() noexcept { entries_.clear(); }
  1242. private:
  1243. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1244. entries_;
  1245. };
  1246. struct Response;
  1247. using ResponseHandler = std::function<bool(const Response &response)>;
  1248. struct FormData {
  1249. std::string name;
  1250. std::string content;
  1251. std::string filename;
  1252. std::string content_type;
  1253. Headers headers;
  1254. };
  1255. struct FormField {
  1256. std::string name;
  1257. std::string content;
  1258. Headers headers;
  1259. };
  1260. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1261. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1262. // should see the parts as they were sent. A std::multimap sorts by field name
  1263. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1264. // than the case-insensitive predicate Headers uses.
  1265. using FormFields =
  1266. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1267. using FormFiles =
  1268. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1269. struct MultipartFormData {
  1270. FormFields fields; // Text fields from multipart
  1271. FormFiles files; // Files from multipart
  1272. // Text field access
  1273. std::string get_field(const std::string &key, size_t id = 0) const;
  1274. std::vector<std::string> get_fields(const std::string &key) const;
  1275. bool has_field(const std::string &key) const;
  1276. size_t get_field_count(const std::string &key) const;
  1277. // File access
  1278. FormData get_file(const std::string &key, size_t id = 0) const;
  1279. std::vector<FormData> get_files(const std::string &key) const;
  1280. bool has_file(const std::string &key) const;
  1281. size_t get_file_count(const std::string &key) const;
  1282. };
  1283. struct UploadFormData {
  1284. std::string name;
  1285. std::string content;
  1286. std::string filename;
  1287. std::string content_type;
  1288. };
  1289. using UploadFormDataItems = std::vector<UploadFormData>;
  1290. class DataSink {
  1291. public:
  1292. DataSink() : os(&sb_), sb_(*this) {}
  1293. DataSink(const DataSink &) = delete;
  1294. DataSink &operator=(const DataSink &) = delete;
  1295. DataSink(DataSink &&) = delete;
  1296. DataSink &operator=(DataSink &&) = delete;
  1297. std::function<bool(const char *data, size_t data_len)> write;
  1298. // Only `write` is mandatory. The rest are defaulted so that a provider
  1299. // calling one on a writer that does not set it gets sensible behaviour
  1300. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1301. // `this` is safe: DataSink is neither copyable nor movable.
  1302. std::function<bool()> is_writable = []() { return true; };
  1303. std::function<void()> done = []() {};
  1304. std::function<void(const Headers &trailer)> done_with_trailer =
  1305. [this](const Headers & /*trailer*/) { done(); };
  1306. std::ostream os;
  1307. private:
  1308. class data_sink_streambuf final : public std::streambuf {
  1309. public:
  1310. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1311. protected:
  1312. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1313. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1314. return 0;
  1315. }
  1316. private:
  1317. DataSink &sink_;
  1318. };
  1319. data_sink_streambuf sb_;
  1320. };
  1321. using ContentProvider =
  1322. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1323. using ContentProviderWithoutLength =
  1324. std::function<bool(size_t offset, DataSink &sink)>;
  1325. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1326. struct FormDataProvider {
  1327. std::string name;
  1328. ContentProviderWithoutLength provider;
  1329. std::string filename;
  1330. std::string content_type;
  1331. };
  1332. using FormDataProviderItems = std::vector<FormDataProvider>;
  1333. inline FormDataProvider
  1334. make_file_provider(const std::string &name, const std::string &filepath,
  1335. const std::string &filename = std::string(),
  1336. const std::string &content_type = std::string()) {
  1337. FormDataProvider fdp;
  1338. fdp.name = name;
  1339. fdp.filename = filename.empty() ? filepath : filename;
  1340. fdp.content_type = content_type;
  1341. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1342. std::ifstream f(filepath, std::ios::binary);
  1343. if (!f) { return false; }
  1344. if (offset > 0) {
  1345. f.seekg(static_cast<std::streamoff>(offset));
  1346. if (!f.good()) {
  1347. sink.done();
  1348. return true;
  1349. }
  1350. }
  1351. char buf[8192];
  1352. f.read(buf, sizeof(buf));
  1353. auto n = static_cast<size_t>(f.gcount());
  1354. if (n > 0) { return sink.write(buf, n); }
  1355. sink.done(); // EOF
  1356. return true;
  1357. };
  1358. return fdp;
  1359. }
  1360. inline std::pair<size_t, ContentProvider>
  1361. make_file_body(const std::string &filepath) {
  1362. size_t size = 0;
  1363. {
  1364. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1365. if (!f) { return {0, ContentProvider{}}; }
  1366. size = static_cast<size_t>(f.tellg());
  1367. }
  1368. ContentProvider provider = [filepath](size_t offset, size_t length,
  1369. DataSink &sink) -> bool {
  1370. std::ifstream f(filepath, std::ios::binary);
  1371. if (!f) { return false; }
  1372. f.seekg(static_cast<std::streamoff>(offset));
  1373. if (!f.good()) { return false; }
  1374. char buf[8192];
  1375. while (length > 0) {
  1376. auto to_read = (std::min)(sizeof(buf), length);
  1377. f.read(buf, static_cast<std::streamsize>(to_read));
  1378. auto n = static_cast<size_t>(f.gcount());
  1379. // The file is shorter than the size make_file_body() measured, which the
  1380. // caller has already committed to as Content-Length. The body cannot be
  1381. // completed, so fail as every other error here does.
  1382. if (n == 0) { return false; }
  1383. if (!sink.write(buf, n)) { return false; }
  1384. length -= n;
  1385. }
  1386. return true;
  1387. };
  1388. return {size, std::move(provider)};
  1389. }
  1390. using ContentReceiverWithProgress = std::function<bool(
  1391. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1392. using ContentReceiver =
  1393. std::function<bool(const char *data, size_t data_length)>;
  1394. using FormDataHeader = std::function<bool(const FormData &file)>;
  1395. class ContentReader {
  1396. public:
  1397. using Reader = std::function<bool(ContentReceiver receiver)>;
  1398. using FormDataReader =
  1399. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1400. ContentReader(Reader reader, FormDataReader multipart_reader)
  1401. : reader_(std::move(reader)),
  1402. formdata_reader_(std::move(multipart_reader)) {}
  1403. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1404. return formdata_reader_(std::move(header), std::move(receiver));
  1405. }
  1406. bool operator()(ContentReceiver receiver) const {
  1407. return reader_(std::move(receiver));
  1408. }
  1409. Reader reader_;
  1410. FormDataReader formdata_reader_;
  1411. };
  1412. using Range = std::pair<ssize_t, ssize_t>;
  1413. using Ranges = std::vector<Range>;
  1414. #ifdef CPPHTTPLIB_SSL_ENABLED
  1415. // TLS abstraction layer - public type definitions and API
  1416. namespace tls {
  1417. // Opaque handles (defined as void* for abstraction)
  1418. using ctx_t = void *;
  1419. using session_t = void *;
  1420. using const_session_t = const void *; // For read-only session access
  1421. using cert_t = void *;
  1422. using ca_store_t = void *;
  1423. // TLS versions
  1424. enum class Version {
  1425. TLS1_2 = 0x0303,
  1426. TLS1_3 = 0x0304,
  1427. };
  1428. // Subject Alternative Names (SAN) entry types
  1429. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1430. // SAN entry structure
  1431. struct SanEntry {
  1432. SanType type;
  1433. std::string value;
  1434. };
  1435. // Verification context for certificate verification callback
  1436. struct VerifyContext {
  1437. session_t session; // TLS session handle
  1438. cert_t cert; // Current certificate being verified
  1439. int depth; // Certificate chain depth (0 = leaf)
  1440. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1441. long error_code; // Backend-specific error code (0 = no error)
  1442. const char *error_string; // Human-readable error description
  1443. // Certificate introspection methods
  1444. std::string subject_cn() const;
  1445. std::string issuer_name() const;
  1446. bool check_hostname(const char *hostname) const;
  1447. std::vector<SanEntry> sans() const;
  1448. bool validity(time_t &not_before, time_t &not_after) const;
  1449. std::string serial() const;
  1450. };
  1451. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1452. // TlsError codes for TLS operations (backend-independent)
  1453. enum class ErrorCode : int {
  1454. Success = 0,
  1455. WantRead, // Non-blocking: need to wait for read
  1456. WantWrite, // Non-blocking: need to wait for write
  1457. PeerClosed, // Peer closed the connection
  1458. Fatal, // Unrecoverable error
  1459. SyscallError, // System call error (check sys_errno)
  1460. CertVerifyFailed, // Certificate verification failed
  1461. HostnameMismatch, // Hostname verification failed
  1462. };
  1463. // TLS error information
  1464. struct TlsError {
  1465. ErrorCode code = ErrorCode::Fatal;
  1466. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1467. int sys_errno = 0; // errno when SyscallError
  1468. // Convert verification error code to human-readable string
  1469. static std::string verify_error_to_string(long error_code);
  1470. };
  1471. // RAII wrapper for peer certificate
  1472. class PeerCert {
  1473. public:
  1474. PeerCert();
  1475. PeerCert(PeerCert &&other) noexcept;
  1476. PeerCert &operator=(PeerCert &&other) noexcept;
  1477. ~PeerCert();
  1478. PeerCert(const PeerCert &) = delete;
  1479. PeerCert &operator=(const PeerCert &) = delete;
  1480. explicit operator bool() const;
  1481. std::string subject_cn() const;
  1482. std::string issuer_name() const;
  1483. bool check_hostname(const char *hostname) const;
  1484. std::vector<SanEntry> sans() const;
  1485. bool validity(time_t &not_before, time_t &not_after) const;
  1486. std::string serial() const;
  1487. private:
  1488. explicit PeerCert(cert_t cert);
  1489. cert_t cert_ = nullptr;
  1490. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1491. };
  1492. // Callback for TLS context setup (used by SSLServer constructor)
  1493. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1494. } // namespace tls
  1495. #endif
  1496. struct Request {
  1497. std::string method;
  1498. std::string path;
  1499. std::string matched_route;
  1500. Params params;
  1501. Headers headers;
  1502. Headers trailers;
  1503. std::string body;
  1504. std::string remote_addr;
  1505. int remote_port = -1;
  1506. std::string local_addr;
  1507. int local_port = -1;
  1508. // for server
  1509. std::string version;
  1510. std::string target;
  1511. MultipartFormData form;
  1512. Ranges ranges;
  1513. Match matches;
  1514. std::unordered_map<std::string, std::string> path_params;
  1515. std::function<bool()> is_connection_closed = []() { return true; };
  1516. // for client
  1517. std::vector<std::string> accept_content_types;
  1518. ResponseHandler response_handler;
  1519. ContentReceiverWithProgress content_receiver;
  1520. DownloadProgress download_progress;
  1521. UploadProgress upload_progress;
  1522. bool has_header(const std::string &key) const;
  1523. std::string get_header_value(const std::string &key, const char *def = "",
  1524. size_t id = 0) const;
  1525. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1526. size_t id = 0) const;
  1527. size_t get_header_value_count(const std::string &key) const;
  1528. void set_header(const std::string &key, const std::string &val);
  1529. bool has_trailer(const std::string &key) const;
  1530. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1531. size_t get_trailer_value_count(const std::string &key) const;
  1532. bool has_param(const std::string &key) const;
  1533. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1534. std::vector<std::string> get_param_values(const std::string &key) const;
  1535. size_t get_param_value_count(const std::string &key) const;
  1536. bool is_multipart_form_data() const;
  1537. // private members...
  1538. bool body_read_started_ = false;
  1539. bool body_consumed_ = false;
  1540. bool expect_100_continue_pending_ = false;
  1541. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1542. size_t content_length_ = 0;
  1543. ContentProvider content_provider_;
  1544. bool is_chunked_content_provider_ = false;
  1545. size_t authorization_count_ = 0;
  1546. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1547. (std::chrono::steady_clock::time_point::min)();
  1548. #ifdef CPPHTTPLIB_SSL_ENABLED
  1549. tls::const_session_t ssl = nullptr;
  1550. tls::PeerCert peer_cert() const;
  1551. std::string sni() const;
  1552. #endif
  1553. };
  1554. namespace detail {
  1555. // Declared up here, away from the rest of the compression helpers, because
  1556. // `Response` stores one.
  1557. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1558. } // namespace detail
  1559. struct Response {
  1560. std::string version;
  1561. int status = -1;
  1562. std::string reason;
  1563. Headers headers;
  1564. Headers trailers;
  1565. std::string body;
  1566. std::string location; // Redirect location
  1567. // User-defined context — set by pre-routing/pre-request handlers and read
  1568. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1569. UserData user_data;
  1570. bool has_header(const std::string &key) const;
  1571. std::string get_header_value(const std::string &key, const char *def = "",
  1572. size_t id = 0) const;
  1573. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1574. size_t id = 0) const;
  1575. size_t get_header_value_count(const std::string &key) const;
  1576. void set_header(const std::string &key, const std::string &val);
  1577. bool has_trailer(const std::string &key) const;
  1578. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1579. size_t get_trailer_value_count(const std::string &key) const;
  1580. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1581. void set_content(const char *s, size_t n, const std::string &content_type);
  1582. void set_content(const std::string &s, const std::string &content_type);
  1583. void set_content(std::string &&s, const std::string &content_type);
  1584. void set_content_provider(
  1585. size_t length, const std::string &content_type, ContentProvider provider,
  1586. ContentProviderResourceReleaser resource_releaser = nullptr);
  1587. void set_content_provider(
  1588. const std::string &content_type, ContentProviderWithoutLength provider,
  1589. ContentProviderResourceReleaser resource_releaser = nullptr);
  1590. void set_chunked_content_provider(
  1591. const std::string &content_type, ContentProviderWithoutLength provider,
  1592. ContentProviderResourceReleaser resource_releaser = nullptr);
  1593. void set_file_content(const std::string &path,
  1594. const std::string &content_type);
  1595. void set_file_content(const std::string &path);
  1596. Response() = default;
  1597. Response(const Response &) = default;
  1598. Response &operator=(const Response &) = default;
  1599. Response(Response &&) = default;
  1600. Response &operator=(Response &&) = default;
  1601. ~Response() {
  1602. if (content_provider_resource_releaser_) {
  1603. content_provider_resource_releaser_(content_provider_success_);
  1604. }
  1605. }
  1606. // private members...
  1607. size_t content_length_ = 0;
  1608. ContentProvider content_provider_;
  1609. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1610. bool is_chunked_content_provider_ = false;
  1611. bool is_file_content_provider_ = false;
  1612. bool content_provider_success_ = false;
  1613. std::string file_content_path_;
  1614. std::string file_content_content_type_;
  1615. // Content coding chosen for the response body, decided once so that the
  1616. // headers and the body cannot disagree: where the file is opened for a
  1617. // file-backed content provider (keeping the ETag honest), and in
  1618. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1619. // for every other kind of response.
  1620. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1621. };
  1622. enum class Error {
  1623. Success = 0,
  1624. Unknown,
  1625. Connection,
  1626. BindIPAddress,
  1627. Read,
  1628. Write,
  1629. ExceedRedirectCount,
  1630. Canceled,
  1631. SSLConnection,
  1632. SSLLoadingCerts,
  1633. SSLServerVerification,
  1634. SSLServerHostnameVerification,
  1635. UnsupportedMultipartBoundaryChars,
  1636. Compression,
  1637. ConnectionTimeout,
  1638. ProxyConnection,
  1639. ConnectionClosed,
  1640. Timeout,
  1641. ResourceExhaustion,
  1642. TooManyFormDataFiles,
  1643. ExceedMaxPayloadSize,
  1644. ExceedUriMaxLength,
  1645. ExceedMaxSocketDescriptorCount,
  1646. InvalidRequestLine,
  1647. InvalidHTTPMethod,
  1648. InvalidHTTPVersion,
  1649. InvalidHeaders,
  1650. MultipartParsing,
  1651. OpenFile,
  1652. Listen,
  1653. GetSockName,
  1654. UnsupportedAddressFamily,
  1655. HTTPParsing,
  1656. InvalidRangeHeader,
  1657. UnsupportedContentEncoding,
  1658. WebSocketHandshake,
  1659. UserCallbackException,
  1660. // For internal use only
  1661. SSLPeerCouldBeClosed_,
  1662. };
  1663. std::string to_string(Error error);
  1664. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1665. class Stream {
  1666. public:
  1667. virtual ~Stream() = default;
  1668. virtual bool is_readable() const = 0;
  1669. virtual bool wait_readable() const = 0;
  1670. virtual bool wait_writable() const = 0;
  1671. virtual bool is_peer_alive() const { return wait_writable(); }
  1672. virtual ssize_t read(char *ptr, size_t size) = 0;
  1673. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1674. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1675. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1676. virtual socket_t socket() const = 0;
  1677. virtual time_t duration() const = 0;
  1678. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1679. (void)sec;
  1680. (void)usec;
  1681. }
  1682. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1683. // each one. 0 lifts the bound.
  1684. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1685. // Bytes already pulled off the socket and sitting in this stream's own
  1686. // buffer. Exposing them lets a line reader scan for a terminator in one
  1687. // pass instead of asking for a byte at a time. A stream that does no
  1688. // buffering of its own reports none, and readers fall back to read().
  1689. virtual const char *buffered_data(size_t &size) const {
  1690. size = 0;
  1691. return nullptr;
  1692. }
  1693. // Discards `size` bytes previously returned by buffered_data().
  1694. virtual void consume_buffered(size_t size) { (void)size; }
  1695. ssize_t write(const char *ptr);
  1696. ssize_t write(const std::string &s);
  1697. Error get_error() const { return error_; }
  1698. protected:
  1699. Error error_ = Error::Success;
  1700. };
  1701. class TaskQueue {
  1702. public:
  1703. TaskQueue() = default;
  1704. virtual ~TaskQueue() = default;
  1705. virtual bool enqueue(std::function<void()> fn) = 0;
  1706. virtual void shutdown() = 0;
  1707. virtual void on_idle() {}
  1708. };
  1709. class ThreadPool final : public TaskQueue {
  1710. public:
  1711. explicit ThreadPool(
  1712. size_t n, size_t max_n = 0, size_t mqr = 0,
  1713. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1714. ThreadPool(const ThreadPool &) = delete;
  1715. ~ThreadPool() override = default;
  1716. bool enqueue(std::function<void()> fn) override;
  1717. void shutdown() override;
  1718. private:
  1719. void worker(bool is_dynamic);
  1720. void move_to_finished(std::thread::id id);
  1721. void cleanup_finished_threads();
  1722. size_t base_thread_count_;
  1723. size_t max_thread_count_;
  1724. size_t max_queued_requests_;
  1725. time_t idle_timeout_sec_;
  1726. size_t idle_thread_count_;
  1727. bool shutdown_;
  1728. std::list<std::function<void()>> jobs_;
  1729. std::vector<std::thread> threads_; // base threads
  1730. std::list<std::thread> dynamic_threads_; // dynamic threads
  1731. std::vector<std::thread>
  1732. finished_threads_; // exited dynamic threads awaiting join
  1733. std::condition_variable cond_;
  1734. std::mutex mutex_;
  1735. };
  1736. using Logger = std::function<void(const Request &, const Response &)>;
  1737. // Forward declaration for Error type
  1738. enum class Error;
  1739. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1740. using SocketOptions = std::function<void(socket_t sock)>;
  1741. void default_socket_options(socket_t sock);
  1742. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1743. const char *status_message(int status);
  1744. std::string to_string(Error error);
  1745. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1746. std::string get_bearer_token_auth(const Request &req);
  1747. namespace detail {
  1748. class MatcherBase {
  1749. public:
  1750. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1751. virtual ~MatcherBase() = default;
  1752. const std::string &pattern() const { return pattern_; }
  1753. // Match request path and populate its matches and
  1754. virtual bool match(Request &request) const = 0;
  1755. private:
  1756. std::string pattern_;
  1757. };
  1758. /**
  1759. * Captures parameters in request path and stores them in Request::path_params
  1760. *
  1761. * Capture name is a substring of a pattern from : to /.
  1762. * The rest of the pattern is matched against the request path directly
  1763. * Parameters are captured starting from the next character after
  1764. * the end of the last matched static pattern fragment until the next /.
  1765. *
  1766. * Example pattern:
  1767. * "/path/fragments/:capture/more/fragments/:second_capture"
  1768. * Static fragments:
  1769. * "/path/fragments/", "more/fragments/"
  1770. *
  1771. * Given the following request path:
  1772. * "/path/fragments/:1/more/fragments/:2"
  1773. * the resulting capture will be
  1774. * {{"capture", "1"}, {"second_capture", "2"}}
  1775. */
  1776. class PathParamsMatcher final : public MatcherBase {
  1777. public:
  1778. PathParamsMatcher(const std::string &pattern);
  1779. bool match(Request &request) const override;
  1780. private:
  1781. // Treat segment separators as the end of path parameter capture
  1782. // Does not need to handle query parameters as they are parsed before path
  1783. // matching
  1784. static constexpr char separator = '/';
  1785. // Contains static path fragments to match against, excluding the '/' after
  1786. // path params
  1787. // Fragments are separated by path params
  1788. std::vector<std::string> static_fragments_;
  1789. // Stores the names of the path parameters to be used as keys in the
  1790. // Request::path_params map
  1791. std::vector<std::string> param_names_;
  1792. };
  1793. /**
  1794. * Performs std::regex_match on request path
  1795. * and stores the result in Request::matches
  1796. *
  1797. * Note that regex match is performed directly on the whole request.
  1798. * This means that wildcard patterns may match multiple path segments with /:
  1799. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1800. */
  1801. class RegexMatcher final : public MatcherBase {
  1802. public:
  1803. RegexMatcher(const std::string &pattern)
  1804. : MatcherBase(pattern), regex_(pattern) {}
  1805. bool match(Request &request) const override;
  1806. private:
  1807. std::regex regex_;
  1808. };
  1809. int close_socket(socket_t sock) noexcept;
  1810. bool is_accept_resource_error();
  1811. bool is_accept_transient_error();
  1812. ssize_t write_headers(Stream &strm, const Headers &headers);
  1813. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1814. time_t usec);
  1815. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1816. const std::string &boundary);
  1817. ContentProvider
  1818. make_multipart_content_provider(const UploadFormDataItems &items,
  1819. const std::string &boundary);
  1820. } // namespace detail
  1821. bool is_valid_multipart_boundary(const std::string &boundary);
  1822. // Serializer for multipart/form-data request bodies. The boundary is owned
  1823. // by the writer so that per-part framing and the final terminator always
  1824. // agree. Field names and filenames are escaped following the WHATWG HTML
  1825. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1826. // in content types.
  1827. class MultipartFormDataWriter {
  1828. public:
  1829. MultipartFormDataWriter();
  1830. // precondition: is_valid_multipart_boundary(boundary)
  1831. explicit MultipartFormDataWriter(std::string boundary);
  1832. const std::string &boundary() const;
  1833. std::string content_type() const;
  1834. // In-memory items -> whole body (known length)
  1835. std::string serialize(const UploadFormDataItems &items) const;
  1836. size_t content_length(const UploadFormDataItems &items) const;
  1837. // Per-part framing for streaming via a content provider
  1838. std::string item_begin(const UploadFormData &item) const;
  1839. static std::string item_end();
  1840. std::string finish() const;
  1841. private:
  1842. std::string boundary_;
  1843. };
  1844. class Server {
  1845. public:
  1846. using Handler = std::function<void(const Request &, Response &)>;
  1847. using ExceptionHandler =
  1848. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1849. enum class HandlerResponse {
  1850. Handled,
  1851. Unhandled,
  1852. };
  1853. using HandlerWithResponse =
  1854. std::function<HandlerResponse(const Request &, Response &)>;
  1855. using HandlerWithContentReader = std::function<void(
  1856. const Request &, Response &, const ContentReader &content_reader)>;
  1857. using Expect100ContinueHandler =
  1858. std::function<int(const Request &, Response &)>;
  1859. using StartHandler = std::function<void()>;
  1860. using WebSocketHandler =
  1861. std::function<void(const Request &, ws::WebSocket &)>;
  1862. using SubProtocolSelector =
  1863. std::function<std::string(const std::vector<std::string> &protocols)>;
  1864. Server();
  1865. virtual ~Server();
  1866. virtual bool is_valid() const;
  1867. Server &Get(const std::string &pattern, Handler handler);
  1868. Server &Post(const std::string &pattern, Handler handler);
  1869. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1870. Server &Put(const std::string &pattern, Handler handler);
  1871. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1872. Server &Patch(const std::string &pattern, Handler handler);
  1873. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1874. Server &Delete(const std::string &pattern, Handler handler);
  1875. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1876. Server &Options(const std::string &pattern, Handler handler);
  1877. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1878. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1879. // server accept it; an unregistered method is still rejected with 400.
  1880. // `method` must be a valid HTTP method token and must not be one of the
  1881. // built-in methods, which have their own registration functions above. A
  1882. // rejected registration makes is_valid() return false, so listen() fails.
  1883. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1884. Handler handler);
  1885. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1886. HandlerWithContentReader handler);
  1887. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1888. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1889. SubProtocolSelector sub_protocol_selector);
  1890. bool set_base_dir(const std::string &dir,
  1891. const std::string &mount_point = std::string());
  1892. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1893. Headers headers = Headers());
  1894. bool remove_mount_point(const std::string &mount_point);
  1895. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1896. const std::string &mime);
  1897. Server &set_default_file_mimetype(const std::string &mime);
  1898. Server &set_file_request_handler(Handler handler);
  1899. template <class ErrorHandlerFunc>
  1900. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1901. return set_error_handler_core(
  1902. std::forward<ErrorHandlerFunc>(handler),
  1903. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1904. }
  1905. Server &set_exception_handler(ExceptionHandler handler);
  1906. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1907. Server &set_post_routing_handler(Handler handler);
  1908. Server &set_pre_request_handler(HandlerWithResponse handler);
  1909. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1910. Server &set_start_handler(StartHandler handler);
  1911. Server &set_logger(Logger logger);
  1912. Server &set_pre_compression_logger(Logger logger);
  1913. Server &set_error_logger(ErrorLogger error_logger);
  1914. Server &set_address_family(int family);
  1915. Server &set_tcp_nodelay(bool on);
  1916. Server &set_ipv6_v6only(bool on);
  1917. Server &set_socket_options(SocketOptions socket_options);
  1918. Server &set_default_headers(Headers headers);
  1919. Server &
  1920. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1921. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1922. Server &set_keep_alive_max_count(size_t count);
  1923. Server &set_keep_alive_timeout(time_t sec);
  1924. template <class Rep, class Period>
  1925. Server &
  1926. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1927. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1928. template <class Rep, class Period>
  1929. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1930. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1931. template <class Rep, class Period>
  1932. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1933. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1934. template <class Rep, class Period>
  1935. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1936. Server &set_payload_max_length(size_t length);
  1937. Server &set_static_file_compression(bool on);
  1938. Server &set_static_file_compression_min_length(size_t length);
  1939. Server &set_static_file_compression_max_length(size_t length);
  1940. Server &set_websocket_ping_interval(time_t sec);
  1941. template <class Rep, class Period>
  1942. Server &set_websocket_ping_interval(
  1943. const std::chrono::duration<Rep, Period> &duration);
  1944. Server &set_websocket_max_missed_pongs(int count);
  1945. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1946. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1947. bool listen_after_bind();
  1948. bool listen(const std::string &host, int port, int socket_flags = 0);
  1949. bool is_running() const;
  1950. void wait_until_ready() const;
  1951. void stop() noexcept;
  1952. void decommission();
  1953. std::function<TaskQueue *(void)> new_task_queue;
  1954. protected:
  1955. bool process_request(Stream &strm, const std::string &remote_addr,
  1956. int remote_port, const std::string &local_addr,
  1957. int local_port, bool close_connection,
  1958. bool &connection_closed,
  1959. const std::function<void(Request &)> &setup_request,
  1960. bool *websocket_upgraded = nullptr);
  1961. // Runs the per-connection serving loop and stops an exception thrown by a
  1962. // user callback from escaping the worker thread.
  1963. //
  1964. // process_request() wraps only routing() in a try/catch. Content providers,
  1965. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1966. // handlers all run outside it, and the task queue calls the job without a
  1967. // catch, so an exception from any of those would terminate the process.
  1968. //
  1969. // No 500 is possible here: by the time a content provider runs, the status
  1970. // line and headers are already on the wire. Report it through the error
  1971. // logger and drop the connection, which is what the peer observes either
  1972. // way. Other connections are unaffected.
  1973. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1974. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1975. return serve();
  1976. #else
  1977. try {
  1978. return serve();
  1979. } catch (...) {
  1980. // The error logger is a user callback too, so it must not be able to
  1981. // throw the guard back open.
  1982. try {
  1983. output_error_log(Error::UserCallbackException, nullptr);
  1984. } catch (...) {}
  1985. return false;
  1986. }
  1987. #endif
  1988. }
  1989. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1990. std::vector<std::string> trusted_proxies_;
  1991. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1992. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1993. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1994. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1995. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1996. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1997. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1998. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1999. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2000. bool static_file_compression_ = false;
  2001. size_t static_file_compression_min_length_ =
  2002. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2003. size_t static_file_compression_max_length_ =
  2004. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2005. time_t websocket_ping_interval_sec_ =
  2006. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2007. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2008. private:
  2009. using Handlers =
  2010. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2011. using HandlersForContentReader =
  2012. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2013. HandlerWithContentReader>>;
  2014. // Both handler tables for one custom method live in a single entry, so that
  2015. // routing() needs only one map lookup per request to reach either of them.
  2016. struct CustomHandlerEntry {
  2017. Handlers handlers;
  2018. HandlersForContentReader handlers_for_content_reader;
  2019. };
  2020. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2021. static std::unique_ptr<detail::MatcherBase>
  2022. make_matcher(const std::string &pattern);
  2023. static const std::set<std::string> &builtin_methods();
  2024. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2025. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2026. template <typename H>
  2027. Server &add_handler(
  2028. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2029. const std::string &pattern, H handler) {
  2030. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2031. return *this;
  2032. }
  2033. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2034. Server &set_error_handler_core(Handler handler, std::false_type);
  2035. socket_t create_server_socket(const std::string &host, int port,
  2036. int socket_flags,
  2037. SocketOptions socket_options) const;
  2038. int bind_internal(const std::string &host, int port, int socket_flags);
  2039. bool listen_internal();
  2040. bool routing(Request &req, Response &res, Stream &strm);
  2041. bool handle_file_request(Request &req, Response &res);
  2042. bool check_if_not_modified(const Request &req, Response &res,
  2043. const std::string &etag, time_t mtime) const;
  2044. bool check_if_range(Request &req, const std::string &etag,
  2045. time_t mtime) const;
  2046. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2047. Stream &strm);
  2048. bool dispatch_request_for_content_reader(
  2049. Request &req, Response &res, ContentReader content_reader,
  2050. const HandlersForContentReader &handlers) const;
  2051. bool parse_request_line(const char *s, Request &req) const;
  2052. detail::EncodingType static_file_encoding(const Request &req,
  2053. const Response &res,
  2054. const std::string &content_type,
  2055. size_t length) const;
  2056. bool apply_static_file_compression(const Request &req, Response &res) const;
  2057. void apply_ranges(const Request &req, Response &res,
  2058. std::string &content_type, std::string &boundary) const;
  2059. bool write_response(Stream &strm, bool close_connection, Request &req,
  2060. Response &res);
  2061. bool write_response_with_content(Stream &strm, bool close_connection,
  2062. const Request &req, Response &res);
  2063. bool write_response_core(Stream &strm, bool close_connection,
  2064. const Request &req, Response &res,
  2065. bool need_apply_ranges);
  2066. bool write_content_with_provider(Stream &strm, const Request &req,
  2067. Response &res, const std::string &boundary,
  2068. const std::string &content_type);
  2069. bool read_content(Stream &strm, Request &req, Response &res);
  2070. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2071. Response &res,
  2072. ContentReceiver receiver,
  2073. FormDataHeader multipart_header,
  2074. ContentReceiver multipart_receiver);
  2075. bool read_content_core(Stream &strm, Request &req, Response &res,
  2076. ContentReceiver receiver,
  2077. FormDataHeader multipart_header,
  2078. ContentReceiver multipart_receiver) const;
  2079. virtual bool process_and_close_socket(socket_t sock);
  2080. void output_log(const Request &req, const Response &res) const;
  2081. void output_pre_compression_log(const Request &req,
  2082. const Response &res) const;
  2083. void output_error_log(const Error &err, const Request *req) const;
  2084. std::atomic<bool> is_running_{false};
  2085. std::atomic<bool> is_decommissioned{false};
  2086. // Set when CustomRoute() refuses a registration. Written before listen(),
  2087. // read by is_valid() on the same thread, so it needs no synchronization.
  2088. bool has_invalid_registration_ = false;
  2089. struct MountPointEntry {
  2090. std::string mount_point;
  2091. std::string base_dir;
  2092. std::string resolved_base_dir;
  2093. Headers headers;
  2094. };
  2095. std::vector<MountPointEntry> base_dirs_;
  2096. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2097. std::string default_file_mimetype_ = "application/octet-stream";
  2098. Handler file_request_handler_;
  2099. Handlers get_handlers_;
  2100. Handlers post_handlers_;
  2101. HandlersForContentReader post_handlers_for_content_reader_;
  2102. Handlers put_handlers_;
  2103. HandlersForContentReader put_handlers_for_content_reader_;
  2104. Handlers patch_handlers_;
  2105. HandlersForContentReader patch_handlers_for_content_reader_;
  2106. Handlers delete_handlers_;
  2107. HandlersForContentReader delete_handlers_for_content_reader_;
  2108. Handlers options_handlers_;
  2109. CustomHandlers custom_handlers_;
  2110. struct WebSocketHandlerEntry {
  2111. std::unique_ptr<detail::MatcherBase> matcher;
  2112. WebSocketHandler handler;
  2113. SubProtocolSelector sub_protocol_selector;
  2114. };
  2115. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2116. WebSocketHandlers websocket_handlers_;
  2117. HandlerWithResponse error_handler_;
  2118. ExceptionHandler exception_handler_;
  2119. HandlerWithResponse pre_routing_handler_;
  2120. Handler post_routing_handler_;
  2121. HandlerWithResponse pre_request_handler_;
  2122. Expect100ContinueHandler expect_100_continue_handler_;
  2123. StartHandler start_handler_;
  2124. mutable std::mutex logger_mutex_;
  2125. Logger logger_;
  2126. Logger pre_compression_logger_;
  2127. ErrorLogger error_logger_;
  2128. int address_family_ = AF_UNSPEC;
  2129. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2130. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2131. SocketOptions socket_options_ = default_socket_options;
  2132. Headers default_headers_;
  2133. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2134. detail::write_headers;
  2135. };
  2136. class Result {
  2137. public:
  2138. Result() = default;
  2139. Result(std::unique_ptr<Response> &&res, Error err,
  2140. Headers &&request_headers = Headers{})
  2141. : res_(std::move(res)), err_(err),
  2142. request_headers_(std::move(request_headers)) {}
  2143. // Response
  2144. operator bool() const { return res_ != nullptr; }
  2145. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2146. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2147. const Response &value() const { return *res_; }
  2148. Response &value() { return *res_; }
  2149. const Response &operator*() const { return *res_; }
  2150. Response &operator*() { return *res_; }
  2151. const Response *operator->() const { return res_.get(); }
  2152. Response *operator->() { return res_.get(); }
  2153. // Error
  2154. Error error() const { return err_; }
  2155. // Request Headers
  2156. bool has_request_header(const std::string &key) const;
  2157. std::string get_request_header_value(const std::string &key,
  2158. const char *def = "",
  2159. size_t id = 0) const;
  2160. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2161. size_t id = 0) const;
  2162. size_t get_request_header_value_count(const std::string &key) const;
  2163. private:
  2164. std::unique_ptr<Response> res_;
  2165. Error err_ = Error::Unknown;
  2166. Headers request_headers_;
  2167. #ifdef CPPHTTPLIB_SSL_ENABLED
  2168. public:
  2169. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2170. int ssl_error)
  2171. : res_(std::move(res)), err_(err),
  2172. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2173. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2174. int ssl_error, uint64_t ssl_backend_error)
  2175. : res_(std::move(res)), err_(err),
  2176. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2177. ssl_backend_error_(ssl_backend_error) {}
  2178. int ssl_error() const { return ssl_error_; }
  2179. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2180. private:
  2181. int ssl_error_ = 0;
  2182. uint64_t ssl_backend_error_ = 0;
  2183. #endif
  2184. };
  2185. struct ClientConnection {
  2186. socket_t sock = INVALID_SOCKET;
  2187. bool is_open() const { return sock != INVALID_SOCKET; }
  2188. ClientConnection() = default;
  2189. ~ClientConnection();
  2190. ClientConnection(const ClientConnection &) = delete;
  2191. ClientConnection &operator=(const ClientConnection &) = delete;
  2192. ClientConnection(ClientConnection &&other) noexcept
  2193. : sock(other.sock)
  2194. #ifdef CPPHTTPLIB_SSL_ENABLED
  2195. ,
  2196. session(other.session)
  2197. #endif
  2198. {
  2199. other.sock = INVALID_SOCKET;
  2200. #ifdef CPPHTTPLIB_SSL_ENABLED
  2201. other.session = nullptr;
  2202. #endif
  2203. }
  2204. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2205. if (this != &other) {
  2206. sock = other.sock;
  2207. other.sock = INVALID_SOCKET;
  2208. #ifdef CPPHTTPLIB_SSL_ENABLED
  2209. session = other.session;
  2210. other.session = nullptr;
  2211. #endif
  2212. }
  2213. return *this;
  2214. }
  2215. #ifdef CPPHTTPLIB_SSL_ENABLED
  2216. tls::session_t session = nullptr;
  2217. #endif
  2218. };
  2219. namespace detail {
  2220. struct ChunkedDecoder;
  2221. struct BodyReader {
  2222. Stream *stream = nullptr;
  2223. bool has_content_length = false;
  2224. size_t content_length = 0;
  2225. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2226. size_t bytes_read = 0;
  2227. bool chunked = false;
  2228. bool eof = false;
  2229. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2230. Error last_error = Error::Success;
  2231. ssize_t read(char *buf, size_t len);
  2232. bool has_error() const { return last_error != Error::Success; }
  2233. };
  2234. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2235. size_t len) {
  2236. (void)stream;
  2237. return br.read(buf, len);
  2238. }
  2239. class decompressor;
  2240. enum class NoProxyKind {
  2241. Wildcard, // "*"
  2242. HostnameSuffix, // "example.com" or ".example.com"
  2243. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2244. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2245. };
  2246. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2247. // Lets one CIDR matcher cover both families.
  2248. using IPBytes = std::array<uint8_t, 16>;
  2249. struct NoProxyEntry {
  2250. NoProxyKind kind = NoProxyKind::Wildcard;
  2251. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2252. IPBytes net{};
  2253. int prefix_bits = 0;
  2254. };
  2255. struct NormalizedTarget {
  2256. std::string hostname; // lowercase; brackets and trailing dot removed
  2257. bool is_ipv4 = false;
  2258. bool is_ipv6 = false;
  2259. IPBytes ip{};
  2260. };
  2261. } // namespace detail
  2262. class ClientImpl {
  2263. public:
  2264. explicit ClientImpl(const std::string &host);
  2265. explicit ClientImpl(const std::string &host, int port);
  2266. explicit ClientImpl(const std::string &host, int port,
  2267. const std::string &client_cert_path,
  2268. const std::string &client_key_path);
  2269. virtual ~ClientImpl();
  2270. virtual bool is_valid() const;
  2271. struct StreamHandle {
  2272. std::unique_ptr<Response> response;
  2273. Error error = Error::Success;
  2274. StreamHandle() = default;
  2275. StreamHandle(const StreamHandle &) = delete;
  2276. StreamHandle &operator=(const StreamHandle &) = delete;
  2277. StreamHandle(StreamHandle &&) = default;
  2278. StreamHandle &operator=(StreamHandle &&) = default;
  2279. ~StreamHandle() = default;
  2280. bool is_valid() const {
  2281. return response != nullptr && error == Error::Success;
  2282. }
  2283. ssize_t read(char *buf, size_t len);
  2284. void parse_trailers_if_needed();
  2285. Error get_read_error() const { return body_reader_.last_error; }
  2286. bool has_read_error() const { return body_reader_.has_error(); }
  2287. bool trailers_parsed_ = false;
  2288. private:
  2289. friend class ClientImpl;
  2290. ssize_t read_with_decompression(char *buf, size_t len);
  2291. std::unique_ptr<ClientConnection> connection_;
  2292. std::unique_ptr<Stream> socket_stream_;
  2293. Stream *stream_ = nullptr;
  2294. detail::BodyReader body_reader_;
  2295. std::unique_ptr<detail::decompressor> decompressor_;
  2296. std::string decompress_buffer_;
  2297. size_t decompress_offset_ = 0;
  2298. size_t decompressed_bytes_read_ = 0;
  2299. };
  2300. // clang-format off
  2301. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2302. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2303. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2304. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2305. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2306. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2307. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2308. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2309. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2310. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2311. Result Head(const std::string &path);
  2312. Result Head(const std::string &path, const Headers &headers);
  2313. Result Post(const std::string &path);
  2314. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2315. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2316. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2317. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2318. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2319. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2320. Result Post(const std::string &path, const Params &params);
  2321. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2322. Result Post(const std::string &path, const Headers &headers);
  2323. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2324. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2325. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2326. 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);
  2327. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2328. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2329. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2330. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2331. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2332. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2333. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2334. Result Put(const std::string &path);
  2335. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2336. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2338. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2339. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2340. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2341. Result Put(const std::string &path, const Params &params);
  2342. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2343. Result Put(const std::string &path, const Headers &headers);
  2344. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2345. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2346. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2347. 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);
  2348. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2349. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2350. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2351. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2352. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2353. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2354. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2355. Result Patch(const std::string &path);
  2356. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2357. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2358. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2359. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2360. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2361. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2362. Result Patch(const std::string &path, const Params &params);
  2363. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2364. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2365. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2366. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2367. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2368. 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);
  2369. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2370. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2371. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2372. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2373. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2374. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2375. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2376. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2377. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2378. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2379. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2380. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2381. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2382. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2383. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2384. Result Options(const std::string &path);
  2385. Result Options(const std::string &path, const Headers &headers);
  2386. // clang-format on
  2387. // Streaming API: Open a stream for reading response body incrementally
  2388. // Socket ownership is transferred to StreamHandle for true streaming
  2389. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2390. StreamHandle open_stream(const std::string &method, const std::string &path,
  2391. const Params &params = {},
  2392. const Headers &headers = {},
  2393. const std::string &body = {},
  2394. const std::string &content_type = {});
  2395. bool send(Request &req, Response &res, Error &error);
  2396. Result send(const Request &req);
  2397. void stop();
  2398. std::string host() const;
  2399. int port() const;
  2400. size_t is_socket_open() const;
  2401. socket_t socket() const;
  2402. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2403. void set_default_headers(Headers headers);
  2404. void
  2405. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2406. void set_address_family(int family);
  2407. void set_tcp_nodelay(bool on);
  2408. void set_ipv6_v6only(bool on);
  2409. void set_socket_options(SocketOptions socket_options);
  2410. void set_connection_timeout(time_t sec, time_t usec = 0);
  2411. template <class Rep, class Period>
  2412. void
  2413. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2414. void set_read_timeout(time_t sec, time_t usec = 0);
  2415. template <class Rep, class Period>
  2416. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2417. void set_write_timeout(time_t sec, time_t usec = 0);
  2418. template <class Rep, class Period>
  2419. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2420. void set_max_timeout(time_t msec);
  2421. template <class Rep, class Period>
  2422. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2423. void set_basic_auth(const std::string &username, const std::string &password);
  2424. void set_bearer_token_auth(const std::string &token);
  2425. void set_keep_alive(bool on);
  2426. void set_follow_location(bool on);
  2427. void set_path_encode(bool on);
  2428. void set_compress(bool on);
  2429. void set_decompress(bool on);
  2430. void set_payload_max_length(size_t length);
  2431. void set_interface(const std::string &intf);
  2432. void set_proxy(const std::string &host, int port);
  2433. void set_proxy_basic_auth(const std::string &username,
  2434. const std::string &password);
  2435. void set_proxy_bearer_token_auth(const std::string &token);
  2436. void set_no_proxy(const std::vector<std::string> &patterns);
  2437. void set_logger(Logger logger);
  2438. void set_error_logger(ErrorLogger error_logger);
  2439. protected:
  2440. struct Socket {
  2441. socket_t sock = INVALID_SOCKET;
  2442. // For Mbed TLS compatibility: start_time for request timeout tracking
  2443. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2444. bool is_open() const { return sock != INVALID_SOCKET; }
  2445. #ifdef CPPHTTPLIB_SSL_ENABLED
  2446. tls::session_t ssl = nullptr;
  2447. #endif
  2448. };
  2449. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2450. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2451. virtual bool setup_proxy_connection(
  2452. Socket &socket,
  2453. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2454. Response &res, bool &success, Error &error);
  2455. bool is_proxy_enabled_for_host(const std::string &host) const;
  2456. // All of:
  2457. // shutdown_ssl
  2458. // shutdown_socket
  2459. // close_socket
  2460. // disconnect
  2461. // should ONLY be called when socket_mutex_ is locked, and only when
  2462. // no other thread is using the socket.
  2463. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2464. void shutdown_socket(Socket &socket) const;
  2465. void close_socket(Socket &socket);
  2466. void disconnect(bool gracefully);
  2467. bool process_request(Stream &strm, Request &req, Response &res,
  2468. bool close_connection, Error &error);
  2469. bool write_content_with_provider(Stream &strm, const Request &req,
  2470. Error &error) const;
  2471. void output_log(const Request &req, const Response &res) const;
  2472. void output_error_log(const Error &err, const Request *req) const;
  2473. // Socket endpoint information
  2474. const std::string host_;
  2475. const int port_;
  2476. // Current open socket
  2477. Socket socket_;
  2478. mutable std::mutex socket_mutex_;
  2479. std::recursive_mutex request_mutex_;
  2480. // These are all protected under socket_mutex
  2481. size_t socket_requests_in_flight_ = 0;
  2482. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2483. bool socket_should_be_closed_when_request_is_done_ = false;
  2484. // Hostname to connection target map. The value is an IP literal or another
  2485. // hostname; only the connection target changes, never the identity.
  2486. std::map<std::string, std::string> addr_map_;
  2487. // Default headers
  2488. Headers default_headers_;
  2489. // Header writer
  2490. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2491. detail::write_headers;
  2492. // Settings
  2493. std::string client_cert_path_;
  2494. std::string client_key_path_;
  2495. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2496. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2497. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2498. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2499. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2500. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2501. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2502. std::string basic_auth_username_;
  2503. std::string basic_auth_password_;
  2504. std::string bearer_token_auth_token_;
  2505. bool keep_alive_ = false;
  2506. bool follow_location_ = false;
  2507. bool path_encode_ = true;
  2508. int address_family_ = AF_UNSPEC;
  2509. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2510. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2511. SocketOptions socket_options_ = nullptr;
  2512. bool compress_ = false;
  2513. bool decompress_ = true;
  2514. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2515. bool has_payload_max_length_ = false;
  2516. std::string interface_;
  2517. std::string proxy_host_;
  2518. int proxy_port_ = -1;
  2519. std::string proxy_basic_auth_username_;
  2520. std::string proxy_basic_auth_password_;
  2521. std::string proxy_bearer_token_auth_token_;
  2522. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2523. mutable detail::NormalizedTarget host_normalized_;
  2524. mutable bool host_normalized_valid_ = false;
  2525. mutable std::mutex logger_mutex_;
  2526. Logger logger_;
  2527. ErrorLogger error_logger_;
  2528. private:
  2529. bool send_(Request &req, Response &res, Error &error);
  2530. Result send_(Request &&req);
  2531. socket_t create_client_socket(Error &error) const;
  2532. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2533. bool skip_100_continue = true) const;
  2534. bool write_request(Stream &strm, Request &req, bool close_connection,
  2535. Error &error, bool skip_body, bool &rejected_locally);
  2536. bool write_request_body(Stream &strm, Request &req, Error &error);
  2537. void prepare_default_headers(Request &r, bool for_stream,
  2538. const std::string &ct);
  2539. bool redirect(Request &req, Response &res, Error &error);
  2540. bool create_redirect_client(const std::string &scheme,
  2541. const std::string &host, int port, Request &req,
  2542. Response &res, const std::string &path,
  2543. const std::string &location, Error &error);
  2544. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2545. bool handle_request(Stream &strm, Request &req, Response &res,
  2546. bool close_connection, Error &error);
  2547. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2548. Request &req, const char *body, size_t content_length,
  2549. ContentProvider content_provider,
  2550. ContentProviderWithoutLength content_provider_without_length,
  2551. const std::string &content_type, ContentReceiver content_receiver,
  2552. Error &error);
  2553. Result send_with_content_provider_and_receiver(
  2554. const std::string &method, const std::string &path,
  2555. const Headers &headers, const char *body, size_t content_length,
  2556. ContentProvider content_provider,
  2557. ContentProviderWithoutLength content_provider_without_length,
  2558. const std::string &content_type, ContentReceiver content_receiver,
  2559. UploadProgress progress);
  2560. ContentProviderWithoutLength get_multipart_content_provider(
  2561. const std::string &boundary, const UploadFormDataItems &items,
  2562. const FormDataProviderItems &provider_items) const;
  2563. virtual bool
  2564. process_socket(const Socket &socket,
  2565. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2566. std::function<bool(Stream &strm)> callback);
  2567. virtual bool is_ssl() const;
  2568. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2569. #ifdef CPPHTTPLIB_SSL_ENABLED
  2570. public:
  2571. void set_digest_auth(const std::string &username,
  2572. const std::string &password);
  2573. void set_proxy_digest_auth(const std::string &username,
  2574. const std::string &password);
  2575. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2576. const std::string &ca_cert_dir_path = std::string());
  2577. void enable_server_certificate_verification(bool enabled);
  2578. void enable_server_hostname_verification(bool enabled);
  2579. void enable_system_ca(bool enabled);
  2580. protected:
  2581. std::string digest_auth_username_;
  2582. std::string digest_auth_password_;
  2583. std::string proxy_digest_auth_username_;
  2584. std::string proxy_digest_auth_password_;
  2585. std::string ca_cert_file_path_;
  2586. std::string ca_cert_dir_path_;
  2587. bool server_certificate_verification_ = true;
  2588. bool server_hostname_verification_ = true;
  2589. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2590. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2591. int last_ssl_error_ = 0;
  2592. uint64_t last_backend_error_ = 0;
  2593. #endif
  2594. };
  2595. namespace detail {
  2596. // Stands in for a client that Client could not make from its arguments, so a
  2597. // request fails rather than going through a null pointer.
  2598. class InvalidClientImpl final : public ClientImpl {
  2599. public:
  2600. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2601. bool is_valid() const override { return false; }
  2602. private:
  2603. bool create_and_connect_socket(Socket &, Error &error) override {
  2604. error = Error::Connection;
  2605. return false;
  2606. }
  2607. };
  2608. } // namespace detail
  2609. class Client {
  2610. public:
  2611. // Universal interface
  2612. explicit Client(const std::string &scheme_host_port);
  2613. explicit Client(const std::string &scheme_host_port,
  2614. const std::string &client_cert_path,
  2615. const std::string &client_key_path);
  2616. // HTTP only interface
  2617. explicit Client(const std::string &host, int port);
  2618. explicit Client(const std::string &host, int port,
  2619. const std::string &client_cert_path,
  2620. const std::string &client_key_path);
  2621. Client(Client &&) = default;
  2622. Client &operator=(Client &&) = default;
  2623. ~Client();
  2624. bool is_valid() const;
  2625. // clang-format off
  2626. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2627. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2628. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2629. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2630. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2631. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2632. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2633. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2634. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2635. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2636. Result Head(const std::string &path);
  2637. Result Head(const std::string &path, const Headers &headers);
  2638. Result Post(const std::string &path);
  2639. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2640. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2641. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2642. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2643. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2644. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2645. Result Post(const std::string &path, const Params &params);
  2646. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2647. Result Post(const std::string &path, const Headers &headers);
  2648. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2649. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2650. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2651. 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);
  2652. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2653. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2654. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2655. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2656. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2657. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2658. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2659. Result Put(const std::string &path);
  2660. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2661. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2662. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2663. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2664. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2665. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2666. Result Put(const std::string &path, const Params &params);
  2667. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2668. Result Put(const std::string &path, const Headers &headers);
  2669. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2670. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2671. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2672. 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);
  2673. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2674. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2675. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2676. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2677. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2678. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2679. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2680. Result Patch(const std::string &path);
  2681. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2682. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2683. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2684. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2685. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2686. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2687. Result Patch(const std::string &path, const Params &params);
  2688. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2689. Result Patch(const std::string &path, const Headers &headers);
  2690. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2691. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2692. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2693. 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);
  2694. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2695. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2696. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2697. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2698. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2699. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2700. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2701. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2702. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2703. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2704. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2705. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2706. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2707. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2708. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2709. Result Options(const std::string &path);
  2710. Result Options(const std::string &path, const Headers &headers);
  2711. // clang-format on
  2712. // Streaming API: Open a stream for reading response body incrementally
  2713. // Socket ownership is transferred to StreamHandle for true streaming
  2714. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2715. ClientImpl::StreamHandle open_stream(const std::string &method,
  2716. const std::string &path,
  2717. const Params &params = {},
  2718. const Headers &headers = {},
  2719. const std::string &body = {},
  2720. const std::string &content_type = {});
  2721. bool send(Request &req, Response &res, Error &error);
  2722. Result send(const Request &req);
  2723. void stop();
  2724. std::string host() const;
  2725. int port() const;
  2726. size_t is_socket_open() const;
  2727. socket_t socket() const;
  2728. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2729. void set_default_headers(Headers headers);
  2730. void
  2731. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2732. void set_address_family(int family);
  2733. void set_tcp_nodelay(bool on);
  2734. void set_socket_options(SocketOptions socket_options);
  2735. void set_connection_timeout(time_t sec, time_t usec = 0);
  2736. template <class Rep, class Period>
  2737. void
  2738. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2739. void set_read_timeout(time_t sec, time_t usec = 0);
  2740. template <class Rep, class Period>
  2741. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2742. void set_write_timeout(time_t sec, time_t usec = 0);
  2743. template <class Rep, class Period>
  2744. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2745. void set_max_timeout(time_t msec);
  2746. template <class Rep, class Period>
  2747. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2748. void set_basic_auth(const std::string &username, const std::string &password);
  2749. void set_bearer_token_auth(const std::string &token);
  2750. void set_keep_alive(bool on);
  2751. void set_follow_location(bool on);
  2752. void set_path_encode(bool on);
  2753. void set_compress(bool on);
  2754. void set_decompress(bool on);
  2755. void set_payload_max_length(size_t length);
  2756. void set_interface(const std::string &intf);
  2757. void set_proxy(const std::string &host, int port);
  2758. void set_proxy_basic_auth(const std::string &username,
  2759. const std::string &password);
  2760. void set_proxy_bearer_token_auth(const std::string &token);
  2761. void set_no_proxy(const std::vector<std::string> &patterns);
  2762. void set_logger(Logger logger);
  2763. void set_error_logger(ErrorLogger error_logger);
  2764. private:
  2765. std::unique_ptr<ClientImpl> cli_;
  2766. #ifdef CPPHTTPLIB_SSL_ENABLED
  2767. public:
  2768. void set_digest_auth(const std::string &username,
  2769. const std::string &password);
  2770. void set_proxy_digest_auth(const std::string &username,
  2771. const std::string &password);
  2772. void enable_server_certificate_verification(bool enabled);
  2773. void enable_server_hostname_verification(bool enabled);
  2774. void enable_system_ca(bool enabled);
  2775. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2776. const std::string &ca_cert_dir_path = std::string());
  2777. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2778. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2779. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2780. void set_session_verifier(
  2781. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2782. tls::ctx_t tls_context() const;
  2783. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2784. void enable_windows_certificate_verification(bool enabled);
  2785. #endif
  2786. private:
  2787. bool is_ssl_ = false;
  2788. #endif
  2789. };
  2790. #ifdef CPPHTTPLIB_SSL_ENABLED
  2791. class SSLServer : public Server {
  2792. public:
  2793. SSLServer(const char *cert_path, const char *private_key_path,
  2794. const char *client_ca_cert_file_path = nullptr,
  2795. const char *client_ca_cert_dir_path = nullptr,
  2796. const char *private_key_password = nullptr);
  2797. struct PemMemory {
  2798. const char *cert_pem;
  2799. size_t cert_pem_len;
  2800. const char *key_pem;
  2801. size_t key_pem_len;
  2802. const char *client_ca_pem;
  2803. size_t client_ca_pem_len;
  2804. const char *private_key_password;
  2805. };
  2806. explicit SSLServer(const PemMemory &pem);
  2807. // The callback receives the ctx_t handle which can be cast to the
  2808. // appropriate backend type (SSL_CTX* for OpenSSL,
  2809. // tls::impl::MbedTlsContext* for Mbed TLS)
  2810. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2811. ~SSLServer() override;
  2812. bool is_valid() const override;
  2813. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2814. const char *client_ca_pem = nullptr,
  2815. const char *password = nullptr);
  2816. tls::ctx_t tls_context() const { return ctx_; }
  2817. int ssl_last_error() const { return last_ssl_error_; }
  2818. private:
  2819. bool process_and_close_socket(socket_t sock) override;
  2820. tls::ctx_t ctx_ = nullptr;
  2821. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2822. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2823. // bounds, and new ones wait while it is pending so that they cannot keep it
  2824. // waiting.
  2825. std::mutex ctx_mutex_;
  2826. std::condition_variable ctx_cv_;
  2827. size_t handshakes_in_progress_ = 0;
  2828. size_t updates_pending_ = 0;
  2829. int last_ssl_error_ = 0;
  2830. };
  2831. class SSLClient final : public ClientImpl {
  2832. public:
  2833. explicit SSLClient(const std::string &host);
  2834. explicit SSLClient(const std::string &host, int port);
  2835. explicit SSLClient(const std::string &host, int port,
  2836. const std::string &client_cert_path,
  2837. const std::string &client_key_path,
  2838. const std::string &private_key_password = std::string());
  2839. struct PemMemory {
  2840. const char *cert_pem;
  2841. size_t cert_pem_len;
  2842. const char *key_pem;
  2843. size_t key_pem_len;
  2844. const char *private_key_password;
  2845. };
  2846. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2847. ~SSLClient() override;
  2848. bool is_valid() const override;
  2849. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2850. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2851. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2852. // Post-handshake session verifier (backend-independent)
  2853. void set_session_verifier(
  2854. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2855. tls::ctx_t tls_context() const { return ctx_; }
  2856. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2857. void enable_windows_certificate_verification(bool enabled);
  2858. #endif
  2859. private:
  2860. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2861. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2862. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2863. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2864. bool
  2865. process_socket(const Socket &socket,
  2866. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2867. std::function<bool(Stream &strm)> callback) override;
  2868. bool is_ssl() const override;
  2869. bool setup_proxy_connection(
  2870. Socket &socket,
  2871. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2872. Response &res, bool &success, Error &error) override;
  2873. bool connect_with_proxy(
  2874. Socket &sock,
  2875. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2876. Response &res, bool &success, Error &error);
  2877. bool initialize_ssl(Socket &socket, Error &error);
  2878. void init_ctx();
  2879. void reset_ctx_on_error();
  2880. bool load_certs();
  2881. tls::ctx_t ctx_ = nullptr;
  2882. std::mutex ctx_mutex_;
  2883. std::once_flag initialize_cert_;
  2884. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2885. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2886. // Used to keep custom CA configuration exclusive with system CA loading.
  2887. bool ca_cert_store_set_ = false;
  2888. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2889. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2890. // set_server_certificate_verifier() installed there.
  2891. tls::VerifyCallback server_certificate_verifier_;
  2892. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2893. bool enable_windows_cert_verification_ = true;
  2894. #endif
  2895. friend class ClientImpl;
  2896. };
  2897. #endif // CPPHTTPLIB_SSL_ENABLED
  2898. namespace detail {
  2899. template <typename T, typename U>
  2900. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2901. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2902. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2903. duration - std::chrono::seconds(sec))
  2904. .count();
  2905. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2906. }
  2907. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2908. return N - 1;
  2909. }
  2910. inline bool is_numeric(const std::string &str) {
  2911. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2912. }
  2913. // std::ranges::next(first, n, last) for C++11
  2914. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2915. for (; n > 0 && first != last; --n) {
  2916. ++first;
  2917. }
  2918. return first;
  2919. }
  2920. inline size_t get_header_value_u64(const Headers &headers,
  2921. const std::string &key, size_t def,
  2922. size_t id, bool &is_invalid_value) {
  2923. is_invalid_value = false;
  2924. auto rng = headers.equal_range(key);
  2925. auto it = bounded_next(rng.first, id, rng.second);
  2926. if (it != rng.second) {
  2927. if (is_numeric(it->second)) {
  2928. // Parse at size_t width so an out-of-range Content-Length is reported
  2929. // rather than silently saturated/truncated (a value above 2^32 would
  2930. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2931. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2932. size_t val = 0;
  2933. const auto &s = it->second;
  2934. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2935. if (r.ec == std::errc::result_out_of_range) {
  2936. is_invalid_value = true;
  2937. return (std::numeric_limits<size_t>::max)();
  2938. }
  2939. return val;
  2940. } else {
  2941. is_invalid_value = true;
  2942. }
  2943. }
  2944. return def;
  2945. }
  2946. inline size_t get_header_value_u64(const Headers &headers,
  2947. const std::string &key, size_t def,
  2948. size_t id) {
  2949. auto dummy = false;
  2950. return get_header_value_u64(headers, key, def, id, dummy);
  2951. }
  2952. } // namespace detail
  2953. template <class Rep, class Period>
  2954. inline Server &
  2955. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2956. detail::duration_to_sec_and_usec(
  2957. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2958. return *this;
  2959. }
  2960. template <class Rep, class Period>
  2961. inline Server &
  2962. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2963. detail::duration_to_sec_and_usec(
  2964. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2965. return *this;
  2966. }
  2967. template <class Rep, class Period>
  2968. inline Server &
  2969. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2970. detail::duration_to_sec_and_usec(
  2971. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2972. return *this;
  2973. }
  2974. template <class Rep, class Period>
  2975. inline void ClientImpl::set_connection_timeout(
  2976. const std::chrono::duration<Rep, Period> &duration) {
  2977. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2978. set_connection_timeout(sec, usec);
  2979. });
  2980. }
  2981. template <class Rep, class Period>
  2982. inline void ClientImpl::set_read_timeout(
  2983. const std::chrono::duration<Rep, Period> &duration) {
  2984. detail::duration_to_sec_and_usec(
  2985. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2986. }
  2987. template <class Rep, class Period>
  2988. inline void ClientImpl::set_write_timeout(
  2989. const std::chrono::duration<Rep, Period> &duration) {
  2990. detail::duration_to_sec_and_usec(
  2991. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2992. }
  2993. template <class Rep, class Period>
  2994. inline void ClientImpl::set_max_timeout(
  2995. const std::chrono::duration<Rep, Period> &duration) {
  2996. auto msec =
  2997. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2998. set_max_timeout(msec);
  2999. }
  3000. template <class Rep, class Period>
  3001. inline void Client::set_connection_timeout(
  3002. const std::chrono::duration<Rep, Period> &duration) {
  3003. cli_->set_connection_timeout(duration);
  3004. }
  3005. template <class Rep, class Period>
  3006. inline void
  3007. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3008. cli_->set_read_timeout(duration);
  3009. }
  3010. template <class Rep, class Period>
  3011. inline void
  3012. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3013. cli_->set_write_timeout(duration);
  3014. }
  3015. inline void Client::set_max_timeout(time_t msec) {
  3016. cli_->set_max_timeout(msec);
  3017. }
  3018. template <class Rep, class Period>
  3019. inline void
  3020. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3021. cli_->set_max_timeout(duration);
  3022. }
  3023. /*
  3024. * Forward declarations and types that will be part of the .h file if split into
  3025. * .h + .cc.
  3026. */
  3027. std::string hosted_at(const std::string &hostname);
  3028. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3029. // JavaScript-style URL encoding/decoding functions
  3030. std::string encode_uri_component(const std::string &value);
  3031. std::string encode_uri(const std::string &value);
  3032. std::string decode_uri_component(const std::string &value);
  3033. std::string decode_uri(const std::string &value);
  3034. // RFC 3986 compliant URL component encoding/decoding functions
  3035. std::string encode_path_component(const std::string &component);
  3036. std::string decode_path_component(const std::string &component);
  3037. std::string encode_query_component(const std::string &component,
  3038. bool space_as_plus = true);
  3039. std::string decode_query_component(const std::string &component,
  3040. bool plus_as_space = true);
  3041. std::string sanitize_filename(const std::string &filename);
  3042. std::string append_query_params(const std::string &path, const Params &params);
  3043. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3044. std::pair<std::string, std::string>
  3045. make_basic_authentication_header(const std::string &username,
  3046. const std::string &password,
  3047. bool is_proxy = false);
  3048. namespace detail {
  3049. #if defined(_WIN32)
  3050. inline std::wstring u8string_to_wstring(const char *s) {
  3051. if (!s) { return std::wstring(); }
  3052. auto len = static_cast<int>(strlen(s));
  3053. if (!len) { return std::wstring(); }
  3054. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3055. if (!wlen) { return std::wstring(); }
  3056. std::wstring ws;
  3057. ws.resize(wlen);
  3058. wlen = ::MultiByteToWideChar(
  3059. CP_UTF8, 0, s, len,
  3060. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3061. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3062. return ws;
  3063. }
  3064. #endif
  3065. struct FileStat {
  3066. FileStat(const std::string &path);
  3067. bool is_file() const;
  3068. bool is_dir() const;
  3069. time_t mtime() const;
  3070. size_t size() const;
  3071. private:
  3072. #if defined(_WIN32)
  3073. struct _stat st_;
  3074. #else
  3075. struct stat st_;
  3076. #endif
  3077. int ret_ = -1;
  3078. };
  3079. std::string make_host_and_port_string(const std::string &host, int port,
  3080. bool is_ssl);
  3081. template <typename T>
  3082. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3083. Error &error);
  3084. std::string trim_copy(const std::string &s);
  3085. void divide(
  3086. const char *data, std::size_t size, char d,
  3087. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3088. fn);
  3089. void divide(
  3090. const std::string &str, char d,
  3091. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3092. fn);
  3093. void split(const char *b, const char *e, char d,
  3094. std::function<void(const char *, const char *)> fn);
  3095. void split(const char *b, const char *e, char d, size_t m,
  3096. std::function<void(const char *, const char *)> fn);
  3097. bool split_find(const char *b, const char *e, char d,
  3098. std::function<bool(const char *, const char *)> fn);
  3099. bool has_header_token(const Headers &headers, const std::string &key,
  3100. const std::string &token);
  3101. std::string websocket_accept_key(const std::string &client_key);
  3102. bool is_websocket_upgrade(const Request &req);
  3103. bool process_client_socket(
  3104. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3105. time_t write_timeout_sec, time_t write_timeout_usec,
  3106. time_t max_timeout_msec,
  3107. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3108. std::function<bool(Stream &)> callback);
  3109. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3110. int port, int address_family, bool tcp_nodelay,
  3111. bool ipv6_v6only, SocketOptions socket_options,
  3112. time_t connection_timeout_sec,
  3113. time_t connection_timeout_usec,
  3114. time_t read_timeout_sec, time_t read_timeout_usec,
  3115. time_t write_timeout_sec,
  3116. time_t write_timeout_usec,
  3117. const std::string &intf, Error &error);
  3118. const char *get_header_value(const Headers &headers, const std::string &key,
  3119. const char *def, size_t id);
  3120. std::string get_combined_header_value(const Headers &headers,
  3121. const std::string &key);
  3122. std::string params_to_query_str(const Params &params);
  3123. void parse_query_text(const char *data, std::size_t size, Params &params);
  3124. void parse_query_text(const std::string &s, Params &params);
  3125. bool parse_multipart_boundary(const std::string &content_type,
  3126. std::string &boundary);
  3127. bool parse_range_header(const std::string &s, Ranges &ranges);
  3128. bool parse_accept_header(const std::string &s,
  3129. std::vector<std::string> &content_types);
  3130. void parse_disposition_params(const std::string &s, Params &params);
  3131. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3132. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3133. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3134. EncodingType encoding_type(const Request &req, const Response &res,
  3135. const std::string &content_type);
  3136. EncodingType encoding_type(const Request &req, const Response &res);
  3137. class BufferStream final : public Stream {
  3138. public:
  3139. BufferStream() = default;
  3140. ~BufferStream() override = default;
  3141. bool is_readable() const override;
  3142. bool wait_readable() const override;
  3143. bool wait_writable() const override;
  3144. ssize_t read(char *ptr, size_t size) override;
  3145. ssize_t write(const char *ptr, size_t size) override;
  3146. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3147. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3148. socket_t socket() const override;
  3149. time_t duration() const override;
  3150. const std::string &get_buffer() const;
  3151. private:
  3152. std::string buffer;
  3153. size_t position = 0;
  3154. };
  3155. class compressor {
  3156. public:
  3157. virtual ~compressor() = default;
  3158. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3159. virtual bool compress(const char *data, size_t data_length, bool last,
  3160. Callback callback) = 0;
  3161. };
  3162. class decompressor {
  3163. public:
  3164. virtual ~decompressor() = default;
  3165. virtual bool is_valid() const = 0;
  3166. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3167. virtual bool decompress(const char *data, size_t data_length,
  3168. Callback callback) = 0;
  3169. };
  3170. class nocompressor final : public compressor {
  3171. public:
  3172. ~nocompressor() override = default;
  3173. bool compress(const char *data, size_t data_length, bool /*last*/,
  3174. Callback callback) override;
  3175. };
  3176. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3177. class gzip_compressor final : public compressor {
  3178. public:
  3179. gzip_compressor();
  3180. ~gzip_compressor() override;
  3181. bool compress(const char *data, size_t data_length, bool last,
  3182. Callback callback) override;
  3183. private:
  3184. bool is_valid_ = false;
  3185. z_stream strm_;
  3186. };
  3187. class gzip_decompressor final : public decompressor {
  3188. public:
  3189. gzip_decompressor();
  3190. ~gzip_decompressor() override;
  3191. bool is_valid() const override;
  3192. bool decompress(const char *data, size_t data_length,
  3193. Callback callback) override;
  3194. private:
  3195. bool is_valid_ = false;
  3196. z_stream strm_;
  3197. };
  3198. #endif
  3199. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3200. class brotli_compressor final : public compressor {
  3201. public:
  3202. brotli_compressor();
  3203. ~brotli_compressor();
  3204. bool compress(const char *data, size_t data_length, bool last,
  3205. Callback callback) override;
  3206. private:
  3207. BrotliEncoderState *state_ = nullptr;
  3208. };
  3209. class brotli_decompressor final : public decompressor {
  3210. public:
  3211. brotli_decompressor();
  3212. ~brotli_decompressor();
  3213. bool is_valid() const override;
  3214. bool decompress(const char *data, size_t data_length,
  3215. Callback callback) override;
  3216. private:
  3217. BrotliDecoderResult decoder_r;
  3218. BrotliDecoderState *decoder_s = nullptr;
  3219. };
  3220. #endif
  3221. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3222. class zstd_compressor : public compressor {
  3223. public:
  3224. zstd_compressor();
  3225. ~zstd_compressor();
  3226. bool compress(const char *data, size_t data_length, bool last,
  3227. Callback callback) override;
  3228. private:
  3229. ZSTD_CCtx *ctx_ = nullptr;
  3230. };
  3231. class zstd_decompressor : public decompressor {
  3232. public:
  3233. zstd_decompressor();
  3234. ~zstd_decompressor();
  3235. bool is_valid() const override;
  3236. bool decompress(const char *data, size_t data_length,
  3237. Callback callback) override;
  3238. private:
  3239. ZSTD_DCtx *ctx_ = nullptr;
  3240. };
  3241. #endif
  3242. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3243. // to store data. The call can set memory on stack for performance.
  3244. class stream_line_reader {
  3245. public:
  3246. stream_line_reader(Stream &strm, char *fixed_buffer,
  3247. size_t fixed_buffer_size);
  3248. const char *ptr() const;
  3249. size_t size() const;
  3250. bool end_with_crlf() const;
  3251. bool getline();
  3252. private:
  3253. void append(char c);
  3254. void append(const char *data, size_t size);
  3255. Stream &strm_;
  3256. char *fixed_buffer_;
  3257. const size_t fixed_buffer_size_;
  3258. size_t fixed_buffer_used_size_ = 0;
  3259. std::string growable_buffer_;
  3260. };
  3261. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3262. const Headers &src_headers);
  3263. struct ChunkedDecoder {
  3264. Stream &strm;
  3265. size_t chunk_remaining = 0;
  3266. bool finished = false;
  3267. char line_buf[64];
  3268. size_t last_chunk_total = 0;
  3269. size_t last_chunk_offset = 0;
  3270. explicit ChunkedDecoder(Stream &s);
  3271. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3272. size_t &out_chunk_total);
  3273. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3274. };
  3275. class mmap {
  3276. public:
  3277. mmap(const char *path);
  3278. ~mmap();
  3279. bool open(const char *path);
  3280. void close();
  3281. bool is_open() const;
  3282. size_t size() const;
  3283. const char *data() const;
  3284. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3285. // down to 0, if the file has shrunk since it was opened, where reading
  3286. // data() would raise SIGBUS.
  3287. size_t read(size_t offset, char *buf, size_t len) const;
  3288. private:
  3289. #if defined(_WIN32)
  3290. HANDLE hFile_ = NULL;
  3291. HANDLE hMapping_ = NULL;
  3292. #else
  3293. int fd_ = -1;
  3294. #endif
  3295. size_t size_ = 0;
  3296. void *addr_ = nullptr;
  3297. bool is_open_empty_file = false;
  3298. };
  3299. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3300. namespace fields {
  3301. bool is_token_char(char c);
  3302. bool is_token(const std::string &s);
  3303. bool is_field_name(const std::string &s);
  3304. bool is_vchar(char c);
  3305. bool is_obs_text(char c);
  3306. bool is_field_vchar(char c);
  3307. bool is_field_content(const std::string &s);
  3308. bool is_field_value(const std::string &s);
  3309. bool is_field_valid(const std::string &name, const std::string &value);
  3310. bool is_request_target(const std::string &s);
  3311. bool is_host(const std::string &s);
  3312. } // namespace fields
  3313. } // namespace detail
  3314. /*
  3315. * TLS Abstraction Layer Declarations
  3316. */
  3317. #ifdef CPPHTTPLIB_SSL_ENABLED
  3318. // TLS abstraction layer - backend-specific type declarations
  3319. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3320. namespace tls {
  3321. namespace impl {
  3322. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3323. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3324. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3325. struct MbedTlsContext {
  3326. mbedtls_ssl_config conf;
  3327. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3328. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3329. mbedtls_entropy_context entropy;
  3330. mbedtls_ctr_drbg_context ctr_drbg;
  3331. #endif
  3332. mbedtls_x509_crt ca_chain;
  3333. mbedtls_x509_crt own_cert;
  3334. mbedtls_pk_context own_key;
  3335. bool is_server = false;
  3336. bool verify_client = false;
  3337. VerifyCallback verify_callback;
  3338. MbedTlsContext();
  3339. ~MbedTlsContext();
  3340. MbedTlsContext(const MbedTlsContext &) = delete;
  3341. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3342. };
  3343. } // namespace impl
  3344. } // namespace tls
  3345. #endif
  3346. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3347. namespace tls {
  3348. namespace impl {
  3349. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3350. // This struct is accessible via tls::impl for use in SSL context
  3351. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3352. struct WolfSSLContext {
  3353. WOLFSSL_CTX *ctx = nullptr;
  3354. bool is_server = false;
  3355. bool verify_client = false;
  3356. VerifyCallback verify_callback;
  3357. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3358. WolfSSLContext();
  3359. ~WolfSSLContext();
  3360. WolfSSLContext(const WolfSSLContext &) = delete;
  3361. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3362. };
  3363. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3364. struct WolfSSLCAStore {
  3365. std::string pem_data;
  3366. };
  3367. } // namespace impl
  3368. } // namespace tls
  3369. #endif
  3370. #endif // CPPHTTPLIB_SSL_ENABLED
  3371. namespace stream {
  3372. class Result {
  3373. public:
  3374. Result();
  3375. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3376. Result(Result &&other) noexcept;
  3377. Result &operator=(Result &&other) noexcept;
  3378. Result(const Result &) = delete;
  3379. Result &operator=(const Result &) = delete;
  3380. // Response info
  3381. bool is_valid() const;
  3382. explicit operator bool() const;
  3383. int status() const;
  3384. const Headers &headers() const;
  3385. std::string get_header_value(const std::string &key,
  3386. const char *def = "") const;
  3387. bool has_header(const std::string &key) const;
  3388. Error error() const;
  3389. Error read_error() const;
  3390. bool has_read_error() const;
  3391. // Stream reading
  3392. bool next();
  3393. const char *data() const;
  3394. size_t size() const;
  3395. std::string read_all();
  3396. private:
  3397. ClientImpl::StreamHandle handle_;
  3398. std::string buffer_;
  3399. size_t current_size_ = 0;
  3400. size_t chunk_size_;
  3401. bool finished_ = false;
  3402. };
  3403. // GET
  3404. template <typename ClientType>
  3405. inline Result Get(ClientType &cli, const std::string &path,
  3406. size_t chunk_size = 8192) {
  3407. return Result{cli.open_stream("GET", path), chunk_size};
  3408. }
  3409. template <typename ClientType>
  3410. inline Result Get(ClientType &cli, const std::string &path,
  3411. const Headers &headers, size_t chunk_size = 8192) {
  3412. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3413. }
  3414. template <typename ClientType>
  3415. inline Result Get(ClientType &cli, const std::string &path,
  3416. const Params &params, size_t chunk_size = 8192) {
  3417. return Result{cli.open_stream("GET", path, params), chunk_size};
  3418. }
  3419. template <typename ClientType>
  3420. inline Result Get(ClientType &cli, const std::string &path,
  3421. const Params &params, const Headers &headers,
  3422. size_t chunk_size = 8192) {
  3423. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3424. }
  3425. // POST
  3426. template <typename ClientType>
  3427. inline Result Post(ClientType &cli, const std::string &path,
  3428. const std::string &body, const std::string &content_type,
  3429. size_t chunk_size = 8192) {
  3430. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3431. chunk_size};
  3432. }
  3433. template <typename ClientType>
  3434. inline Result Post(ClientType &cli, const std::string &path,
  3435. const Headers &headers, const std::string &body,
  3436. const std::string &content_type, size_t chunk_size = 8192) {
  3437. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3438. chunk_size};
  3439. }
  3440. template <typename ClientType>
  3441. inline Result Post(ClientType &cli, const std::string &path,
  3442. const Params &params, const std::string &body,
  3443. const std::string &content_type, size_t chunk_size = 8192) {
  3444. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3445. chunk_size};
  3446. }
  3447. template <typename ClientType>
  3448. inline Result Post(ClientType &cli, const std::string &path,
  3449. const Params &params, const Headers &headers,
  3450. const std::string &body, const std::string &content_type,
  3451. size_t chunk_size = 8192) {
  3452. return Result{
  3453. cli.open_stream("POST", path, params, headers, body, content_type),
  3454. chunk_size};
  3455. }
  3456. // PUT
  3457. template <typename ClientType>
  3458. inline Result Put(ClientType &cli, const std::string &path,
  3459. const std::string &body, const std::string &content_type,
  3460. size_t chunk_size = 8192) {
  3461. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3462. chunk_size};
  3463. }
  3464. template <typename ClientType>
  3465. inline Result Put(ClientType &cli, const std::string &path,
  3466. const Headers &headers, const std::string &body,
  3467. const std::string &content_type, size_t chunk_size = 8192) {
  3468. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3469. chunk_size};
  3470. }
  3471. template <typename ClientType>
  3472. inline Result Put(ClientType &cli, const std::string &path,
  3473. const Params &params, const std::string &body,
  3474. const std::string &content_type, size_t chunk_size = 8192) {
  3475. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3476. chunk_size};
  3477. }
  3478. template <typename ClientType>
  3479. inline Result Put(ClientType &cli, const std::string &path,
  3480. const Params &params, const Headers &headers,
  3481. const std::string &body, const std::string &content_type,
  3482. size_t chunk_size = 8192) {
  3483. return Result{
  3484. cli.open_stream("PUT", path, params, headers, body, content_type),
  3485. chunk_size};
  3486. }
  3487. // PATCH
  3488. template <typename ClientType>
  3489. inline Result Patch(ClientType &cli, const std::string &path,
  3490. const std::string &body, const std::string &content_type,
  3491. size_t chunk_size = 8192) {
  3492. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3493. chunk_size};
  3494. }
  3495. template <typename ClientType>
  3496. inline Result Patch(ClientType &cli, const std::string &path,
  3497. const Headers &headers, const std::string &body,
  3498. const std::string &content_type, size_t chunk_size = 8192) {
  3499. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3500. chunk_size};
  3501. }
  3502. template <typename ClientType>
  3503. inline Result Patch(ClientType &cli, const std::string &path,
  3504. const Params &params, const std::string &body,
  3505. const std::string &content_type, size_t chunk_size = 8192) {
  3506. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3507. chunk_size};
  3508. }
  3509. template <typename ClientType>
  3510. inline Result Patch(ClientType &cli, const std::string &path,
  3511. const Params &params, const Headers &headers,
  3512. const std::string &body, const std::string &content_type,
  3513. size_t chunk_size = 8192) {
  3514. return Result{
  3515. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3516. chunk_size};
  3517. }
  3518. // DELETE
  3519. template <typename ClientType>
  3520. inline Result Delete(ClientType &cli, const std::string &path,
  3521. size_t chunk_size = 8192) {
  3522. return Result{cli.open_stream("DELETE", path), chunk_size};
  3523. }
  3524. template <typename ClientType>
  3525. inline Result Delete(ClientType &cli, const std::string &path,
  3526. const Headers &headers, size_t chunk_size = 8192) {
  3527. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3528. }
  3529. template <typename ClientType>
  3530. inline Result Delete(ClientType &cli, const std::string &path,
  3531. const std::string &body, const std::string &content_type,
  3532. size_t chunk_size = 8192) {
  3533. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3534. chunk_size};
  3535. }
  3536. template <typename ClientType>
  3537. inline Result Delete(ClientType &cli, const std::string &path,
  3538. const Headers &headers, const std::string &body,
  3539. const std::string &content_type,
  3540. size_t chunk_size = 8192) {
  3541. return Result{
  3542. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3543. chunk_size};
  3544. }
  3545. template <typename ClientType>
  3546. inline Result Delete(ClientType &cli, const std::string &path,
  3547. const Params &params, size_t chunk_size = 8192) {
  3548. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3549. }
  3550. template <typename ClientType>
  3551. inline Result Delete(ClientType &cli, const std::string &path,
  3552. const Params &params, const Headers &headers,
  3553. size_t chunk_size = 8192) {
  3554. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3555. }
  3556. template <typename ClientType>
  3557. inline Result Delete(ClientType &cli, const std::string &path,
  3558. const Params &params, const std::string &body,
  3559. const std::string &content_type,
  3560. size_t chunk_size = 8192) {
  3561. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3562. chunk_size};
  3563. }
  3564. template <typename ClientType>
  3565. inline Result Delete(ClientType &cli, const std::string &path,
  3566. const Params &params, const Headers &headers,
  3567. const std::string &body, const std::string &content_type,
  3568. size_t chunk_size = 8192) {
  3569. return Result{
  3570. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3571. chunk_size};
  3572. }
  3573. // HEAD
  3574. template <typename ClientType>
  3575. inline Result Head(ClientType &cli, const std::string &path,
  3576. size_t chunk_size = 8192) {
  3577. return Result{cli.open_stream("HEAD", path), chunk_size};
  3578. }
  3579. template <typename ClientType>
  3580. inline Result Head(ClientType &cli, const std::string &path,
  3581. const Headers &headers, size_t chunk_size = 8192) {
  3582. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3583. }
  3584. template <typename ClientType>
  3585. inline Result Head(ClientType &cli, const std::string &path,
  3586. const Params &params, size_t chunk_size = 8192) {
  3587. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3588. }
  3589. template <typename ClientType>
  3590. inline Result Head(ClientType &cli, const std::string &path,
  3591. const Params &params, const Headers &headers,
  3592. size_t chunk_size = 8192) {
  3593. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3594. }
  3595. // OPTIONS
  3596. template <typename ClientType>
  3597. inline Result Options(ClientType &cli, const std::string &path,
  3598. size_t chunk_size = 8192) {
  3599. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3600. }
  3601. template <typename ClientType>
  3602. inline Result Options(ClientType &cli, const std::string &path,
  3603. const Headers &headers, size_t chunk_size = 8192) {
  3604. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3605. }
  3606. template <typename ClientType>
  3607. inline Result Options(ClientType &cli, const std::string &path,
  3608. const Params &params, size_t chunk_size = 8192) {
  3609. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3610. }
  3611. template <typename ClientType>
  3612. inline Result Options(ClientType &cli, const std::string &path,
  3613. const Params &params, const Headers &headers,
  3614. size_t chunk_size = 8192) {
  3615. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3616. }
  3617. } // namespace stream
  3618. namespace sse {
  3619. struct SSEMessage {
  3620. std::string event; // Event type (default: "message")
  3621. std::string data; // Event payload
  3622. std::string id; // Event ID for Last-Event-ID header
  3623. SSEMessage();
  3624. void clear();
  3625. };
  3626. class SSEClient {
  3627. public:
  3628. using MessageHandler = std::function<void(const SSEMessage &)>;
  3629. using ErrorHandler = std::function<void(Error)>;
  3630. using OpenHandler = std::function<void()>;
  3631. SSEClient(Client &client, const std::string &path);
  3632. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3633. ~SSEClient();
  3634. SSEClient(const SSEClient &) = delete;
  3635. SSEClient &operator=(const SSEClient &) = delete;
  3636. // Event handlers
  3637. SSEClient &on_message(MessageHandler handler);
  3638. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3639. SSEClient &on_open(OpenHandler handler);
  3640. SSEClient &on_error(ErrorHandler handler);
  3641. SSEClient &set_reconnect_interval(int ms);
  3642. SSEClient &set_max_reconnect_attempts(int n);
  3643. // Update headers (thread-safe)
  3644. SSEClient &set_headers(const Headers &headers);
  3645. // State accessors
  3646. bool is_connected() const;
  3647. const std::string &last_event_id() const;
  3648. // Blocking start - runs event loop with auto-reconnect
  3649. void start();
  3650. // Non-blocking start - runs in background thread
  3651. void start_async();
  3652. // Stop the client (thread-safe)
  3653. void stop();
  3654. private:
  3655. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3656. bool &has_data, bool &has_id);
  3657. void run_event_loop();
  3658. void dispatch_event(const SSEMessage &msg);
  3659. bool should_reconnect(int count) const;
  3660. void wait_for_reconnect();
  3661. // Client and path
  3662. Client &client_;
  3663. std::string path_;
  3664. Headers headers_;
  3665. mutable std::mutex headers_mutex_;
  3666. // Callbacks
  3667. MessageHandler on_message_;
  3668. std::map<std::string, MessageHandler> event_handlers_;
  3669. OpenHandler on_open_;
  3670. ErrorHandler on_error_;
  3671. // Configuration
  3672. int reconnect_interval_ms_ = 3000;
  3673. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3674. // State
  3675. std::atomic<bool> running_{false};
  3676. std::atomic<bool> connected_{false};
  3677. std::string last_event_id_;
  3678. // Async support
  3679. std::thread async_thread_;
  3680. };
  3681. } // namespace sse
  3682. namespace ws {
  3683. class WebSocketClient;
  3684. enum class Opcode : uint8_t {
  3685. Continuation = 0x0,
  3686. Text = 0x1,
  3687. Binary = 0x2,
  3688. Close = 0x8,
  3689. Ping = 0x9,
  3690. Pong = 0xA,
  3691. };
  3692. enum class CloseStatus : uint16_t {
  3693. Normal = 1000,
  3694. GoingAway = 1001,
  3695. ProtocolError = 1002,
  3696. UnsupportedData = 1003,
  3697. NoStatus = 1005,
  3698. Abnormal = 1006,
  3699. InvalidPayload = 1007,
  3700. PolicyViolation = 1008,
  3701. MessageTooBig = 1009,
  3702. MandatoryExtension = 1010,
  3703. InternalError = 1011,
  3704. };
  3705. // Timeout is returned only when a read timeout was set and it elapsed before
  3706. // any byte of a frame arrived: nothing was consumed and the connection is
  3707. // still open, so the caller can send on it and read again. `msg` is left
  3708. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3709. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3710. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3711. // upgrade handshake fully succeeded. On failure error() identifies the
  3712. // failing layer; status()/headers() expose the server's upgrade response
  3713. // when one was received (status() is -1 otherwise).
  3714. class Result {
  3715. public:
  3716. Result() = default;
  3717. Result(Error err, int status, Headers &&headers)
  3718. : err_(err), status_(status), headers_(std::move(headers)) {}
  3719. explicit operator bool() const { return err_ == Error::Success; }
  3720. Error error() const { return err_; }
  3721. // Upgrade response info
  3722. int status() const { return status_; }
  3723. const Headers &headers() const { return headers_; }
  3724. std::string get_header_value(const std::string &key,
  3725. const char *def = "") const {
  3726. return detail::get_header_value(headers_, key, def, 0);
  3727. }
  3728. bool has_header(const std::string &key) const {
  3729. return headers_.find(key) != headers_.end();
  3730. }
  3731. #ifdef CPPHTTPLIB_SSL_ENABLED
  3732. Result(Error err, int status, Headers &&headers, int ssl_error,
  3733. uint64_t ssl_backend_error)
  3734. : err_(err), status_(status), headers_(std::move(headers)),
  3735. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3736. int ssl_error() const { return ssl_error_; }
  3737. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3738. #endif
  3739. private:
  3740. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3741. int status_ = -1;
  3742. Headers headers_;
  3743. #ifdef CPPHTTPLIB_SSL_ENABLED
  3744. int ssl_error_ = 0;
  3745. uint64_t ssl_backend_error_ = 0;
  3746. #endif
  3747. };
  3748. class WebSocket {
  3749. public:
  3750. WebSocket(const WebSocket &) = delete;
  3751. WebSocket &operator=(const WebSocket &) = delete;
  3752. ~WebSocket();
  3753. ReadResult read(std::string &msg);
  3754. bool send(const std::string &data);
  3755. bool send(const char *data, size_t len);
  3756. void close(CloseStatus status = CloseStatus::Normal,
  3757. const std::string &reason = "");
  3758. const Request &request() const;
  3759. bool is_open() const;
  3760. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3761. // A server handler owns its connection's timeout this way; a client sets it
  3762. // through WebSocketClient. Safe to call while another thread is in read().
  3763. //
  3764. // Only a timeout set here is reported as Timeout. The compile-time default
  3765. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3766. // than a request for control, so when it elapses read() returns Fail and
  3767. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3768. void set_read_timeout(time_t sec, time_t usec = 0);
  3769. template <class Rep, class Period>
  3770. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3771. private:
  3772. friend class httplib::Server;
  3773. friend class httplib::ws::WebSocketClient;
  3774. WebSocket(
  3775. Stream &strm, const Request &req, bool is_server,
  3776. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3777. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3778. : strm_(strm), req_(req), is_server_(is_server),
  3779. ping_interval_sec_(ping_interval_sec),
  3780. max_missed_pongs_(max_missed_pongs) {
  3781. start_heartbeat();
  3782. }
  3783. WebSocket(
  3784. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3785. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3786. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3787. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3788. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3789. max_missed_pongs_(max_missed_pongs) {
  3790. start_heartbeat();
  3791. }
  3792. void start_heartbeat();
  3793. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3794. Stream &strm_;
  3795. std::unique_ptr<Stream> owned_strm_;
  3796. Request req_;
  3797. bool is_server_;
  3798. time_t ping_interval_sec_;
  3799. int max_missed_pongs_;
  3800. int unacked_pings_ = 0;
  3801. std::atomic<bool> closed_{false};
  3802. // Set once the caller has bounded read() through set_read_timeout(). Until
  3803. // then the timeout in effect is the compile-time default, and elapsing it
  3804. // is a failure that closes the connection, not a Timeout.
  3805. std::atomic<bool> read_timeout_set_{false};
  3806. std::mutex write_mutex_;
  3807. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3808. // may do so: read_websocket_frame() reads a payload until it has the whole
  3809. // declared length, so a second parser stealing bytes silently corrupts the
  3810. // message the first one is assembling.
  3811. std::mutex read_mutex_;
  3812. std::thread ping_thread_;
  3813. std::mutex ping_mutex_;
  3814. std::condition_variable ping_cv_;
  3815. };
  3816. class WebSocketClient {
  3817. public:
  3818. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3819. const Headers &headers = {});
  3820. ~WebSocketClient();
  3821. WebSocketClient(const WebSocketClient &) = delete;
  3822. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3823. bool is_valid() const;
  3824. Result connect();
  3825. ReadResult read(std::string &msg);
  3826. bool send(const std::string &data);
  3827. bool send(const char *data, size_t len);
  3828. void close(CloseStatus status = CloseStatus::Normal,
  3829. const std::string &reason = "");
  3830. bool is_open() const;
  3831. const std::string &subprotocol() const;
  3832. void set_read_timeout(time_t sec, time_t usec = 0);
  3833. template <class Rep, class Period>
  3834. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3835. void set_write_timeout(time_t sec, time_t usec = 0);
  3836. template <class Rep, class Period>
  3837. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3838. void set_websocket_ping_interval(time_t sec);
  3839. void set_websocket_max_missed_pongs(int count);
  3840. void set_tcp_nodelay(bool on);
  3841. void set_address_family(int family);
  3842. void set_ipv6_v6only(bool on);
  3843. void set_socket_options(SocketOptions socket_options);
  3844. void set_connection_timeout(time_t sec, time_t usec = 0);
  3845. template <class Rep, class Period>
  3846. void
  3847. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3848. void set_interface(const std::string &intf);
  3849. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3850. #ifdef CPPHTTPLIB_SSL_ENABLED
  3851. struct PemMemory {
  3852. const char *cert_pem;
  3853. size_t cert_pem_len;
  3854. const char *key_pem;
  3855. size_t key_pem_len;
  3856. const char *private_key_password;
  3857. };
  3858. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3859. const PemMemory &pem, const Headers &headers = {});
  3860. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3861. const std::string &ca_cert_dir_path = std::string());
  3862. void set_ca_cert_store(tls::ca_store_t store);
  3863. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3864. void enable_server_certificate_verification(bool enabled);
  3865. void enable_server_hostname_verification(bool enabled);
  3866. void enable_system_ca(bool enabled);
  3867. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3868. void set_session_verifier(
  3869. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3870. #endif
  3871. private:
  3872. void shutdown_and_close();
  3873. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3874. int &ssl_error, uint64_t &ssl_backend_error);
  3875. void prepare_default_headers(Request &req);
  3876. std::string host_;
  3877. int port_;
  3878. std::string path_;
  3879. Headers headers_;
  3880. std::string subprotocol_;
  3881. bool is_valid_ = false;
  3882. socket_t sock_ = INVALID_SOCKET;
  3883. std::unique_ptr<WebSocket> ws_;
  3884. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3885. time_t read_timeout_usec_ = 0;
  3886. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3887. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3888. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3889. time_t websocket_ping_interval_sec_ =
  3890. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3891. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3892. int address_family_ = AF_UNSPEC;
  3893. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3894. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3895. SocketOptions socket_options_ = nullptr;
  3896. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3897. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3898. std::string interface_;
  3899. // Hostname to connection target map. The value is an IP literal or another
  3900. // hostname; only the connection target changes, never the identity.
  3901. std::map<std::string, std::string> addr_map_;
  3902. #ifdef CPPHTTPLIB_SSL_ENABLED
  3903. bool is_ssl_ = false;
  3904. tls::ctx_t tls_ctx_ = nullptr;
  3905. tls::session_t tls_session_ = nullptr;
  3906. std::string ca_cert_file_path_;
  3907. std::string ca_cert_dir_path_;
  3908. bool custom_ca_loaded_ = false;
  3909. bool certs_loaded_ = false;
  3910. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3911. bool server_certificate_verification_ = true;
  3912. bool server_hostname_verification_ = true;
  3913. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3914. #endif
  3915. };
  3916. template <class Rep, class Period>
  3917. inline void WebSocket::set_read_timeout(
  3918. const std::chrono::duration<Rep, Period> &duration) {
  3919. detail::duration_to_sec_and_usec(
  3920. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3921. }
  3922. template <class Rep, class Period>
  3923. inline void WebSocketClient::set_read_timeout(
  3924. const std::chrono::duration<Rep, Period> &duration) {
  3925. detail::duration_to_sec_and_usec(
  3926. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3927. }
  3928. template <class Rep, class Period>
  3929. inline void WebSocketClient::set_write_timeout(
  3930. const std::chrono::duration<Rep, Period> &duration) {
  3931. detail::duration_to_sec_and_usec(
  3932. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3933. }
  3934. template <class Rep, class Period>
  3935. inline void WebSocketClient::set_connection_timeout(
  3936. const std::chrono::duration<Rep, Period> &duration) {
  3937. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3938. set_connection_timeout(sec, usec);
  3939. });
  3940. }
  3941. namespace impl {
  3942. bool is_valid_utf8(const std::string &s);
  3943. // Three states, because a failure that consumed bytes and one that consumed
  3944. // none are not the same thing: the first has left the stream in the middle of
  3945. // a frame and the connection cannot be reused, the second can just be retried.
  3946. enum class FrameRead { Ok, Fail, Timeout };
  3947. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3948. std::string &payload, bool &fin,
  3949. bool expect_masked, size_t max_len);
  3950. } // namespace impl
  3951. } // namespace ws
  3952. // ----------------------------------------------------------------------------
  3953. /*
  3954. * Implementation that will be part of the .cc file if split into .h + .cc.
  3955. */
  3956. namespace stream {
  3957. // stream::Result implementations
  3958. inline Result::Result() : chunk_size_(8192) {}
  3959. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3960. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3961. inline Result::Result(Result &&other) noexcept
  3962. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3963. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3964. finished_(other.finished_) {
  3965. other.current_size_ = 0;
  3966. other.finished_ = true;
  3967. }
  3968. inline Result &Result::operator=(Result &&other) noexcept {
  3969. if (this != &other) {
  3970. handle_ = std::move(other.handle_);
  3971. buffer_ = std::move(other.buffer_);
  3972. current_size_ = other.current_size_;
  3973. chunk_size_ = other.chunk_size_;
  3974. finished_ = other.finished_;
  3975. other.current_size_ = 0;
  3976. other.finished_ = true;
  3977. }
  3978. return *this;
  3979. }
  3980. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3981. inline Result::operator bool() const { return is_valid(); }
  3982. inline int Result::status() const {
  3983. return handle_.response ? handle_.response->status : -1;
  3984. }
  3985. inline const Headers &Result::headers() const {
  3986. static const Headers empty_headers;
  3987. return handle_.response ? handle_.response->headers : empty_headers;
  3988. }
  3989. inline std::string Result::get_header_value(const std::string &key,
  3990. const char *def) const {
  3991. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3992. }
  3993. inline bool Result::has_header(const std::string &key) const {
  3994. return handle_.response ? handle_.response->has_header(key) : false;
  3995. }
  3996. inline Error Result::error() const { return handle_.error; }
  3997. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3998. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3999. inline bool Result::next() {
  4000. if (!handle_.is_valid() || finished_) { return false; }
  4001. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4002. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4003. if (n > 0) {
  4004. current_size_ = static_cast<size_t>(n);
  4005. return true;
  4006. }
  4007. current_size_ = 0;
  4008. finished_ = true;
  4009. return false;
  4010. }
  4011. inline const char *Result::data() const { return buffer_.data(); }
  4012. inline size_t Result::size() const { return current_size_; }
  4013. inline std::string Result::read_all() {
  4014. std::string result;
  4015. while (next()) {
  4016. result.append(data(), size());
  4017. }
  4018. return result;
  4019. }
  4020. } // namespace stream
  4021. namespace sse {
  4022. // SSEMessage implementations
  4023. inline SSEMessage::SSEMessage() : event("message") {}
  4024. inline void SSEMessage::clear() {
  4025. event = "message";
  4026. data.clear();
  4027. id.clear();
  4028. }
  4029. // SSEClient implementations
  4030. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4031. : client_(client), path_(path) {}
  4032. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4033. const Headers &headers)
  4034. : client_(client), path_(path), headers_(headers) {}
  4035. inline SSEClient::~SSEClient() { stop(); }
  4036. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4037. on_message_ = std::move(handler);
  4038. return *this;
  4039. }
  4040. inline SSEClient &SSEClient::on_event(const std::string &type,
  4041. MessageHandler handler) {
  4042. event_handlers_[type] = std::move(handler);
  4043. return *this;
  4044. }
  4045. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4046. on_open_ = std::move(handler);
  4047. return *this;
  4048. }
  4049. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4050. on_error_ = std::move(handler);
  4051. return *this;
  4052. }
  4053. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4054. reconnect_interval_ms_ = ms;
  4055. return *this;
  4056. }
  4057. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4058. max_reconnect_attempts_ = n;
  4059. return *this;
  4060. }
  4061. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4062. std::lock_guard<std::mutex> lock(headers_mutex_);
  4063. headers_ = headers;
  4064. return *this;
  4065. }
  4066. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4067. inline const std::string &SSEClient::last_event_id() const {
  4068. return last_event_id_;
  4069. }
  4070. inline void SSEClient::start() {
  4071. running_.store(true);
  4072. run_event_loop();
  4073. }
  4074. inline void SSEClient::start_async() {
  4075. running_.store(true);
  4076. async_thread_ = std::thread([this]() { run_event_loop(); });
  4077. }
  4078. inline void SSEClient::stop() {
  4079. running_.store(false);
  4080. client_.stop(); // Cancel any pending operations
  4081. if (async_thread_.joinable()) { async_thread_.join(); }
  4082. }
  4083. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4084. int &retry_ms, bool &has_data,
  4085. bool &has_id) {
  4086. // Blank line signals end of event
  4087. if (line.empty()) { return true; }
  4088. // Lines starting with ':' are comments (ignored)
  4089. if (line[0] == ':') { return false; }
  4090. // Find the colon separator
  4091. auto colon_pos = line.find(':');
  4092. auto field = line.substr(0, colon_pos);
  4093. std::string value;
  4094. // Value starts after colon, skip optional single space
  4095. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4096. auto value_start = colon_pos + 1;
  4097. if (line[value_start] == ' ') { value_start++; }
  4098. value = line.substr(value_start);
  4099. }
  4100. // Handle known fields
  4101. if (field == "event") {
  4102. msg.event = value;
  4103. } else if (field == "data") {
  4104. // Multiple data lines are concatenated with newlines
  4105. if (has_data) { msg.data += "\n"; }
  4106. msg.data += value;
  4107. has_data = true;
  4108. } else if (field == "id") {
  4109. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4110. // valid (clears the last event ID)
  4111. if (detail::fields::is_field_value(value)) {
  4112. msg.id = value;
  4113. has_id = true;
  4114. }
  4115. } else if (field == "retry") {
  4116. // Parse retry interval in milliseconds
  4117. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4118. if (detail::is_numeric(value)) {
  4119. int v = 0;
  4120. auto res =
  4121. detail::from_chars(value.data(), value.data() + value.size(), v);
  4122. if (res.ec == std::errc{}) { retry_ms = v; }
  4123. }
  4124. }
  4125. // Unknown fields are ignored per SSE spec
  4126. return false;
  4127. }
  4128. inline void SSEClient::run_event_loop() {
  4129. auto reconnect_count = 0;
  4130. while (running_.load()) {
  4131. // Build headers, including Last-Event-ID if we have one
  4132. Headers request_headers;
  4133. {
  4134. std::lock_guard<std::mutex> lock(headers_mutex_);
  4135. request_headers = headers_;
  4136. }
  4137. if (!last_event_id_.empty()) {
  4138. request_headers.emplace("Last-Event-ID", last_event_id_);
  4139. }
  4140. // Open streaming connection
  4141. auto result = stream::Get(client_, path_, request_headers);
  4142. // Connection error handling
  4143. if (!result) {
  4144. connected_.store(false);
  4145. if (on_error_) { on_error_(result.error()); }
  4146. if (!should_reconnect(reconnect_count)) { break; }
  4147. wait_for_reconnect();
  4148. reconnect_count++;
  4149. continue;
  4150. }
  4151. if (result.status() != StatusCode::OK_200) {
  4152. connected_.store(false);
  4153. if (on_error_) { on_error_(Error::Connection); }
  4154. // For certain errors, don't reconnect.
  4155. // Note: 401 is intentionally absent so that handlers can refresh
  4156. // credentials via set_headers() and let the client reconnect.
  4157. if (result.status() == StatusCode::NoContent_204 ||
  4158. result.status() == StatusCode::NotFound_404 ||
  4159. result.status() == StatusCode::Forbidden_403) {
  4160. break;
  4161. }
  4162. if (!should_reconnect(reconnect_count)) { break; }
  4163. wait_for_reconnect();
  4164. reconnect_count++;
  4165. continue;
  4166. }
  4167. // Connection successful
  4168. connected_.store(true);
  4169. reconnect_count = 0;
  4170. if (on_open_) { on_open_(); }
  4171. // Event receiving loop
  4172. std::string buffer;
  4173. SSEMessage current_msg;
  4174. auto has_data = false;
  4175. auto has_id = false;
  4176. auto first_line = true;
  4177. auto after_cr = false;
  4178. auto event_too_long = false;
  4179. while (running_.load() && result.next()) {
  4180. // What is left in the buffer has no line ending
  4181. auto search_pos = buffer.size();
  4182. buffer.append(result.data(), result.size());
  4183. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4184. // per the SSE spec
  4185. size_t line_start = 0;
  4186. size_t eol_pos;
  4187. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4188. std::string::npos) {
  4189. auto line = buffer.substr(line_start, eol_pos - line_start);
  4190. line_start = eol_pos + 1;
  4191. search_pos = line_start;
  4192. // The \n of a \r\n may arrive in a later chunk than its \r
  4193. auto is_lf_of_crlf =
  4194. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4195. after_cr = buffer[eol_pos] == '\r';
  4196. if (is_lf_of_crlf) { continue; }
  4197. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4198. if (first_line) {
  4199. first_line = false;
  4200. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4201. }
  4202. // Parse the line and check if event is complete
  4203. auto event_complete = parse_sse_line(
  4204. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4205. if (event_complete) {
  4206. // Update last_event_id for reconnection, even for an event that
  4207. // has no data. An empty id clears it.
  4208. if (has_id) { last_event_id_ = current_msg.id; }
  4209. // An event without a data field is not dispatched
  4210. if (has_data) { dispatch_event(current_msg); }
  4211. // Reset the message for the next event either way
  4212. current_msg.clear();
  4213. has_data = false;
  4214. has_id = false;
  4215. }
  4216. }
  4217. // Keep unprocessed data in buffer
  4218. buffer.erase(0, line_start);
  4219. // Neither an event nor a line still waiting for its end may grow
  4220. // without bound. 0 means no limit.
  4221. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4222. buffer.size() + current_msg.data.size() >
  4223. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4224. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4225. event_too_long = true;
  4226. break;
  4227. }
  4228. }
  4229. // Connection ended
  4230. connected_.store(false);
  4231. // Reconnecting would only get the same event again
  4232. if (!running_.load() || event_too_long) { break; }
  4233. // Check for read errors
  4234. if (result.has_read_error()) {
  4235. if (on_error_) { on_error_(result.read_error()); }
  4236. }
  4237. if (!should_reconnect(reconnect_count)) { break; }
  4238. wait_for_reconnect();
  4239. reconnect_count++;
  4240. }
  4241. connected_.store(false);
  4242. }
  4243. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4244. // Check for specific event type handler first
  4245. auto it = event_handlers_.find(msg.event);
  4246. if (it != event_handlers_.end()) {
  4247. it->second(msg);
  4248. return;
  4249. }
  4250. // Fall back to generic message handler
  4251. if (on_message_) { on_message_(msg); }
  4252. }
  4253. inline bool SSEClient::should_reconnect(int count) const {
  4254. if (!running_.load()) { return false; }
  4255. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4256. return count < max_reconnect_attempts_;
  4257. }
  4258. inline void SSEClient::wait_for_reconnect() {
  4259. // Use small increments to check running_ flag frequently.
  4260. // Always wait at least one increment, so that a zero interval (e.g.
  4261. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4262. const auto step_ms = 100;
  4263. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4264. auto waited = 0;
  4265. while (running_.load() && waited < interval_ms) {
  4266. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4267. waited += step_ms;
  4268. }
  4269. }
  4270. } // namespace sse
  4271. #ifdef CPPHTTPLIB_SSL_ENABLED
  4272. /*
  4273. * TLS abstraction layer - internal function declarations
  4274. * These are implementation details and not part of the public API.
  4275. */
  4276. namespace tls {
  4277. // Client context
  4278. ctx_t create_client_context();
  4279. void free_context(ctx_t ctx);
  4280. bool set_min_version(ctx_t ctx, Version version);
  4281. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4282. bool load_ca_file(ctx_t ctx, const char *file_path);
  4283. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4284. bool load_system_certs(ctx_t ctx);
  4285. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4286. const char *password);
  4287. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4288. const char *key_path, const char *password);
  4289. // Server context
  4290. ctx_t create_server_context();
  4291. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4292. const char *password);
  4293. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4294. const char *key_path, const char *password);
  4295. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4296. void set_verify_client(ctx_t ctx, bool require);
  4297. // Session management
  4298. session_t create_session(ctx_t ctx, socket_t sock);
  4299. void free_session(session_t session);
  4300. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4301. // Handshake (non-blocking capable)
  4302. TlsError connect(session_t session);
  4303. TlsError accept(session_t session);
  4304. // Handshake with timeout (blocking until timeout)
  4305. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4306. time_t timeout_usec, TlsError *err);
  4307. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4308. time_t timeout_usec, TlsError *err);
  4309. // I/O (non-blocking capable)
  4310. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4311. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4312. int pending(const_session_t session);
  4313. void shutdown(session_t session, bool graceful);
  4314. // Connection state
  4315. bool is_peer_closed(session_t session, socket_t sock);
  4316. // Certificate verification
  4317. cert_t get_peer_cert(const_session_t session);
  4318. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4319. // do not use them after free_session(), as with get_peer_cert().
  4320. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4321. void free_cert(cert_t cert);
  4322. bool verify_hostname(cert_t cert, const char *hostname);
  4323. uint64_t hostname_mismatch_code();
  4324. long get_verify_result(const_session_t session);
  4325. // Certificate introspection
  4326. std::string get_cert_subject_cn(cert_t cert);
  4327. std::string get_cert_issuer_name(cert_t cert);
  4328. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4329. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4330. std::string get_cert_serial(cert_t cert);
  4331. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4332. const char *get_sni(const_session_t session);
  4333. // CA store management
  4334. ca_store_t create_ca_store(const char *pem, size_t len);
  4335. void free_ca_store(ca_store_t store);
  4336. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4337. // Free each with free_cert(), and do not use them once the context's CA
  4338. // certificates change.
  4339. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4340. std::vector<std::string> get_ca_names(ctx_t ctx);
  4341. // Dynamic certificate update (for servers)
  4342. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4343. const char *password);
  4344. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4345. // Certificate verification callback
  4346. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4347. long get_verify_error(const_session_t session);
  4348. std::string verify_error_string(long error_code);
  4349. // TlsError information
  4350. uint64_t peek_error();
  4351. uint64_t get_error();
  4352. std::string error_string(uint64_t code);
  4353. } // namespace tls
  4354. #endif // CPPHTTPLIB_SSL_ENABLED
  4355. /*
  4356. * Group 1: detail namespace - Non-SSL utilities
  4357. */
  4358. namespace detail {
  4359. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4360. const void *optval, socklen_t optlen) {
  4361. return setsockopt(sock, level, optname,
  4362. #ifdef _WIN32
  4363. reinterpret_cast<const char *>(optval),
  4364. #else
  4365. optval,
  4366. #endif
  4367. optlen) == 0;
  4368. }
  4369. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4370. time_t sec, time_t usec) {
  4371. #ifdef _WIN32
  4372. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4373. #else
  4374. timeval timeout;
  4375. timeout.tv_sec = static_cast<long>(sec);
  4376. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4377. #endif
  4378. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4379. }
  4380. inline bool is_hex(char c, int &v) {
  4381. if (is_ascii_digit(c)) {
  4382. v = c - '0';
  4383. return true;
  4384. } else if ('A' <= c && c <= 'F') {
  4385. v = c - 'A' + 10;
  4386. return true;
  4387. } else if ('a' <= c && c <= 'f') {
  4388. v = c - 'a' + 10;
  4389. return true;
  4390. }
  4391. return false;
  4392. }
  4393. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4394. int &val) {
  4395. if (i >= s.size()) { return false; }
  4396. val = 0;
  4397. for (; cnt; i++, cnt--) {
  4398. if (!s[i]) { return false; }
  4399. auto v = 0;
  4400. if (is_hex(s[i], v)) {
  4401. val = val * 16 + v;
  4402. } else {
  4403. return false;
  4404. }
  4405. }
  4406. return true;
  4407. }
  4408. inline std::string from_i_to_hex(size_t n) {
  4409. static const auto charset = "0123456789abcdef";
  4410. std::string ret;
  4411. do {
  4412. ret = charset[n & 15] + ret;
  4413. n >>= 4;
  4414. } while (n > 0);
  4415. return ret;
  4416. }
  4417. inline std::string compute_etag(const FileStat &fs,
  4418. const std::string &suffix = std::string()) {
  4419. if (!fs.is_file()) { return std::string(); }
  4420. // If mtime cannot be determined (negative value indicates an error
  4421. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4422. // value like 0 could collide with a real file that legitimately has
  4423. // mtime == 0 (epoch) and lead to misleading validators.
  4424. auto mtime_raw = fs.mtime();
  4425. if (mtime_raw < 0) { return std::string(); }
  4426. auto mtime = static_cast<size_t>(mtime_raw);
  4427. auto size = fs.size();
  4428. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4429. from_i_to_hex(size) + suffix + "\"";
  4430. }
  4431. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4432. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4433. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4434. inline std::string file_mtime_to_http_date(time_t mtime) {
  4435. if (mtime < 0) { return std::string(); }
  4436. struct tm tm_buf;
  4437. #ifdef _WIN32
  4438. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4439. #else
  4440. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4441. #endif
  4442. char buf[64];
  4443. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4444. return std::string();
  4445. }
  4446. return std::string(buf);
  4447. }
  4448. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4449. inline time_t parse_http_date(const std::string &date_str) {
  4450. struct tm tm_buf;
  4451. // Create a classic locale object once for all parsing attempts
  4452. const std::locale classic_locale = std::locale::classic();
  4453. // Try to parse using std::get_time (C++11, cross-platform)
  4454. auto try_parse = [&](const char *fmt) -> bool {
  4455. std::istringstream ss(date_str);
  4456. ss.imbue(classic_locale);
  4457. memset(&tm_buf, 0, sizeof(tm_buf));
  4458. ss >> std::get_time(&tm_buf, fmt);
  4459. return !ss.fail();
  4460. };
  4461. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4462. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4463. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4464. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4465. // asctime format: "Sun Nov 6 08:49:37 1994"
  4466. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4467. return static_cast<time_t>(-1);
  4468. }
  4469. }
  4470. }
  4471. #ifdef _WIN32
  4472. return _mkgmtime(&tm_buf);
  4473. #elif defined _AIX
  4474. return mktime(&tm_buf);
  4475. #else
  4476. return timegm(&tm_buf);
  4477. #endif
  4478. }
  4479. inline bool is_weak_etag(const std::string &s) {
  4480. // Check if the string is a weak ETag (starts with 'W/"')
  4481. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4482. }
  4483. inline bool is_strong_etag(const std::string &s) {
  4484. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4485. // chars)
  4486. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4487. }
  4488. inline size_t to_utf8(int code, char *buff) {
  4489. if (code < 0x0080) {
  4490. buff[0] = static_cast<char>(code & 0x7F);
  4491. return 1;
  4492. } else if (code < 0x0800) {
  4493. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4494. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4495. return 2;
  4496. } else if (code < 0xD800) {
  4497. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4498. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4499. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4500. return 3;
  4501. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4502. return 0;
  4503. } else if (code < 0x10000) {
  4504. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4505. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4506. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4507. return 3;
  4508. } else if (code < 0x110000) {
  4509. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4510. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4511. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4512. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4513. return 4;
  4514. }
  4515. // NOTREACHED
  4516. return 0;
  4517. }
  4518. } // namespace detail
  4519. namespace ws {
  4520. namespace impl {
  4521. inline bool is_valid_utf8(const std::string &s) {
  4522. size_t i = 0;
  4523. auto n = s.size();
  4524. while (i < n) {
  4525. auto c = static_cast<unsigned char>(s[i]);
  4526. size_t len;
  4527. uint32_t cp;
  4528. if (c < 0x80) {
  4529. i++;
  4530. continue;
  4531. } else if ((c & 0xE0) == 0xC0) {
  4532. len = 2;
  4533. cp = c & 0x1F;
  4534. } else if ((c & 0xF0) == 0xE0) {
  4535. len = 3;
  4536. cp = c & 0x0F;
  4537. } else if ((c & 0xF8) == 0xF0) {
  4538. len = 4;
  4539. cp = c & 0x07;
  4540. } else {
  4541. return false;
  4542. }
  4543. if (i + len > n) { return false; }
  4544. for (size_t j = 1; j < len; j++) {
  4545. auto b = static_cast<unsigned char>(s[i + j]);
  4546. if ((b & 0xC0) != 0x80) { return false; }
  4547. cp = (cp << 6) | (b & 0x3F);
  4548. }
  4549. // Overlong encoding check
  4550. if (len == 2 && cp < 0x80) { return false; }
  4551. if (len == 3 && cp < 0x800) { return false; }
  4552. if (len == 4 && cp < 0x10000) { return false; }
  4553. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4554. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4555. if (cp > 0x10FFFF) { return false; }
  4556. i += len;
  4557. }
  4558. return true;
  4559. }
  4560. } // namespace impl
  4561. } // namespace ws
  4562. namespace detail {
  4563. // NOTE: This code came up with the following stackoverflow post:
  4564. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4565. inline std::string base64_encode(const std::string &in) {
  4566. static const auto lookup =
  4567. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4568. std::string out;
  4569. out.reserve(in.size());
  4570. // Unsigned: the accumulator is never masked, so with a signed int the
  4571. // `val << 8` below overflows once enough bytes are folded in (undefined
  4572. // behaviour before C++20). Only the low bits are ever emitted, so the
  4573. // wrap-around of an unsigned accumulator does not affect the output.
  4574. uint32_t val = 0;
  4575. auto valb = -6;
  4576. for (auto c : in) {
  4577. val = (val << 8) + static_cast<uint8_t>(c);
  4578. valb += 8;
  4579. while (valb >= 0) {
  4580. out.push_back(lookup[(val >> valb) & 0x3F]);
  4581. valb -= 6;
  4582. }
  4583. }
  4584. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4585. while (out.size() % 4) {
  4586. out.push_back('=');
  4587. }
  4588. return out;
  4589. }
  4590. inline std::string sha1(const std::string &input) {
  4591. // RFC 3174 SHA-1 implementation
  4592. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4593. return (x << n) | (x >> (32 - n));
  4594. };
  4595. uint32_t h0 = 0x67452301;
  4596. uint32_t h1 = 0xEFCDAB89;
  4597. uint32_t h2 = 0x98BADCFE;
  4598. uint32_t h3 = 0x10325476;
  4599. uint32_t h4 = 0xC3D2E1F0;
  4600. // Pre-processing: adding padding bits
  4601. std::string msg = input;
  4602. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4603. msg.push_back(static_cast<char>(0x80u));
  4604. while (msg.size() % 64 != 56) {
  4605. msg.push_back(0);
  4606. }
  4607. // Append original length in bits as 64-bit big-endian
  4608. for (int i = 56; i >= 0; i -= 8) {
  4609. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4610. }
  4611. // Process each 512-bit chunk
  4612. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4613. uint32_t w[80];
  4614. for (size_t i = 0; i < 16; i++) {
  4615. w[i] =
  4616. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4617. << 24) |
  4618. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4619. << 16) |
  4620. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4621. << 8) |
  4622. (static_cast<uint32_t>(
  4623. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4624. }
  4625. for (int i = 16; i < 80; i++) {
  4626. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4627. }
  4628. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4629. for (int i = 0; i < 80; i++) {
  4630. uint32_t f, k;
  4631. if (i < 20) {
  4632. f = (b & c) | ((~b) & d);
  4633. k = 0x5A827999;
  4634. } else if (i < 40) {
  4635. f = b ^ c ^ d;
  4636. k = 0x6ED9EBA1;
  4637. } else if (i < 60) {
  4638. f = (b & c) | (b & d) | (c & d);
  4639. k = 0x8F1BBCDC;
  4640. } else {
  4641. f = b ^ c ^ d;
  4642. k = 0xCA62C1D6;
  4643. }
  4644. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4645. e = d;
  4646. d = c;
  4647. c = left_rotate(b, 30);
  4648. b = a;
  4649. a = temp;
  4650. }
  4651. h0 += a;
  4652. h1 += b;
  4653. h2 += c;
  4654. h3 += d;
  4655. h4 += e;
  4656. }
  4657. // Produce the final hash as a 20-byte binary string
  4658. std::string hash(20, '\0');
  4659. for (size_t i = 0; i < 4; i++) {
  4660. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4661. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4662. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4663. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4664. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4665. }
  4666. return hash;
  4667. }
  4668. inline std::string websocket_accept_key(const std::string &client_key) {
  4669. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4670. return base64_encode(sha1(client_key + magic));
  4671. }
  4672. inline bool is_websocket_upgrade(const Request &req) {
  4673. if (req.method != "GET") { return false; }
  4674. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4675. // list of protocols and asks recipients to match each name
  4676. // case-insensitively, so look for the token rather than compare the whole
  4677. // field value.
  4678. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4679. // Check Connection: Upgrade
  4680. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4681. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4682. // RFC 6455 Section 4.2.1
  4683. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4684. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4685. return false;
  4686. }
  4687. static const std::string b64chars =
  4688. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4689. for (size_t i = 0; i < 22; i++) {
  4690. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4691. }
  4692. // Check Sec-WebSocket-Version: 13
  4693. auto version = req.get_header_value("Sec-WebSocket-Version");
  4694. if (version != "13") { return false; }
  4695. return true;
  4696. }
  4697. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4698. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4699. thread_local std::random_device rd;
  4700. size_t filled = 0;
  4701. while (filled < n) {
  4702. auto v = rd();
  4703. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4704. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4705. }
  4706. }
  4707. }
  4708. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4709. const char *data, size_t len, bool fin,
  4710. bool mask) {
  4711. // First byte: FIN + opcode
  4712. uint8_t header[2];
  4713. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4714. (static_cast<uint8_t>(opcode) & 0x0F));
  4715. // Second byte: MASK + payload length
  4716. if (len < 126) {
  4717. header[1] = static_cast<uint8_t>(len);
  4718. if (mask) { header[1] |= 0x80; }
  4719. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4720. } else if (len <= 0xFFFF) {
  4721. header[1] = 126;
  4722. if (mask) { header[1] |= 0x80; }
  4723. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4724. uint8_t ext[2];
  4725. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4726. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4727. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4728. } else {
  4729. header[1] = 127;
  4730. if (mask) { header[1] |= 0x80; }
  4731. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4732. uint8_t ext[8];
  4733. for (int i = 7; i >= 0; i--) {
  4734. ext[7 - i] =
  4735. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4736. }
  4737. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4738. }
  4739. if (mask) {
  4740. // Generate random mask key
  4741. uint8_t mask_key[4];
  4742. fill_random_bytes(mask_key, sizeof(mask_key));
  4743. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4744. // Write masked payload in chunks
  4745. const size_t chunk_size = 4096;
  4746. std::vector<char> buf((std::min)(len, chunk_size));
  4747. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4748. size_t n = (std::min)(chunk_size, len - offset);
  4749. for (size_t i = 0; i < n; i++) {
  4750. buf[i] =
  4751. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4752. }
  4753. if (strm.write(buf.data(), n) < 0) { return false; }
  4754. }
  4755. } else {
  4756. if (len > 0) {
  4757. if (strm.write(data, len) < 0) { return false; }
  4758. }
  4759. }
  4760. return true;
  4761. }
  4762. } // namespace detail
  4763. namespace ws {
  4764. namespace impl {
  4765. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4766. // hands back whatever its buffer already holds -- so every multi-byte field has
  4767. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4768. // header straddles the read buffer's boundary.
  4769. //
  4770. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4771. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4772. // there is a failure like any other. (When read() fails it always records why,
  4773. // so the error belongs to this call and not to an earlier one.)
  4774. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4775. auto p = static_cast<char *>(buf);
  4776. size_t total = 0;
  4777. while (total < size) {
  4778. auto n = strm.read(p + total, size - total);
  4779. if (n <= 0) {
  4780. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4781. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4782. }
  4783. total += static_cast<size_t>(n);
  4784. }
  4785. return FrameRead::Ok;
  4786. }
  4787. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4788. std::string &payload, bool &fin,
  4789. bool expect_masked, size_t max_len) {
  4790. // Read first 2 bytes. This is the only read that may report a timeout: it
  4791. // sits on a frame boundary, where nothing has been consumed yet.
  4792. uint8_t header[2];
  4793. FrameRead first = read_exact(strm, header, 2);
  4794. if (first != FrameRead::Ok) { return first; }
  4795. fin = (header[0] & 0x80) != 0;
  4796. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4797. if (header[0] & 0x70) { return FrameRead::Fail; }
  4798. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4799. bool masked = (header[1] & 0x80) != 0;
  4800. uint64_t payload_len = header[1] & 0x7F;
  4801. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4802. // MUST have a payload length of 125 bytes or less
  4803. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4804. if (is_control) {
  4805. if (!fin) { return FrameRead::Fail; }
  4806. if (payload_len > 125) { return FrameRead::Fail; }
  4807. }
  4808. if (masked != expect_masked) { return FrameRead::Fail; }
  4809. // Extended payload length
  4810. if (payload_len == 126) {
  4811. uint8_t ext[2];
  4812. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4813. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4814. } else if (payload_len == 127) {
  4815. uint8_t ext[8];
  4816. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4817. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4818. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4819. payload_len = 0;
  4820. for (int i = 0; i < 8; i++) {
  4821. payload_len = (payload_len << 8) | ext[i];
  4822. }
  4823. }
  4824. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4825. // size_t cannot hold (32-bit builds) is refused either way.
  4826. if ((max_len > 0 && payload_len > max_len) ||
  4827. payload_len > (std::numeric_limits<size_t>::max)()) {
  4828. return FrameRead::Fail;
  4829. }
  4830. // Read mask key if present
  4831. uint8_t mask_key[4] = {0};
  4832. if (masked) {
  4833. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4834. return FrameRead::Fail;
  4835. }
  4836. }
  4837. // Grow the payload only as it arrives, since a header alone can announce
  4838. // max_len bytes that never come.
  4839. payload.clear();
  4840. auto len = static_cast<size_t>(payload_len);
  4841. while (payload.size() < len) {
  4842. auto offset = payload.size();
  4843. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4844. payload.resize(offset + n);
  4845. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4846. return FrameRead::Fail;
  4847. }
  4848. }
  4849. // Unmask if needed
  4850. if (masked) {
  4851. for (size_t i = 0; i < payload.size(); i++) {
  4852. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4853. }
  4854. }
  4855. return FrameRead::Ok;
  4856. }
  4857. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4858. // be sent followed by a UTF-8 reason.
  4859. inline bool is_valid_close_payload(const std::string &payload) {
  4860. if (payload.empty()) { return true; }
  4861. if (payload.size() < 2) { return false; }
  4862. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4863. static_cast<uint8_t>(payload[1]);
  4864. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4865. (1007 <= code && code <= 1014) ||
  4866. (3000 <= code && code <= 4999);
  4867. return may_be_sent && is_valid_utf8(payload.substr(2));
  4868. }
  4869. } // namespace impl
  4870. } // namespace ws
  4871. namespace detail {
  4872. inline bool is_valid_path(const std::string &path) {
  4873. size_t level = 0;
  4874. size_t i = 0;
  4875. // Skip slash
  4876. while (i < path.size() && path[i] == '/') {
  4877. i++;
  4878. }
  4879. while (i < path.size()) {
  4880. // Read component
  4881. auto beg = i;
  4882. while (i < path.size() && path[i] != '/') {
  4883. if (path[i] == '\0') {
  4884. return false;
  4885. } else if (path[i] == '\\') {
  4886. return false;
  4887. }
  4888. i++;
  4889. }
  4890. auto len = i - beg;
  4891. assert(len > 0);
  4892. if (!path.compare(beg, len, ".")) {
  4893. ;
  4894. } else if (!path.compare(beg, len, "..")) {
  4895. if (level == 0) { return false; }
  4896. level--;
  4897. } else {
  4898. level++;
  4899. }
  4900. // Skip slash
  4901. while (i < path.size() && path[i] == '/') {
  4902. i++;
  4903. }
  4904. }
  4905. return true;
  4906. }
  4907. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4908. #if defined(_WIN32)
  4909. char buf[_MAX_PATH];
  4910. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4911. resolved = buf;
  4912. #elif defined(PATH_MAX)
  4913. char buf[PATH_MAX];
  4914. if (realpath(path, buf) == nullptr) { return false; }
  4915. resolved = buf;
  4916. #else
  4917. auto buf = realpath(path, nullptr);
  4918. auto guard = scope_exit([&]() { std::free(buf); });
  4919. if (buf == nullptr) { return false; }
  4920. resolved = buf;
  4921. #endif
  4922. return true;
  4923. }
  4924. inline bool is_path_within_base(const std::string &resolved_path,
  4925. const std::string &resolved_base) {
  4926. #if defined(_WIN32)
  4927. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4928. resolved_base.size()) == 0;
  4929. #else
  4930. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4931. resolved_base.size()) == 0;
  4932. #endif
  4933. }
  4934. inline FileStat::FileStat(const std::string &path) {
  4935. #if defined(_WIN32)
  4936. auto wpath = u8string_to_wstring(path.c_str());
  4937. ret_ = _wstat(wpath.c_str(), &st_);
  4938. #else
  4939. ret_ = stat(path.c_str(), &st_);
  4940. #endif
  4941. }
  4942. inline bool FileStat::is_file() const {
  4943. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4944. }
  4945. inline bool FileStat::is_dir() const {
  4946. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4947. }
  4948. inline time_t FileStat::mtime() const {
  4949. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4950. : static_cast<time_t>(-1);
  4951. }
  4952. inline size_t FileStat::size() const {
  4953. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4954. }
  4955. inline std::string encode_path(const std::string &s) {
  4956. std::string result;
  4957. result.reserve(s.size());
  4958. for (size_t i = 0; s[i]; i++) {
  4959. switch (s[i]) {
  4960. case ' ': result += "%20"; break;
  4961. case '+': result += "%2B"; break;
  4962. case '\'': result += "%27"; break;
  4963. case ',': result += "%2C"; break;
  4964. // case ':': result += "%3A"; break; // ok? probably...
  4965. case ';': result += "%3B"; break;
  4966. default:
  4967. auto c = static_cast<uint8_t>(s[i]);
  4968. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4969. // in a request-target as-is.
  4970. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4971. result += '%';
  4972. char hex[4];
  4973. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4974. assert(len == 2);
  4975. result.append(hex, static_cast<size_t>(len));
  4976. } else {
  4977. result += s[i];
  4978. }
  4979. break;
  4980. }
  4981. }
  4982. return result;
  4983. }
  4984. inline std::string file_extension(const std::string &path) {
  4985. auto i = path.size();
  4986. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  4987. i--;
  4988. }
  4989. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  4990. return std::string();
  4991. }
  4992. return path.substr(i);
  4993. }
  4994. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4995. template <typename T>
  4996. inline bool parse_header(const char *beg, const char *end, T fn);
  4997. template <typename T>
  4998. inline bool parse_header(const char *beg, const char *end, T fn) {
  4999. // Skip trailing spaces and tabs.
  5000. while (beg < end && is_space_or_tab(end[-1])) {
  5001. end--;
  5002. }
  5003. auto p = beg;
  5004. while (p < end && *p != ':') {
  5005. p++;
  5006. }
  5007. auto name = std::string(beg, p);
  5008. if (!detail::fields::is_field_name(name)) { return false; }
  5009. if (p == end) { return false; }
  5010. auto key_end = p;
  5011. if (*p++ != ':') { return false; }
  5012. while (p < end && is_space_or_tab(*p)) {
  5013. p++;
  5014. }
  5015. if (p <= end) {
  5016. auto key_len = key_end - beg;
  5017. if (!key_len) { return false; }
  5018. auto key = std::string(beg, key_end);
  5019. auto val = std::string(p, end);
  5020. if (!detail::fields::is_field_value(val)) { return false; }
  5021. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5022. // percent-decoded by the recipient. Applications that need to interpret a
  5023. // value as a URI component should call httplib::decode_uri_component()
  5024. // (or decode_path_component()) explicitly.
  5025. fn(key, val);
  5026. return true;
  5027. }
  5028. return false;
  5029. }
  5030. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5031. const Headers &src_headers) {
  5032. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5033. // transfer coding is complete when a chunk with a chunk-size of zero is
  5034. // received, possibly followed by a trailer section, and finally terminated by
  5035. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5036. //
  5037. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5038. // doesn't care for the existence of the final CRLF. In other words, it seems
  5039. // to be ok whether the final CRLF exists or not in the chunked data.
  5040. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5041. //
  5042. // According to the reference code in RFC 9112, cpp-httplib now allows
  5043. // chunked transfer coding data without the final CRLF.
  5044. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5045. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5046. "transfer-encoding",
  5047. "content-length",
  5048. "host",
  5049. "authorization",
  5050. "www-authenticate",
  5051. "proxy-authenticate",
  5052. "proxy-authorization",
  5053. "cookie",
  5054. "set-cookie",
  5055. "cache-control",
  5056. "expect",
  5057. "max-forwards",
  5058. "pragma",
  5059. "range",
  5060. "te",
  5061. "age",
  5062. "expires",
  5063. "date",
  5064. "location",
  5065. "retry-after",
  5066. "vary",
  5067. "warning",
  5068. "content-encoding",
  5069. "content-type",
  5070. "content-range",
  5071. "trailer"};
  5072. case_ignore::unordered_set<std::string> declared_trailers;
  5073. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5074. if (!trailer_header.empty()) {
  5075. // split() trims each token and skips empty ones, so the name arrives ready
  5076. // to look up.
  5077. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5078. ',', [&](const char *b, const char *e) {
  5079. // A legitimate message declares only a handful of trailers. Cap the
  5080. // set so a peer cannot grow it without bound: an oversized set only
  5081. // arises from an attempt to force many colliding names into
  5082. // quadratic lookups (case_ignore::hash is unkeyed).
  5083. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5084. return;
  5085. }
  5086. std::string key(b, e);
  5087. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5088. declared_trailers.insert(key);
  5089. }
  5090. });
  5091. }
  5092. size_t trailer_header_count = 0;
  5093. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5094. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5095. // Count every received trailer field, not only the declared ones stored in
  5096. // dest, so undeclared fields cannot keep this loop running past the limit.
  5097. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5098. constexpr auto line_terminator_len = 2;
  5099. auto line_beg = line_reader.ptr();
  5100. auto line_end =
  5101. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5102. if (!parse_header(line_beg, line_end,
  5103. [&](const std::string &key, const std::string &val) {
  5104. if (declared_trailers.find(key) !=
  5105. declared_trailers.end()) {
  5106. dest.emplace(key, val);
  5107. }
  5108. })) {
  5109. return false;
  5110. }
  5111. trailer_header_count++;
  5112. if (!line_reader.getline()) { return false; }
  5113. }
  5114. return true;
  5115. }
  5116. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5117. size_t right) {
  5118. while (b + left < e && is_space_or_tab(b[left])) {
  5119. left++;
  5120. }
  5121. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5122. right--;
  5123. }
  5124. return std::make_pair(left, right);
  5125. }
  5126. inline std::string trim_copy(const std::string &s) {
  5127. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5128. return s.substr(r.first, r.second - r.first);
  5129. }
  5130. inline std::string trim_double_quotes_copy(const std::string &s) {
  5131. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5132. return s.substr(1, s.size() - 2);
  5133. }
  5134. return s;
  5135. }
  5136. inline void
  5137. divide(const char *data, std::size_t size, char d,
  5138. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5139. fn) {
  5140. const auto it = std::find(data, data + size, d);
  5141. const auto found = static_cast<std::size_t>(it != data + size);
  5142. const auto lhs_data = data;
  5143. const auto lhs_size = static_cast<std::size_t>(it - data);
  5144. const auto rhs_data = it + found;
  5145. const auto rhs_size = size - lhs_size - found;
  5146. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5147. }
  5148. inline void
  5149. divide(const std::string &str, char d,
  5150. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5151. fn) {
  5152. divide(str.data(), str.size(), d, std::move(fn));
  5153. }
  5154. inline void split(const char *b, const char *e, char d,
  5155. std::function<void(const char *, const char *)> fn) {
  5156. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5157. }
  5158. inline void split(const char *b, const char *e, char d, size_t m,
  5159. std::function<void(const char *, const char *)> fn) {
  5160. size_t i = 0;
  5161. size_t beg = 0;
  5162. size_t count = 1;
  5163. while (e ? (b + i < e) : (b[i] != '\0')) {
  5164. if (b[i] == d && count < m) {
  5165. auto r = trim(b, e, beg, i);
  5166. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5167. beg = i + 1;
  5168. count++;
  5169. }
  5170. i++;
  5171. }
  5172. if (i) {
  5173. auto r = trim(b, e, beg, i);
  5174. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5175. }
  5176. }
  5177. // Same contract as split(), except that a delimiter inside a quoted-string is
  5178. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5179. // quoted-string, and ';' and '=' are legal characters inside one.
  5180. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5181. std::function<void(const char *, const char *)> fn) {
  5182. size_t i = 0;
  5183. size_t beg = 0;
  5184. size_t count = 1;
  5185. auto in_quotes = false;
  5186. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5187. while (has(i)) {
  5188. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5189. // A quoted-pair, whose second character does not end the string.
  5190. i++;
  5191. } else if (b[i] == '"') {
  5192. in_quotes = !in_quotes;
  5193. } else if (b[i] == d && !in_quotes && count < m) {
  5194. auto r = trim(b, e, beg, i);
  5195. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5196. beg = i + 1;
  5197. count++;
  5198. }
  5199. i++;
  5200. }
  5201. if (i) {
  5202. auto r = trim(b, e, beg, i);
  5203. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5204. }
  5205. }
  5206. inline void split_unquoted(const char *b, const char *e, char d,
  5207. std::function<void(const char *, const char *)> fn) {
  5208. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5209. std::move(fn));
  5210. }
  5211. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5212. // key a token, so the first '=' is the separator even when the value is a
  5213. // quoted-string carrying more of them.
  5214. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5215. std::string &val) {
  5216. divide(
  5217. b, static_cast<std::size_t>(e - b), '=',
  5218. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5219. const auto kr = trim(kb, kb + klen, 0, klen);
  5220. key.assign(kb + kr.first, kb + kr.second);
  5221. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5222. val.assign(vb + vr.first, vb + vr.second);
  5223. });
  5224. }
  5225. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5226. std::function<bool(const char *, const char *)> fn) {
  5227. size_t i = 0;
  5228. size_t beg = 0;
  5229. size_t count = 1;
  5230. while (e ? (b + i < e) : (b[i] != '\0')) {
  5231. if (b[i] == d && count < m) {
  5232. auto r = trim(b, e, beg, i);
  5233. if (r.first < r.second) {
  5234. auto found = fn(&b[r.first], &b[r.second]);
  5235. if (found) { return true; }
  5236. }
  5237. beg = i + 1;
  5238. count++;
  5239. }
  5240. i++;
  5241. }
  5242. if (i) {
  5243. auto r = trim(b, e, beg, i);
  5244. if (r.first < r.second) {
  5245. auto found = fn(&b[r.first], &b[r.second]);
  5246. if (found) { return true; }
  5247. }
  5248. }
  5249. return false;
  5250. }
  5251. inline bool split_find(const char *b, const char *e, char d,
  5252. std::function<bool(const char *, const char *)> fn) {
  5253. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5254. std::move(fn));
  5255. }
  5256. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5257. size_t fixed_buffer_size)
  5258. : strm_(strm), fixed_buffer_(fixed_buffer),
  5259. fixed_buffer_size_(fixed_buffer_size) {}
  5260. inline const char *stream_line_reader::ptr() const {
  5261. if (growable_buffer_.empty()) {
  5262. return fixed_buffer_;
  5263. } else {
  5264. return growable_buffer_.data();
  5265. }
  5266. }
  5267. inline size_t stream_line_reader::size() const {
  5268. if (growable_buffer_.empty()) {
  5269. return fixed_buffer_used_size_;
  5270. } else {
  5271. return growable_buffer_.size();
  5272. }
  5273. }
  5274. inline bool stream_line_reader::end_with_crlf() const {
  5275. auto end = ptr() + size();
  5276. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5277. }
  5278. inline bool stream_line_reader::getline() {
  5279. fixed_buffer_used_size_ = 0;
  5280. growable_buffer_.clear();
  5281. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5282. char prev_byte = 0;
  5283. #endif
  5284. for (size_t i = 0;; i++) {
  5285. // Fast path: whatever the stream has already buffered can be scanned for
  5286. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5287. // call, a bounds check and a one-byte copy per character of the request.
  5288. size_t buffered_size = 0;
  5289. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5290. auto take = buffered_size;
  5291. auto terminated = false;
  5292. for (size_t at = 0; at < buffered_size;) {
  5293. auto nl = static_cast<const char *>(
  5294. memchr(buffered + at, '\n', buffered_size - at));
  5295. if (!nl) { break; }
  5296. auto pos = static_cast<size_t>(nl - buffered);
  5297. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5298. take = pos + 1;
  5299. terminated = true;
  5300. break;
  5301. #else
  5302. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5303. // be the last byte of an earlier chunk, hence prev_byte.
  5304. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5305. take = pos + 1;
  5306. terminated = true;
  5307. break;
  5308. }
  5309. at = pos + 1;
  5310. #endif
  5311. }
  5312. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5313. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5314. prev_byte = buffered[take - 1];
  5315. #endif
  5316. append(buffered, take);
  5317. strm_.consume_buffered(take);
  5318. i += take;
  5319. if (terminated) { return true; }
  5320. continue;
  5321. }
  5322. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5323. // Treat exceptionally long lines as an error to
  5324. // prevent infinite loops/memory exhaustion
  5325. return false;
  5326. }
  5327. char byte;
  5328. auto n = strm_.read(&byte, 1);
  5329. if (n < 0) {
  5330. return false;
  5331. } else if (n == 0) {
  5332. if (i == 0) {
  5333. return false;
  5334. } else {
  5335. break;
  5336. }
  5337. }
  5338. append(byte);
  5339. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5340. if (byte == '\n') { break; }
  5341. #else
  5342. if (prev_byte == '\r' && byte == '\n') { break; }
  5343. prev_byte = byte;
  5344. #endif
  5345. }
  5346. return true;
  5347. }
  5348. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5349. inline void stream_line_reader::append(const char *data, size_t size) {
  5350. // Once the line has outgrown the fixed buffer everything must keep going to
  5351. // the growable one, even if a later chunk would have fit. Without the
  5352. // emptiness check a short append after a long one would land in the fixed
  5353. // buffer, which ptr() and size() no longer look at, and be lost.
  5354. if (growable_buffer_.empty() &&
  5355. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5356. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5357. fixed_buffer_used_size_ += size;
  5358. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5359. } else {
  5360. // Unlike the per-character overload, this can be the very first append of
  5361. // the line, so the fixed buffer may hold nothing and carry no terminator
  5362. // yet. assign() takes an explicit length and does not need one.
  5363. if (growable_buffer_.empty()) {
  5364. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5365. }
  5366. growable_buffer_.append(data, size);
  5367. }
  5368. }
  5369. inline mmap::mmap(const char *path) { open(path); }
  5370. inline mmap::~mmap() { close(); }
  5371. inline bool mmap::open(const char *path) {
  5372. close();
  5373. #if defined(_WIN32)
  5374. auto wpath = u8string_to_wstring(path);
  5375. if (wpath.empty()) { return false; }
  5376. hFile_ =
  5377. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5378. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5379. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5380. LARGE_INTEGER size{};
  5381. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5382. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5383. // See:
  5384. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5385. if (static_cast<ULONGLONG>(size.QuadPart) >
  5386. (std::numeric_limits<decltype(size_)>::max)()) {
  5387. // `size_t` might be 32-bits, on 32-bits Windows.
  5388. return false;
  5389. }
  5390. size_ = static_cast<size_t>(size.QuadPart);
  5391. hMapping_ =
  5392. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5393. // Special treatment for an empty file...
  5394. if (hMapping_ == NULL && size_ == 0) {
  5395. close();
  5396. is_open_empty_file = true;
  5397. return true;
  5398. }
  5399. if (hMapping_ == NULL) {
  5400. close();
  5401. return false;
  5402. }
  5403. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5404. if (addr_ == nullptr) {
  5405. close();
  5406. return false;
  5407. }
  5408. #else
  5409. fd_ = ::open(path, O_RDONLY);
  5410. if (fd_ == -1) { return false; }
  5411. struct stat sb;
  5412. if (fstat(fd_, &sb) == -1) {
  5413. close();
  5414. return false;
  5415. }
  5416. size_ = static_cast<size_t>(sb.st_size);
  5417. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5418. // Special treatment for an empty file...
  5419. if (addr_ == MAP_FAILED && size_ == 0) {
  5420. close();
  5421. is_open_empty_file = true;
  5422. return false;
  5423. }
  5424. if (addr_ == MAP_FAILED) {
  5425. // Clear the sentinel before `close()`, since `is_open()` only checks
  5426. // `addr_` against nullptr and `munmap()` must not be called with it.
  5427. addr_ = nullptr;
  5428. close();
  5429. return false;
  5430. }
  5431. #endif
  5432. return true;
  5433. }
  5434. inline bool mmap::is_open() const {
  5435. return is_open_empty_file ? true : addr_ != nullptr;
  5436. }
  5437. inline size_t mmap::size() const { return size_; }
  5438. inline const char *mmap::data() const {
  5439. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5440. }
  5441. inline void mmap::close() {
  5442. #if defined(_WIN32)
  5443. if (addr_) {
  5444. ::UnmapViewOfFile(addr_);
  5445. addr_ = nullptr;
  5446. }
  5447. if (hMapping_) {
  5448. ::CloseHandle(hMapping_);
  5449. hMapping_ = NULL;
  5450. }
  5451. if (hFile_ != INVALID_HANDLE_VALUE) {
  5452. ::CloseHandle(hFile_);
  5453. hFile_ = INVALID_HANDLE_VALUE;
  5454. }
  5455. is_open_empty_file = false;
  5456. #else
  5457. if (addr_ != nullptr) {
  5458. munmap(addr_, size_);
  5459. addr_ = nullptr;
  5460. }
  5461. if (fd_ != -1) {
  5462. ::close(fd_);
  5463. fd_ = -1;
  5464. }
  5465. #endif
  5466. size_ = 0;
  5467. }
  5468. inline int close_socket(socket_t sock) noexcept {
  5469. #ifdef _WIN32
  5470. return closesocket(sock);
  5471. #else
  5472. return close(sock);
  5473. #endif
  5474. }
  5475. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5476. ssize_t res = 0;
  5477. while (true) {
  5478. res = fn();
  5479. if (res < 0 && errno == EINTR) {
  5480. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5481. continue;
  5482. }
  5483. break;
  5484. }
  5485. return res;
  5486. }
  5487. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5488. if (offset >= size_) { return 0; }
  5489. len = (std::min)(len, size_ - offset);
  5490. #if defined(_WIN32)
  5491. // Windows does not let a mapped file be truncated.
  5492. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5493. return len;
  5494. #else
  5495. auto n = handle_EINTR(
  5496. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5497. return n > 0 ? static_cast<size_t>(n) : 0;
  5498. #endif
  5499. }
  5500. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5501. return handle_EINTR([&]() {
  5502. return recv(sock,
  5503. #ifdef _WIN32
  5504. static_cast<char *>(ptr), static_cast<int>(size),
  5505. #else
  5506. ptr, size,
  5507. #endif
  5508. flags);
  5509. });
  5510. }
  5511. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5512. int flags) {
  5513. return handle_EINTR([&]() {
  5514. return send(sock,
  5515. #ifdef _WIN32
  5516. static_cast<const char *>(ptr), static_cast<int>(size),
  5517. #else
  5518. ptr, size,
  5519. #endif
  5520. flags);
  5521. });
  5522. }
  5523. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5524. #ifdef _WIN32
  5525. return ::WSAPoll(fds, nfds, timeout);
  5526. #else
  5527. return ::poll(fds, nfds, timeout);
  5528. #endif
  5529. }
  5530. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5531. time_t usec) {
  5532. struct pollfd pfd;
  5533. pfd.fd = sock;
  5534. pfd.events = events;
  5535. pfd.revents = 0;
  5536. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5537. // "return immediately", which callers here rely on to probe a socket.
  5538. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5539. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5540. }
  5541. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5542. return select_impl(sock, POLLIN, sec, usec);
  5543. }
  5544. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5545. return select_impl(sock, POLLOUT, sec, usec);
  5546. }
  5547. // The point sec and usec from now, for select_until(). A negative sec never
  5548. // comes, as a negative timeout waits forever in select_impl().
  5549. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5550. time_t usec) {
  5551. if (sec < 0) { return std::chrono::steady_clock::time_point::max(); }
  5552. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5553. std::chrono::microseconds(usec);
  5554. }
  5555. // Waits only for the time left until deadline, so that all the waits of one
  5556. // TLS handshake come out of a single timeout.
  5557. inline ssize_t select_until(socket_t sock, short events,
  5558. std::chrono::steady_clock::time_point deadline) {
  5559. if (deadline == std::chrono::steady_clock::time_point::max()) {
  5560. return select_impl(sock, events, -1, 0);
  5561. }
  5562. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5563. deadline - std::chrono::steady_clock::now())
  5564. .count();
  5565. if (left <= 0) { return 0; }
  5566. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5567. static_cast<time_t>(left % 1000000));
  5568. }
  5569. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5570. time_t usec) {
  5571. struct pollfd pfd_read;
  5572. pfd_read.fd = sock;
  5573. pfd_read.events = POLLIN | POLLOUT;
  5574. pfd_read.revents = 0;
  5575. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5576. auto poll_res =
  5577. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5578. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5579. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5580. auto error = 0;
  5581. socklen_t len = sizeof(error);
  5582. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5583. reinterpret_cast<char *>(&error), &len);
  5584. auto successful = res >= 0 && !error;
  5585. return successful ? Error::Success : Error::Connection;
  5586. }
  5587. return Error::Connection;
  5588. }
  5589. inline bool is_socket_alive(socket_t sock) {
  5590. const auto val = detail::select_read(sock, 0, 0);
  5591. if (val == 0) {
  5592. return true;
  5593. } else if (val < 0 && errno == EBADF) {
  5594. return false;
  5595. }
  5596. char buf[1];
  5597. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5598. }
  5599. class SocketStream final : public Stream {
  5600. public:
  5601. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5602. time_t write_timeout_sec, time_t write_timeout_usec,
  5603. time_t max_timeout_msec = 0,
  5604. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5605. (std::chrono::steady_clock::time_point::min)());
  5606. ~SocketStream() override;
  5607. bool is_readable() const override;
  5608. bool wait_readable() const override;
  5609. bool wait_writable() const override;
  5610. bool is_peer_alive() const override;
  5611. ssize_t read(char *ptr, size_t size) override;
  5612. ssize_t write(const char *ptr, size_t size) override;
  5613. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5614. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5615. socket_t socket() const override;
  5616. time_t duration() const override;
  5617. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5618. void set_max_timeout(time_t msec) override;
  5619. const char *buffered_data(size_t &size) const override;
  5620. void consume_buffered(size_t size) override;
  5621. // The caller has just seen this socket become readable. Lets the next read
  5622. // skip its own readiness wait, which would otherwise ask the kernel a
  5623. // question that was answered a moment ago. Consumed by that read.
  5624. void set_readable_hint() { readable_hint_ = true; }
  5625. private:
  5626. bool ensure_readable();
  5627. socket_t sock_;
  5628. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5629. // thread while a read is in flight -- that is the point of it, for a caller
  5630. // holding one connection and wanting control back to send on it.
  5631. std::atomic<time_t> read_timeout_sec_;
  5632. std::atomic<time_t> read_timeout_usec_;
  5633. time_t write_timeout_sec_;
  5634. time_t write_timeout_usec_;
  5635. time_t max_timeout_msec_;
  5636. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5637. std::vector<char> read_buff_;
  5638. size_t read_buff_off_ = 0;
  5639. size_t read_buff_content_size_ = 0;
  5640. bool readable_hint_ = false;
  5641. static const size_t read_buff_size_ = 1024l * 4;
  5642. };
  5643. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5644. time_t keep_alive_timeout_sec) {
  5645. using namespace std::chrono;
  5646. const auto interval_usec =
  5647. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5648. // Avoid expensive `steady_clock::now()` call for the first time
  5649. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5650. const auto start = steady_clock::now() - microseconds{interval_usec};
  5651. const auto timeout = seconds{keep_alive_timeout_sec};
  5652. while (true) {
  5653. if (svr_sock == INVALID_SOCKET) {
  5654. break; // Server socket is closed
  5655. }
  5656. auto val = select_read(sock, 0, interval_usec);
  5657. if (val < 0) {
  5658. break; // Ssocket error
  5659. } else if (val == 0) {
  5660. if (steady_clock::now() - start > timeout) {
  5661. break; // Timeout
  5662. }
  5663. } else {
  5664. return true; // Ready for read
  5665. }
  5666. }
  5667. return false;
  5668. }
  5669. // `has_buffered_request` reports whether the connection's stream already holds
  5670. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5671. // 9.3.2), so reading one request can pull the start of the next one into the
  5672. // stream's buffer; that request must be served without waiting for the socket
  5673. // to become readable again, since its bytes are no longer on the socket.
  5674. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5675. template <typename P, typename T>
  5676. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5677. socket_t sock,
  5678. size_t keep_alive_max_count,
  5679. time_t keep_alive_timeout_sec,
  5680. P has_buffered_request, T callback) {
  5681. assert(keep_alive_max_count > 0);
  5682. auto ret = false;
  5683. auto count = keep_alive_max_count;
  5684. while (count > 0) {
  5685. auto socket_readable = false;
  5686. if (!has_buffered_request()) {
  5687. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5688. socket_readable = true;
  5689. }
  5690. auto close_connection = count == 1;
  5691. auto connection_closed = false;
  5692. ret = callback(socket_readable, close_connection, connection_closed);
  5693. if (!ret || connection_closed) { break; }
  5694. count--;
  5695. }
  5696. return ret;
  5697. }
  5698. template <typename T>
  5699. inline bool
  5700. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5701. size_t keep_alive_max_count,
  5702. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5703. time_t read_timeout_usec, time_t write_timeout_sec,
  5704. time_t write_timeout_usec, T callback) {
  5705. // One stream per connection: its read buffer can already hold the start of
  5706. // the next, pipelined request.
  5707. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5708. write_timeout_sec, write_timeout_usec);
  5709. return process_server_socket_core(
  5710. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5711. [&]() { return strm.is_readable(); },
  5712. [&](bool socket_readable, bool close_connection,
  5713. bool &connection_closed) {
  5714. if (socket_readable) { strm.set_readable_hint(); }
  5715. return callback(strm, close_connection, connection_closed);
  5716. });
  5717. }
  5718. inline bool process_client_socket(
  5719. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5720. time_t write_timeout_sec, time_t write_timeout_usec,
  5721. time_t max_timeout_msec,
  5722. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5723. std::function<bool(Stream &)> callback) {
  5724. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5725. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5726. start_time);
  5727. return callback(strm);
  5728. }
  5729. inline int shutdown_socket(socket_t sock) noexcept {
  5730. #ifdef _WIN32
  5731. return shutdown(sock, SD_BOTH);
  5732. #else
  5733. return shutdown(sock, SHUT_RDWR);
  5734. #endif
  5735. }
  5736. // Half-closes the write side and drains any in-flight/queued bytes before
  5737. // the final shutdown+close. Closing with unread data in the receive queue
  5738. // (or bytes arriving after the receive side is closed) makes the stack send
  5739. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5740. // response as a failed read even though it was fully written.
  5741. inline void drain_and_close_socket(socket_t sock) noexcept {
  5742. #ifdef _WIN32
  5743. shutdown(sock, SD_SEND);
  5744. #else
  5745. shutdown(sock, SHUT_WR);
  5746. #endif
  5747. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5748. size_t total = 0;
  5749. const auto deadline = std::chrono::steady_clock::now() +
  5750. std::chrono::milliseconds(100); // bound #1
  5751. while (total < size_t(1024u * 1024u)) { // bound #2
  5752. const auto remaining =
  5753. std::chrono::duration_cast<std::chrono::microseconds>(
  5754. deadline - std::chrono::steady_clock::now())
  5755. .count();
  5756. if (remaining <= 0) { break; }
  5757. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5758. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5759. if (n <= 0) { break; }
  5760. total += static_cast<size_t>(n);
  5761. }
  5762. shutdown_socket(sock);
  5763. close_socket(sock);
  5764. }
  5765. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5766. if (s.size() > 1 && s[0] == '\0') {
  5767. auto ret = s;
  5768. ret[0] = '@';
  5769. return ret;
  5770. }
  5771. return s;
  5772. }
  5773. inline std::string
  5774. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5775. if (s.size() > 1 && s[0] == '@') {
  5776. auto ret = s;
  5777. ret[0] = '\0';
  5778. return ret;
  5779. }
  5780. return s;
  5781. }
  5782. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5783. const struct addrinfo *hints,
  5784. struct addrinfo **res, time_t timeout_sec) {
  5785. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5786. if (timeout_sec <= 0) {
  5787. // No timeout specified, use standard getaddrinfo
  5788. return getaddrinfo(node, service, hints, res);
  5789. }
  5790. #ifdef _WIN32
  5791. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5792. OVERLAPPED overlapped = {};
  5793. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5794. if (!event) { return EAI_FAIL; }
  5795. overlapped.hEvent = event;
  5796. PADDRINFOEXW result_addrinfo = nullptr;
  5797. HANDLE cancel_handle = nullptr;
  5798. ADDRINFOEXW hints_ex = {};
  5799. if (hints) {
  5800. hints_ex.ai_flags = hints->ai_flags;
  5801. hints_ex.ai_family = hints->ai_family;
  5802. hints_ex.ai_socktype = hints->ai_socktype;
  5803. hints_ex.ai_protocol = hints->ai_protocol;
  5804. }
  5805. auto wnode = u8string_to_wstring(node);
  5806. auto wservice = u8string_to_wstring(service);
  5807. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5808. hints ? &hints_ex : nullptr, &result_addrinfo,
  5809. nullptr, &overlapped, nullptr, &cancel_handle);
  5810. if (ret == WSA_IO_PENDING) {
  5811. auto wait_result =
  5812. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5813. if (wait_result == WAIT_TIMEOUT) {
  5814. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5815. ::CloseHandle(event);
  5816. return EAI_AGAIN;
  5817. }
  5818. DWORD bytes_returned;
  5819. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5820. &bytes_returned, FALSE)) {
  5821. ::CloseHandle(event);
  5822. return ::WSAGetLastError();
  5823. }
  5824. }
  5825. ::CloseHandle(event);
  5826. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5827. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5828. return 0;
  5829. }
  5830. return ret;
  5831. #elif TARGET_OS_MAC && defined(__clang__)
  5832. if (!node) { return EAI_NONAME; }
  5833. // macOS implementation using CFHost API for asynchronous DNS resolution
  5834. CFStringRef hostname_ref = CFStringCreateWithCString(
  5835. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5836. if (!hostname_ref) { return EAI_MEMORY; }
  5837. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5838. CFRelease(hostname_ref);
  5839. if (!host_ref) { return EAI_MEMORY; }
  5840. // Set up context for callback
  5841. struct CFHostContext {
  5842. bool completed = false;
  5843. bool success = false;
  5844. CFArrayRef addresses = nullptr;
  5845. std::mutex mutex;
  5846. std::condition_variable cv;
  5847. } context;
  5848. CFHostClientContext client_context;
  5849. memset(&client_context, 0, sizeof(client_context));
  5850. client_context.info = &context;
  5851. // Set callback
  5852. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5853. const CFStreamError *error, void *info) {
  5854. auto ctx = static_cast<CFHostContext *>(info);
  5855. std::lock_guard<std::mutex> lock(ctx->mutex);
  5856. if (error && error->error != 0) {
  5857. ctx->success = false;
  5858. } else {
  5859. Boolean hasBeenResolved;
  5860. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5861. if (ctx->addresses && hasBeenResolved) {
  5862. CFRetain(ctx->addresses);
  5863. ctx->success = true;
  5864. } else {
  5865. ctx->success = false;
  5866. }
  5867. }
  5868. ctx->completed = true;
  5869. ctx->cv.notify_one();
  5870. };
  5871. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5872. CFRelease(host_ref);
  5873. return EAI_SYSTEM;
  5874. }
  5875. // Schedule on run loop
  5876. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5877. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5878. // Start resolution
  5879. CFStreamError stream_error;
  5880. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5881. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5882. CFRelease(host_ref);
  5883. return EAI_FAIL;
  5884. }
  5885. // Wait for completion with timeout
  5886. auto timeout_time =
  5887. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5888. bool timed_out = false;
  5889. {
  5890. std::unique_lock<std::mutex> lock(context.mutex);
  5891. while (!context.completed) {
  5892. auto now = std::chrono::steady_clock::now();
  5893. if (now >= timeout_time) {
  5894. timed_out = true;
  5895. break;
  5896. }
  5897. // Run the runloop for a short time
  5898. lock.unlock();
  5899. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5900. lock.lock();
  5901. }
  5902. }
  5903. // Clean up
  5904. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5905. CFHostSetClient(host_ref, nullptr, nullptr);
  5906. if (timed_out || !context.completed) {
  5907. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5908. CFRelease(host_ref);
  5909. return EAI_AGAIN;
  5910. }
  5911. if (!context.success || !context.addresses) {
  5912. CFRelease(host_ref);
  5913. return EAI_NODATA;
  5914. }
  5915. // Convert CFArray to addrinfo
  5916. CFIndex count = CFArrayGetCount(context.addresses);
  5917. if (count == 0) {
  5918. CFRelease(context.addresses);
  5919. CFRelease(host_ref);
  5920. return EAI_NODATA;
  5921. }
  5922. struct addrinfo *result_addrinfo = nullptr;
  5923. struct addrinfo **current = &result_addrinfo;
  5924. for (CFIndex i = 0; i < count; i++) {
  5925. CFDataRef addr_data =
  5926. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5927. if (!addr_data) continue;
  5928. const struct sockaddr *sockaddr_ptr =
  5929. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5930. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5931. // Allocate addrinfo structure
  5932. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5933. if (!*current) {
  5934. freeaddrinfo(result_addrinfo);
  5935. CFRelease(context.addresses);
  5936. CFRelease(host_ref);
  5937. return EAI_MEMORY;
  5938. }
  5939. memset(*current, 0, sizeof(struct addrinfo));
  5940. // Set up addrinfo fields
  5941. (*current)->ai_family = sockaddr_ptr->sa_family;
  5942. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5943. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5944. (*current)->ai_addrlen = sockaddr_len;
  5945. // Copy sockaddr
  5946. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5947. if (!(*current)->ai_addr) {
  5948. freeaddrinfo(result_addrinfo);
  5949. CFRelease(context.addresses);
  5950. CFRelease(host_ref);
  5951. return EAI_MEMORY;
  5952. }
  5953. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5954. // Set port if service is specified
  5955. if (service && *service) {
  5956. int port = 0;
  5957. if (parse_port(service, strlen(service), port)) {
  5958. if (sockaddr_ptr->sa_family == AF_INET) {
  5959. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5960. ->sin_port = htons(static_cast<uint16_t>(port));
  5961. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5962. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5963. ->sin6_port = htons(static_cast<uint16_t>(port));
  5964. }
  5965. }
  5966. }
  5967. current = &((*current)->ai_next);
  5968. }
  5969. CFRelease(context.addresses);
  5970. CFRelease(host_ref);
  5971. *res = result_addrinfo;
  5972. return 0;
  5973. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5974. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  5975. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  5976. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  5977. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5978. // the resolver worker still references the stack-local gaicb. The cancel
  5979. // path therefore waits (gai_suspend with no timeout) for the worker to
  5980. // actually finish before letting the stack frame go. The trade-off is that
  5981. // a wedged DNS server can hold this thread for the system resolver timeout
  5982. // (~30s by default) past the caller's connection timeout.
  5983. struct gaicb request{};
  5984. struct gaicb *requests[1] = {&request};
  5985. struct sigevent sevp{};
  5986. struct timespec timeout{timeout_sec, 0};
  5987. request.ar_name = node;
  5988. request.ar_service = service;
  5989. request.ar_request = hints;
  5990. sevp.sigev_notify = SIGEV_NONE;
  5991. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5992. if (rc != 0) { return rc; }
  5993. auto cleanup = scope_exit([&] {
  5994. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5995. });
  5996. int wait_result = gai_suspend(requests, 1, &timeout);
  5997. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5998. int gai_result = gai_error(&request);
  5999. if (gai_result == 0) {
  6000. *res = request.ar_result;
  6001. request.ar_result = nullptr;
  6002. return 0;
  6003. }
  6004. return gai_result;
  6005. }
  6006. gai_cancel(&request);
  6007. while (gai_error(&request) == EAI_INPROGRESS) {
  6008. gai_suspend(requests, 1, nullptr);
  6009. }
  6010. return wait_result;
  6011. #else
  6012. // Fallback implementation using thread-based timeout for other Unix systems.
  6013. struct GetAddrInfoState {
  6014. ~GetAddrInfoState() {
  6015. if (info) { freeaddrinfo(info); }
  6016. }
  6017. std::mutex mutex;
  6018. std::condition_variable result_cv;
  6019. bool completed = false;
  6020. int result = EAI_SYSTEM;
  6021. std::string node;
  6022. std::string service;
  6023. struct addrinfo hints;
  6024. struct addrinfo *info = nullptr;
  6025. };
  6026. // Allocate on the heap, so the resolver thread can keep using the data.
  6027. auto state = std::make_shared<GetAddrInfoState>();
  6028. if (node) { state->node = node; }
  6029. state->service = service;
  6030. state->hints = *hints;
  6031. std::thread resolve_thread([state]() {
  6032. auto thread_result =
  6033. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6034. &state->info);
  6035. std::lock_guard<std::mutex> lock(state->mutex);
  6036. state->result = thread_result;
  6037. state->completed = true;
  6038. state->result_cv.notify_one();
  6039. });
  6040. // Wait for completion or timeout
  6041. std::unique_lock<std::mutex> lock(state->mutex);
  6042. auto finished =
  6043. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6044. [&] { return state->completed; });
  6045. if (finished) {
  6046. // Operation completed within timeout
  6047. resolve_thread.join();
  6048. *res = state->info;
  6049. state->info = nullptr; // Pass ownership to caller
  6050. return state->result;
  6051. } else {
  6052. // Timeout occurred
  6053. resolve_thread.detach(); // Let the thread finish in background
  6054. return EAI_AGAIN; // Return timeout error
  6055. }
  6056. #endif
  6057. #else
  6058. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6059. return getaddrinfo(node, service, hints, res);
  6060. #endif
  6061. }
  6062. template <typename BindOrConnect>
  6063. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6064. int address_family, int socket_flags, bool tcp_nodelay,
  6065. bool ipv6_v6only, SocketOptions socket_options,
  6066. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6067. // Get address info
  6068. const char *node = nullptr;
  6069. struct addrinfo hints;
  6070. struct addrinfo *result;
  6071. memset(&hints, 0, sizeof(struct addrinfo));
  6072. hints.ai_socktype = SOCK_STREAM;
  6073. hints.ai_protocol = IPPROTO_IP;
  6074. if (!ip.empty()) {
  6075. node = ip.c_str();
  6076. // Ask getaddrinfo to convert IP in c-string to address
  6077. hints.ai_family = AF_UNSPEC;
  6078. hints.ai_flags = AI_NUMERICHOST;
  6079. } else {
  6080. if (!host.empty()) { node = host.c_str(); }
  6081. hints.ai_family = address_family;
  6082. hints.ai_flags = socket_flags;
  6083. }
  6084. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6085. if (hints.ai_family == AF_UNIX) {
  6086. const auto addrlen = host.length();
  6087. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6088. #ifdef SOCK_CLOEXEC
  6089. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6090. hints.ai_protocol);
  6091. #else
  6092. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6093. #endif
  6094. if (sock != INVALID_SOCKET) {
  6095. sockaddr_un addr{};
  6096. addr.sun_family = AF_UNIX;
  6097. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6098. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6099. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6100. hints.ai_addrlen = static_cast<socklen_t>(
  6101. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6102. #ifndef SOCK_CLOEXEC
  6103. #ifndef _WIN32
  6104. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6105. #endif
  6106. #endif
  6107. if (socket_options) { socket_options(sock); }
  6108. #ifdef _WIN32
  6109. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6110. // remove the option.
  6111. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6112. #endif
  6113. bool dummy;
  6114. if (!bind_or_connect(sock, hints, dummy)) {
  6115. close_socket(sock);
  6116. sock = INVALID_SOCKET;
  6117. }
  6118. }
  6119. return sock;
  6120. }
  6121. #endif
  6122. auto service = std::to_string(port);
  6123. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6124. timeout_sec)) {
  6125. #if defined __linux__ && !defined __ANDROID__
  6126. res_init();
  6127. #endif
  6128. return INVALID_SOCKET;
  6129. }
  6130. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6131. for (auto rp = result; rp; rp = rp->ai_next) {
  6132. // Create a socket
  6133. #ifdef _WIN32
  6134. auto sock =
  6135. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6136. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6137. /**
  6138. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6139. * and above the socket creation fails on older Windows Systems.
  6140. *
  6141. * Let's try to create a socket the old way in this case.
  6142. *
  6143. * Reference:
  6144. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6145. *
  6146. * WSA_FLAG_NO_HANDLE_INHERIT:
  6147. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6148. * SP1, and later
  6149. *
  6150. */
  6151. if (sock == INVALID_SOCKET) {
  6152. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6153. }
  6154. #else
  6155. #ifdef SOCK_CLOEXEC
  6156. auto sock =
  6157. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6158. #else
  6159. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6160. #endif
  6161. #endif
  6162. if (sock == INVALID_SOCKET) { continue; }
  6163. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6164. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6165. close_socket(sock);
  6166. continue;
  6167. }
  6168. #endif
  6169. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6170. if (rp->ai_family == AF_INET6) {
  6171. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6172. }
  6173. if (socket_options) { socket_options(sock); }
  6174. // bind or connect
  6175. auto quit = false;
  6176. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6177. close_socket(sock);
  6178. if (quit) { break; }
  6179. }
  6180. return INVALID_SOCKET;
  6181. }
  6182. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6183. #ifdef _WIN32
  6184. auto flags = nonblocking ? 1UL : 0UL;
  6185. ioctlsocket(sock, FIONBIO, &flags);
  6186. #else
  6187. auto flags = fcntl(sock, F_GETFL, 0);
  6188. fcntl(sock, F_SETFL,
  6189. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6190. #endif
  6191. }
  6192. inline bool is_connection_error() {
  6193. #ifdef _WIN32
  6194. return WSAGetLastError() != WSAEWOULDBLOCK;
  6195. #else
  6196. return errno != EINPROGRESS;
  6197. #endif
  6198. }
  6199. // accept() failed because the process or the network stack is temporarily out
  6200. // of resources. The listening socket is still usable, so back off briefly and
  6201. // try again.
  6202. inline bool is_accept_resource_error() {
  6203. #ifdef _WIN32
  6204. auto err = WSAGetLastError();
  6205. return err == WSAEMFILE || err == WSAENOBUFS;
  6206. #else
  6207. auto err = errno;
  6208. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6209. #endif
  6210. }
  6211. // accept() failed for a reason that says nothing about the listening socket:
  6212. // the pending connection went away before it could be accepted, or the call
  6213. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6214. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6215. // connection that way.
  6216. inline bool is_accept_transient_error() {
  6217. #ifdef _WIN32
  6218. auto err = WSAGetLastError();
  6219. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6220. err == WSAECONNABORTED;
  6221. #else
  6222. auto err = errno;
  6223. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6224. err == ECONNABORTED;
  6225. #endif
  6226. }
  6227. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6228. struct addrinfo hints;
  6229. struct addrinfo *result;
  6230. memset(&hints, 0, sizeof(struct addrinfo));
  6231. hints.ai_family = AF_UNSPEC;
  6232. hints.ai_socktype = SOCK_STREAM;
  6233. hints.ai_protocol = 0;
  6234. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6235. return false;
  6236. }
  6237. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6238. auto ret = false;
  6239. for (auto rp = result; rp; rp = rp->ai_next) {
  6240. const auto &ai = *rp;
  6241. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6242. ret = true;
  6243. break;
  6244. }
  6245. }
  6246. return ret;
  6247. }
  6248. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6249. #define USE_IF2IP
  6250. #endif
  6251. #ifdef USE_IF2IP
  6252. inline std::string if2ip(int address_family, const std::string &ifn) {
  6253. struct ifaddrs *ifap;
  6254. getifaddrs(&ifap);
  6255. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6256. std::string addr_candidate;
  6257. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6258. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6259. (AF_UNSPEC == address_family ||
  6260. ifa->ifa_addr->sa_family == address_family)) {
  6261. if (ifa->ifa_addr->sa_family == AF_INET) {
  6262. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6263. char buf[INET_ADDRSTRLEN];
  6264. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6265. return std::string(buf, INET_ADDRSTRLEN);
  6266. }
  6267. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6268. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6269. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6270. char buf[INET6_ADDRSTRLEN] = {};
  6271. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6272. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6273. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6274. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6275. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6276. } else {
  6277. return std::string(buf, INET6_ADDRSTRLEN);
  6278. }
  6279. }
  6280. }
  6281. }
  6282. }
  6283. }
  6284. return addr_candidate;
  6285. }
  6286. #endif
  6287. inline socket_t create_client_socket(
  6288. const std::string &host, const std::string &ip, int port,
  6289. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6290. SocketOptions socket_options, time_t connection_timeout_sec,
  6291. time_t connection_timeout_usec, time_t read_timeout_sec,
  6292. time_t read_timeout_usec, time_t write_timeout_sec,
  6293. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6294. auto sock = create_socket(
  6295. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6296. std::move(socket_options),
  6297. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6298. if (!intf.empty()) {
  6299. #ifdef USE_IF2IP
  6300. auto ip_from_if = if2ip(address_family, intf);
  6301. if (ip_from_if.empty()) { ip_from_if = intf; }
  6302. if (!bind_ip_address(sock2, ip_from_if)) {
  6303. error = Error::BindIPAddress;
  6304. return false;
  6305. }
  6306. #endif
  6307. }
  6308. set_nonblocking(sock2, true);
  6309. auto ret =
  6310. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6311. if (ret < 0) {
  6312. if (is_connection_error()) {
  6313. error = Error::Connection;
  6314. return false;
  6315. }
  6316. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6317. connection_timeout_usec);
  6318. if (error != Error::Success) {
  6319. if (error == Error::ConnectionTimeout) { quit = true; }
  6320. return false;
  6321. }
  6322. }
  6323. set_nonblocking(sock2, false);
  6324. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6325. read_timeout_usec);
  6326. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6327. write_timeout_usec);
  6328. error = Error::Success;
  6329. return true;
  6330. },
  6331. connection_timeout_sec); // Pass DNS timeout
  6332. if (sock != INVALID_SOCKET) {
  6333. error = Error::Success;
  6334. } else {
  6335. if (error == Error::Success) { error = Error::Connection; }
  6336. }
  6337. return sock;
  6338. }
  6339. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6340. socklen_t addr_len, std::string &ip, int &port) {
  6341. if (addr.ss_family == AF_INET) {
  6342. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6343. } else if (addr.ss_family == AF_INET6) {
  6344. port =
  6345. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6346. } else {
  6347. return false;
  6348. }
  6349. std::array<char, NI_MAXHOST> ipstr{};
  6350. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6351. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6352. 0, NI_NUMERICHOST)) {
  6353. return false;
  6354. }
  6355. ip = ipstr.data();
  6356. return true;
  6357. }
  6358. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6359. struct sockaddr_storage addr;
  6360. socklen_t addr_len = sizeof(addr);
  6361. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6362. &addr_len)) {
  6363. get_ip_and_port(addr, addr_len, ip, port);
  6364. }
  6365. }
  6366. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6367. struct sockaddr_storage addr;
  6368. socklen_t addr_len = sizeof(addr);
  6369. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6370. &addr_len)) {
  6371. #ifndef _WIN32
  6372. if (addr.ss_family == AF_UNIX) {
  6373. #if defined(__linux__)
  6374. struct ucred ucred;
  6375. socklen_t len = sizeof(ucred);
  6376. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6377. port = ucred.pid;
  6378. }
  6379. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6380. pid_t pid;
  6381. socklen_t len = sizeof(pid);
  6382. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6383. port = pid;
  6384. }
  6385. #endif
  6386. return;
  6387. }
  6388. #endif
  6389. get_ip_and_port(addr, addr_len, ip, port);
  6390. }
  6391. }
  6392. inline std::string
  6393. find_content_type(const std::string &path,
  6394. const std::map<std::string, std::string> &user_data,
  6395. const std::string &default_content_type) {
  6396. auto ext = file_extension(path);
  6397. // Extensions are matched regardless of case, as web servers do, with an
  6398. // exact match to a user mapping first
  6399. auto lower_ext = case_ignore::to_lower(ext);
  6400. auto it = user_data.find(ext);
  6401. if (it == user_data.end()) { it = user_data.find(lower_ext); }
  6402. if (it != user_data.end()) { return it->second; }
  6403. static const struct {
  6404. const char *ext;
  6405. const char *type;
  6406. } types[] = {
  6407. {"css", "text/css"},
  6408. {"csv", "text/csv"},
  6409. {"htm", "text/html"},
  6410. {"html", "text/html"},
  6411. {"js", "text/javascript"},
  6412. {"mjs", "text/javascript"},
  6413. {"txt", "text/plain"},
  6414. {"vtt", "text/vtt"},
  6415. {"apng", "image/apng"},
  6416. {"avif", "image/avif"},
  6417. {"bmp", "image/bmp"},
  6418. {"gif", "image/gif"},
  6419. {"png", "image/png"},
  6420. {"svg", "image/svg+xml"},
  6421. {"webp", "image/webp"},
  6422. {"ico", "image/x-icon"},
  6423. {"tif", "image/tiff"},
  6424. {"tiff", "image/tiff"},
  6425. {"jpg", "image/jpeg"},
  6426. {"jpeg", "image/jpeg"},
  6427. {"mp4", "video/mp4"},
  6428. {"mpeg", "video/mpeg"},
  6429. {"webm", "video/webm"},
  6430. {"mp3", "audio/mp3"},
  6431. {"mpga", "audio/mpeg"},
  6432. {"weba", "audio/webm"},
  6433. {"wav", "audio/wave"},
  6434. {"otf", "font/otf"},
  6435. {"ttf", "font/ttf"},
  6436. {"woff", "font/woff"},
  6437. {"woff2", "font/woff2"},
  6438. {"7z", "application/x-7z-compressed"},
  6439. {"atom", "application/atom+xml"},
  6440. {"pdf", "application/pdf"},
  6441. {"json", "application/json"},
  6442. {"rss", "application/rss+xml"},
  6443. {"tar", "application/x-tar"},
  6444. {"xht", "application/xhtml+xml"},
  6445. {"xhtml", "application/xhtml+xml"},
  6446. {"xslt", "application/xslt+xml"},
  6447. {"xml", "application/xml"},
  6448. {"gz", "application/gzip"},
  6449. {"zip", "application/zip"},
  6450. {"wasm", "application/wasm"},
  6451. };
  6452. for (const auto &t : types) {
  6453. if (lower_ext == t.ext) { return t.type; }
  6454. }
  6455. return default_content_type;
  6456. }
  6457. inline std::string
  6458. extract_media_type(const std::string &content_type,
  6459. std::map<std::string, std::string> *params = nullptr) {
  6460. // Extract type/subtype from Content-Type value (RFC 2045)
  6461. // e.g. "application/json; charset=utf-8" -> "application/json"
  6462. auto media_type = content_type;
  6463. auto semicolon_pos = media_type.find(';');
  6464. if (semicolon_pos != std::string::npos) {
  6465. auto param_str = media_type.substr(semicolon_pos + 1);
  6466. media_type = media_type.substr(0, semicolon_pos);
  6467. if (params) {
  6468. // Parse parameters: key=value pairs separated by ';'
  6469. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6470. [&](const char *b, const char *e) {
  6471. std::string key;
  6472. std::string val;
  6473. divide_param_pair(b, e, key, val);
  6474. // Parameter names are case-insensitive (RFC 9110
  6475. // §5.6.6)
  6476. if (!key.empty()) {
  6477. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6478. trim_double_quotes_copy(val));
  6479. }
  6480. });
  6481. }
  6482. }
  6483. // Trim whitespace from media type
  6484. return trim_copy(media_type);
  6485. }
  6486. inline bool can_compress_content_type(const std::string &content_type) {
  6487. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6488. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6489. static const char *const compressible[] = {
  6490. "image/svg+xml",
  6491. "application/javascript",
  6492. "application/x-javascript",
  6493. "application/json",
  6494. "application/ld+json",
  6495. "application/xml",
  6496. "application/xhtml+xml",
  6497. "application/rss+xml",
  6498. "application/atom+xml",
  6499. "application/xslt+xml",
  6500. "application/protobuf",
  6501. };
  6502. for (auto type : compressible) {
  6503. if (mime_type == type) { return true; }
  6504. }
  6505. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6506. }
  6507. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6508. double &quality) {
  6509. quality = 1.0;
  6510. token.clear();
  6511. // Split on first ';': left = token name, right = parameters
  6512. const char *params_b = nullptr;
  6513. std::size_t params_len = 0;
  6514. divide(
  6515. b, static_cast<std::size_t>(e - b), ';',
  6516. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6517. auto r = trim(lb, lb + llen, 0, llen);
  6518. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6519. params_b = rb;
  6520. params_len = rlen;
  6521. });
  6522. if (token.empty()) { return false; }
  6523. if (params_len == 0) { return true; }
  6524. // Scan parameters for q= (stops on first match)
  6525. bool invalid = false;
  6526. split_find(params_b, params_b + params_len, ';',
  6527. (std::numeric_limits<size_t>::max)(),
  6528. [&](const char *pb, const char *pe) -> bool {
  6529. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6530. auto len = static_cast<size_t>(pe - pb);
  6531. if (len < 2) { return false; }
  6532. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6533. return false;
  6534. }
  6535. // Trim the value portion
  6536. auto r = trim(pb, pe, 2, len);
  6537. if (r.first >= r.second) {
  6538. invalid = true;
  6539. return true;
  6540. }
  6541. double v = 0.0;
  6542. auto res = from_chars(pb + r.first, pb + r.second, v);
  6543. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6544. v < 0.0 || v > 1.0) {
  6545. invalid = true;
  6546. return true;
  6547. }
  6548. quality = v;
  6549. return true;
  6550. });
  6551. return !invalid;
  6552. }
  6553. inline EncodingType encoding_type(const Request &req,
  6554. const std::string &content_type) {
  6555. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6556. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6557. if (s.empty()) { return EncodingType::None; }
  6558. // Single-pass: iterate tokens and track the best supported encoding.
  6559. // Server preference breaks ties (br > gzip > zstd).
  6560. EncodingType best = EncodingType::None;
  6561. double best_q = 0.0; // q=0 means "not acceptable"
  6562. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6563. auto priority = [](EncodingType t) -> int {
  6564. switch (t) {
  6565. case EncodingType::Brotli: return 0;
  6566. case EncodingType::Gzip: return 1;
  6567. case EncodingType::Zstd: return 2;
  6568. default: return 3;
  6569. }
  6570. };
  6571. std::string name;
  6572. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6573. double quality = 1.0;
  6574. if (!parse_quality(b, e, name, quality)) { return; }
  6575. if (quality <= 0.0) { return; }
  6576. EncodingType type = EncodingType::None;
  6577. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6578. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6579. #endif
  6580. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6581. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6582. type = EncodingType::Gzip;
  6583. }
  6584. #endif
  6585. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6586. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6587. type = EncodingType::Zstd;
  6588. }
  6589. #endif
  6590. if (type == EncodingType::None) { return; }
  6591. // Higher q-value wins; for equal q, server preference breaks ties
  6592. if (quality > best_q ||
  6593. (quality == best_q && priority(type) < priority(best))) {
  6594. best_q = quality;
  6595. best = type;
  6596. }
  6597. });
  6598. return best;
  6599. }
  6600. // `content_type` is taken separately because a file-backed response has not
  6601. // been given one yet when its coding has to be decided.
  6602. inline EncodingType encoding_type(const Request &req, const Response &res,
  6603. const std::string &content_type) {
  6604. // The response already names a content coding of its own: a handler serving
  6605. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6606. // point whose headers name the coding its files are stored in. Applying one
  6607. // on top of that would double-encode the body and append a second
  6608. // `Content-Encoding` field line.
  6609. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6610. return encoding_type(req, content_type);
  6611. }
  6612. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6613. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6614. }
  6615. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6616. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6617. if (type == EncodingType::Gzip) {
  6618. return detail::make_unique<gzip_compressor>();
  6619. }
  6620. #endif
  6621. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6622. if (type == EncodingType::Brotli) {
  6623. return detail::make_unique<brotli_compressor>();
  6624. }
  6625. #endif
  6626. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6627. if (type == EncodingType::Zstd) {
  6628. return detail::make_unique<zstd_compressor>();
  6629. }
  6630. #endif
  6631. (void)type;
  6632. return nullptr;
  6633. }
  6634. inline const char *encoding_name(EncodingType type) {
  6635. switch (type) {
  6636. case EncodingType::Gzip: return "gzip";
  6637. case EncodingType::Brotli: return "br";
  6638. case EncodingType::Zstd: return "zstd";
  6639. default: return "";
  6640. }
  6641. }
  6642. inline bool nocompressor::compress(const char *data, size_t data_length,
  6643. bool /*last*/, Callback callback) {
  6644. if (!data_length) { return true; }
  6645. return callback(data, data_length);
  6646. }
  6647. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6648. inline gzip_compressor::gzip_compressor() {
  6649. std::memset(&strm_, 0, sizeof(strm_));
  6650. strm_.zalloc = Z_NULL;
  6651. strm_.zfree = Z_NULL;
  6652. strm_.opaque = Z_NULL;
  6653. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6654. Z_DEFAULT_STRATEGY) == Z_OK;
  6655. }
  6656. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6657. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6658. bool last, Callback callback) {
  6659. assert(is_valid_);
  6660. do {
  6661. constexpr size_t max_avail_in =
  6662. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6663. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6664. (std::min)(data_length, max_avail_in));
  6665. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6666. data_length -= strm_.avail_in;
  6667. data += strm_.avail_in;
  6668. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6669. auto ret = Z_OK;
  6670. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6671. do {
  6672. strm_.avail_out = static_cast<uInt>(buff.size());
  6673. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6674. ret = deflate(&strm_, flush);
  6675. if (ret == Z_STREAM_ERROR) { return false; }
  6676. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6677. return false;
  6678. }
  6679. } while (strm_.avail_out == 0);
  6680. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6681. (flush == Z_NO_FLUSH && ret == Z_OK));
  6682. assert(strm_.avail_in == 0);
  6683. } while (data_length > 0);
  6684. return true;
  6685. }
  6686. inline gzip_decompressor::gzip_decompressor() {
  6687. std::memset(&strm_, 0, sizeof(strm_));
  6688. strm_.zalloc = Z_NULL;
  6689. strm_.zfree = Z_NULL;
  6690. strm_.opaque = Z_NULL;
  6691. // 15 is the value of wbits, which should be at the maximum possible value
  6692. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6693. // that the stream type should be automatically detected either gzip or
  6694. // deflate.
  6695. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6696. }
  6697. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6698. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6699. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6700. Callback callback) {
  6701. assert(is_valid_);
  6702. auto ret = Z_OK;
  6703. do {
  6704. constexpr size_t max_avail_in =
  6705. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6706. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6707. (std::min)(data_length, max_avail_in));
  6708. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6709. data_length -= strm_.avail_in;
  6710. data += strm_.avail_in;
  6711. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6712. while (strm_.avail_in > 0 && ret == Z_OK) {
  6713. strm_.avail_out = static_cast<uInt>(buff.size());
  6714. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6715. ret = inflate(&strm_, Z_NO_FLUSH);
  6716. assert(ret != Z_STREAM_ERROR);
  6717. switch (ret) {
  6718. case Z_NEED_DICT:
  6719. case Z_DATA_ERROR:
  6720. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6721. }
  6722. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6723. return false;
  6724. }
  6725. }
  6726. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6727. } while (data_length > 0);
  6728. return true;
  6729. }
  6730. #endif
  6731. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6732. inline brotli_compressor::brotli_compressor() {
  6733. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6734. }
  6735. inline brotli_compressor::~brotli_compressor() {
  6736. BrotliEncoderDestroyInstance(state_);
  6737. }
  6738. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6739. bool last, Callback callback) {
  6740. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6741. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6742. auto available_in = data_length;
  6743. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6744. for (;;) {
  6745. if (last) {
  6746. if (BrotliEncoderIsFinished(state_)) { break; }
  6747. } else {
  6748. if (!available_in) { break; }
  6749. }
  6750. auto available_out = buff.size();
  6751. auto next_out = buff.data();
  6752. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6753. &available_out, &next_out, nullptr)) {
  6754. return false;
  6755. }
  6756. auto output_bytes = buff.size() - available_out;
  6757. if (output_bytes) {
  6758. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6759. }
  6760. }
  6761. return true;
  6762. }
  6763. inline brotli_decompressor::brotli_decompressor() {
  6764. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6765. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6766. : BROTLI_DECODER_RESULT_ERROR;
  6767. }
  6768. inline brotli_decompressor::~brotli_decompressor() {
  6769. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6770. }
  6771. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6772. inline bool brotli_decompressor::decompress(const char *data,
  6773. size_t data_length,
  6774. Callback callback) {
  6775. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6776. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6777. return 0;
  6778. }
  6779. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6780. size_t avail_in = data_length;
  6781. size_t total_out;
  6782. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6783. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6784. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6785. char *next_out = buff.data();
  6786. size_t avail_out = buff.size();
  6787. decoder_r = BrotliDecoderDecompressStream(
  6788. decoder_s, &avail_in, &next_in, &avail_out,
  6789. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6790. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6791. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6792. }
  6793. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6794. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6795. }
  6796. #endif
  6797. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6798. inline zstd_compressor::zstd_compressor() {
  6799. ctx_ = ZSTD_createCCtx();
  6800. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6801. }
  6802. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6803. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6804. bool last, Callback callback) {
  6805. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6806. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6807. ZSTD_inBuffer input = {data, data_length, 0};
  6808. bool finished;
  6809. do {
  6810. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6811. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6812. if (ZSTD_isError(remaining)) { return false; }
  6813. if (!callback(buff.data(), output.pos)) { return false; }
  6814. finished = last ? (remaining == 0) : (input.pos == input.size);
  6815. } while (!finished);
  6816. return true;
  6817. }
  6818. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6819. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6820. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6821. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6822. Callback callback) {
  6823. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6824. ZSTD_inBuffer input = {data, data_length, 0};
  6825. while (input.pos < input.size) {
  6826. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6827. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6828. if (ZSTD_isError(remaining)) { return false; }
  6829. if (!callback(buff.data(), output.pos)) { return false; }
  6830. }
  6831. return true;
  6832. }
  6833. #endif
  6834. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6835. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6836. // unknown coding, and its payload would be handed back still compressed.
  6837. inline bool is_zlib_encoding(const std::string &encoding) {
  6838. return case_ignore::equal(encoding, "gzip") ||
  6839. case_ignore::equal(encoding, "deflate");
  6840. }
  6841. inline bool is_brotli_encoding(const std::string &encoding) {
  6842. return case_ignore::equal(encoding, "br");
  6843. }
  6844. inline bool is_zstd_encoding(const std::string &encoding) {
  6845. return case_ignore::equal(encoding, "zstd");
  6846. }
  6847. // Returns true if the content coding is one cpp-httplib is able to decompress
  6848. // when the corresponding support is compiled in.
  6849. inline bool is_known_content_encoding(const std::string &encoding) {
  6850. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6851. is_zstd_encoding(encoding);
  6852. }
  6853. inline std::unique_ptr<decompressor>
  6854. create_decompressor(const std::string &encoding) {
  6855. std::unique_ptr<decompressor> decompressor;
  6856. if (is_zlib_encoding(encoding)) {
  6857. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6858. decompressor = detail::make_unique<gzip_decompressor>();
  6859. #endif
  6860. } else if (is_brotli_encoding(encoding)) {
  6861. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6862. decompressor = detail::make_unique<brotli_decompressor>();
  6863. #endif
  6864. } else if (is_zstd_encoding(encoding)) {
  6865. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6866. decompressor = detail::make_unique<zstd_decompressor>();
  6867. #endif
  6868. }
  6869. return decompressor;
  6870. }
  6871. // Returns the best available compressor and its Content-Encoding name.
  6872. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6873. inline std::pair<std::unique_ptr<compressor>, const char *>
  6874. create_compressor() {
  6875. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6876. return {detail::make_unique<brotli_compressor>(), "br"};
  6877. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6878. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6879. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6880. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6881. #else
  6882. return {nullptr, nullptr};
  6883. #endif
  6884. }
  6885. inline bool is_prohibited_header_name(const std::string &name) {
  6886. // Field names are case-insensitive (RFC 9110 §5.1)
  6887. return case_ignore::equal(name, "REMOTE_ADDR") ||
  6888. case_ignore::equal(name, "REMOTE_PORT") ||
  6889. case_ignore::equal(name, "LOCAL_ADDR") ||
  6890. case_ignore::equal(name, "LOCAL_PORT");
  6891. }
  6892. inline bool has_header(const Headers &headers, const std::string &key) {
  6893. if (is_prohibited_header_name(key)) { return false; }
  6894. return headers.find(key) != headers.end();
  6895. }
  6896. inline const char *get_header_value(const Headers &headers,
  6897. const std::string &key, const char *def,
  6898. size_t id) {
  6899. if (is_prohibited_header_name(key)) {
  6900. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6901. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6902. throw std::invalid_argument(msg);
  6903. #else
  6904. return "";
  6905. #endif
  6906. }
  6907. auto rng = headers.equal_range(key);
  6908. auto it = bounded_next(rng.first, id, rng.second);
  6909. if (it != rng.second) { return it->second.c_str(); }
  6910. return def;
  6911. }
  6912. inline size_t get_header_value_count(const Headers &headers,
  6913. const std::string &key) {
  6914. return headers.count(key);
  6915. }
  6916. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6917. // list may be sent as several field lines, and the combined field value is
  6918. // those values joined by commas in the order they were received. Callers that
  6919. // parse such a list must work on the combined value; reading only the first
  6920. // occurrence silently drops whatever the later field lines carry.
  6921. inline std::string get_combined_header_value(const Headers &headers,
  6922. const std::string &key) {
  6923. std::string combined;
  6924. auto rng = headers.equal_range(key);
  6925. for (auto it = rng.first; it != rng.second; ++it) {
  6926. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6927. // elements, so an empty field line must not contribute a bare comma to the
  6928. // combined value.
  6929. if (it->second.empty()) { continue; }
  6930. if (!combined.empty()) { combined += ", "; }
  6931. combined += it->second;
  6932. }
  6933. return combined;
  6934. }
  6935. inline bool has_header_token(const Headers &headers, const std::string &key,
  6936. const std::string &token) {
  6937. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6938. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6939. // several lines. Match complete tokens rather than searching the raw value,
  6940. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6941. auto rng = headers.equal_range(key);
  6942. for (auto it = rng.first; it != rng.second; ++it) {
  6943. const auto &value = it->second;
  6944. if (split_find(value.data(), value.data() + value.size(), ',',
  6945. [&](const char *b, const char *e) {
  6946. return case_ignore::equal(std::string(b, e), token);
  6947. })) {
  6948. return true;
  6949. }
  6950. }
  6951. return false;
  6952. }
  6953. template <typename Map>
  6954. inline typename Map::mapped_type
  6955. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6956. auto rng = m.equal_range(key);
  6957. auto it = bounded_next(rng.first, id, rng.second);
  6958. if (it != rng.second) { return it->second; }
  6959. return typename Map::mapped_type();
  6960. }
  6961. inline void set_header(Headers &headers, const std::string &key,
  6962. const std::string &val) {
  6963. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6964. }
  6965. inline bool read_headers(Stream &strm, Headers &headers) {
  6966. const auto bufsiz = 2048;
  6967. char buf[bufsiz];
  6968. stream_line_reader line_reader(strm, buf, bufsiz);
  6969. size_t header_count = 0;
  6970. for (;;) {
  6971. if (!line_reader.getline()) { return false; }
  6972. // Check if the line ends with CRLF.
  6973. auto line_terminator_len = 2;
  6974. if (line_reader.end_with_crlf()) {
  6975. // Blank line indicates end of headers.
  6976. if (line_reader.size() == 2) { break; }
  6977. } else {
  6978. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6979. // Blank line indicates end of headers.
  6980. if (line_reader.size() == 1) { break; }
  6981. line_terminator_len = 1;
  6982. #else
  6983. continue; // Skip invalid line.
  6984. #endif
  6985. }
  6986. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6987. // Check header count limit
  6988. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6989. // Exclude line terminator
  6990. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6991. if (!parse_header(line_reader.ptr(), end,
  6992. [&](const std::string &key, const std::string &val) {
  6993. headers.emplace(key, val);
  6994. })) {
  6995. return false;
  6996. }
  6997. header_count++;
  6998. }
  6999. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7000. // headers that have different values to prevent request smuggling.
  7001. auto cl_range = headers.equal_range("Content-Length");
  7002. if (cl_range.first != cl_range.second) {
  7003. const auto &first_val = cl_range.first->second;
  7004. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7005. if (it->second != first_val) { return false; }
  7006. }
  7007. }
  7008. return true;
  7009. }
  7010. // Parsed by hand: std::regex_match recurses once per character of the reason
  7011. // phrase, which a server can make as long as a whole line.
  7012. inline bool parse_status_line(const char *line, std::string &version,
  7013. int &status, std::string &reason) {
  7014. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7015. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7016. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7017. !is_ascii_digit(line[11])) {
  7018. return false;
  7019. }
  7020. auto p = line + 12;
  7021. auto reason_begin = p;
  7022. if (*p == ' ') {
  7023. reason_begin = ++p;
  7024. p += std::strcspn(p, "\r\n");
  7025. }
  7026. auto reason_end = p;
  7027. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7028. if (*p == '\r') { p++; }
  7029. #else
  7030. if (*p++ != '\r') { return false; }
  7031. #endif
  7032. if (*p++ != '\n' || *p != '\0') { return false; }
  7033. version.assign(line, 8);
  7034. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7035. reason.assign(reason_begin, reason_end);
  7036. return true;
  7037. }
  7038. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7039. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7040. struct WebSocketUpgradeResponse {
  7041. Error error = Error::Success;
  7042. int status = -1;
  7043. Headers headers;
  7044. std::string selected_subprotocol;
  7045. };
  7046. inline bool
  7047. read_websocket_upgrade_response(Stream &strm,
  7048. const std::string &expected_accept,
  7049. const std::string &offered_subprotocols,
  7050. WebSocketUpgradeResponse &upgrade) {
  7051. // Read status line
  7052. const auto bufsiz = 2048;
  7053. char buf[bufsiz];
  7054. stream_line_reader line_reader(strm, buf, bufsiz);
  7055. if (!line_reader.getline()) {
  7056. upgrade.error = Error::Read;
  7057. return false;
  7058. }
  7059. std::string version;
  7060. std::string reason;
  7061. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  7062. upgrade.error = Error::WebSocketHandshake;
  7063. return false;
  7064. }
  7065. // Read the headers even for a rejection so the caller can see why the
  7066. // server refused the upgrade. A non-101 response may carry a body; it is
  7067. // deliberately left unread since the caller closes the socket right away.
  7068. if (!read_headers(strm, upgrade.headers)) {
  7069. upgrade.error = Error::Read;
  7070. return false;
  7071. }
  7072. const auto &headers = upgrade.headers;
  7073. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7074. upgrade.error = Error::WebSocketHandshake;
  7075. return false;
  7076. }
  7077. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7078. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7079. upgrade.error = Error::WebSocketHandshake;
  7080. return false;
  7081. }
  7082. // Verify Connection: Upgrade
  7083. if (!has_header_token(headers, "Connection", "upgrade")) {
  7084. upgrade.error = Error::WebSocketHandshake;
  7085. return false;
  7086. }
  7087. // Verify Sec-WebSocket-Accept header value
  7088. auto it = headers.find("Sec-WebSocket-Accept");
  7089. if (it == headers.end() || it->second != expected_accept) {
  7090. upgrade.error = Error::WebSocketHandshake;
  7091. return false;
  7092. }
  7093. // Extract negotiated subprotocol
  7094. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7095. if (proto_it != headers.end()) {
  7096. upgrade.selected_subprotocol = proto_it->second;
  7097. }
  7098. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7099. if (!upgrade.selected_subprotocol.empty()) {
  7100. auto was_offered = false;
  7101. split(offered_subprotocols.data(),
  7102. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7103. [&](const char *b, const char *e) {
  7104. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7105. was_offered = true;
  7106. }
  7107. });
  7108. if (!was_offered) {
  7109. upgrade.error = Error::WebSocketHandshake;
  7110. return false;
  7111. }
  7112. }
  7113. return true;
  7114. }
  7115. enum class ReadContentResult {
  7116. Success, // Successfully read the content
  7117. PayloadTooLarge, // The content exceeds the specified payload limit
  7118. Error // An error occurred while reading the content
  7119. };
  7120. inline ReadContentResult read_content_with_length(
  7121. Stream &strm, size_t len, DownloadProgress progress,
  7122. ContentReceiverWithProgress out,
  7123. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7124. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7125. detail::BodyReader br;
  7126. br.stream = &strm;
  7127. br.has_content_length = true;
  7128. br.content_length = len;
  7129. br.payload_max_length = payload_max_length;
  7130. br.chunked = false;
  7131. br.bytes_read = 0;
  7132. br.last_error = Error::Success;
  7133. size_t r = 0;
  7134. while (r < len) {
  7135. auto read_len = static_cast<size_t>(len - r);
  7136. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7137. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7138. if (n <= 0) {
  7139. // Check if it was a payload size error
  7140. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7141. return ReadContentResult::PayloadTooLarge;
  7142. }
  7143. return ReadContentResult::Error;
  7144. }
  7145. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7146. return ReadContentResult::Error;
  7147. }
  7148. r += static_cast<size_t>(n);
  7149. if (progress) {
  7150. if (!progress(r, len)) { return ReadContentResult::Error; }
  7151. }
  7152. }
  7153. return ReadContentResult::Success;
  7154. }
  7155. inline ReadContentResult
  7156. read_content_without_length(Stream &strm, size_t payload_max_length,
  7157. ContentReceiverWithProgress out) {
  7158. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7159. size_t r = 0;
  7160. for (;;) {
  7161. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7162. if (n == 0) { return ReadContentResult::Success; }
  7163. if (n < 0) { return ReadContentResult::Error; }
  7164. // Check if adding this data would exceed the payload limit
  7165. if (payload_max_length > 0 &&
  7166. (r > payload_max_length ||
  7167. payload_max_length - r < static_cast<size_t>(n))) {
  7168. return ReadContentResult::PayloadTooLarge;
  7169. }
  7170. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7171. return ReadContentResult::Error;
  7172. }
  7173. r += static_cast<size_t>(n);
  7174. }
  7175. return ReadContentResult::Success;
  7176. }
  7177. template <typename T>
  7178. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7179. size_t payload_max_length,
  7180. ContentReceiverWithProgress out) {
  7181. detail::ChunkedDecoder dec(strm);
  7182. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7183. size_t total_len = 0;
  7184. for (;;) {
  7185. size_t chunk_offset = 0;
  7186. size_t chunk_total = 0;
  7187. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7188. if (n < 0) { return ReadContentResult::Error; }
  7189. if (n == 0) {
  7190. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7191. return ReadContentResult::Error;
  7192. }
  7193. return ReadContentResult::Success;
  7194. }
  7195. if (payload_max_length > 0 &&
  7196. (total_len > payload_max_length ||
  7197. payload_max_length - total_len < static_cast<size_t>(n))) {
  7198. return ReadContentResult::PayloadTooLarge;
  7199. }
  7200. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7201. return ReadContentResult::Error;
  7202. }
  7203. total_len += static_cast<size_t>(n);
  7204. }
  7205. }
  7206. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7207. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7208. // is the final transfer coding. A single field value may list several
  7209. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7210. // several Transfer-Encoding lines, which combine into one comma-separated
  7211. // list in the order the lines were received. Headers preserves that order,
  7212. // so the final coding is the last token of the last line. Match it
  7213. // case-insensitively rather than comparing the whole value against
  7214. // "chunked".
  7215. //
  7216. // Security: reading a chunked message as unframed leaves its body in the
  7217. // socket, where a keep-alive connection parses it as a smuggled request.
  7218. // Server::process_request() answers 400 and closes when the final coding is
  7219. // not chunked, so a request whose framing cannot be determined never
  7220. // reaches the "no body" path.
  7221. auto rng = headers.equal_range("Transfer-Encoding");
  7222. if (rng.first == rng.second) { return false; }
  7223. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7224. // combined list ending in nothing rather than inheriting the line before it.
  7225. std::string last_coding;
  7226. for (auto it = rng.first; it != rng.second; ++it) {
  7227. const auto &value = it->second;
  7228. last_coding.clear();
  7229. split(value.data(), value.data() + value.size(), ',',
  7230. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7231. }
  7232. return case_ignore::equal(last_coding, "chunked");
  7233. }
  7234. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7235. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7236. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7237. return msg.has_header("Transfer-Encoding") &&
  7238. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7239. }
  7240. inline bool has_conflicting_content_length(const Headers &headers) {
  7241. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7242. // Content-Length is framed ambiguously. The body readers here delimit it by
  7243. // the transfer coding and drop Content-Length, while an intermediary may do
  7244. // the reverse, so the two disagree on where the body ends and a reused
  7245. // connection is desynchronised (request/response smuggling). Content-Length:
  7246. // 0 is tolerated for compatibility with existing peers.
  7247. return has_header(headers, "Transfer-Encoding") &&
  7248. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7249. }
  7250. template <typename T, typename U>
  7251. bool prepare_content_receiver(T &x, int &status,
  7252. ContentReceiverWithProgress receiver,
  7253. bool decompress, size_t payload_max_length,
  7254. bool &exceed_payload_max_length, U callback) {
  7255. if (decompress) {
  7256. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7257. std::unique_ptr<decompressor> decompressor;
  7258. if (!encoding.empty()) {
  7259. // A coding we know about but were not built with is an error. An
  7260. // unrecognized coding (including "identity") is left alone and the
  7261. // payload is passed through as-is, since some servers misuse the header,
  7262. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7263. decompressor = detail::create_decompressor(encoding);
  7264. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7265. status = StatusCode::UnsupportedMediaType_415;
  7266. return false;
  7267. }
  7268. }
  7269. if (decompressor) {
  7270. if (decompressor->is_valid()) {
  7271. size_t decompressed_size = 0;
  7272. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7273. size_t off, size_t len) {
  7274. return decompressor->decompress(
  7275. buf, n, [&](const char *buf2, size_t n2) {
  7276. // Guard against zip-bomb: check
  7277. // decompressed size against limit.
  7278. if (payload_max_length > 0 &&
  7279. (decompressed_size >= payload_max_length ||
  7280. n2 > payload_max_length - decompressed_size)) {
  7281. exceed_payload_max_length = true;
  7282. return false;
  7283. }
  7284. decompressed_size += n2;
  7285. return receiver(buf2, n2, off, len);
  7286. });
  7287. };
  7288. return callback(std::move(out));
  7289. } else {
  7290. status = StatusCode::InternalServerError_500;
  7291. return false;
  7292. }
  7293. }
  7294. }
  7295. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7296. size_t len) {
  7297. return receiver(buf, n, off, len);
  7298. };
  7299. return callback(std::move(out));
  7300. }
  7301. template <typename T>
  7302. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7303. DownloadProgress progress,
  7304. ContentReceiverWithProgress receiver, bool decompress) {
  7305. bool exceed_payload_max_length = false;
  7306. return prepare_content_receiver(
  7307. x, status, std::move(receiver), decompress, payload_max_length,
  7308. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7309. auto ret = true;
  7310. // Note: exceed_payload_max_length may also be set by the decompressor
  7311. // wrapper in prepare_content_receiver when the decompressed payload
  7312. // size exceeds the limit.
  7313. if (is_chunked_transfer_encoding(x.headers)) {
  7314. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7315. if (result == ReadContentResult::Success) {
  7316. ret = true;
  7317. } else if (result == ReadContentResult::PayloadTooLarge) {
  7318. exceed_payload_max_length = true;
  7319. ret = false;
  7320. } else {
  7321. ret = false;
  7322. }
  7323. } else if (!has_header(x.headers, "Content-Length")) {
  7324. auto result =
  7325. read_content_without_length(strm, payload_max_length, out);
  7326. if (result == ReadContentResult::Success) {
  7327. ret = true;
  7328. } else if (result == ReadContentResult::PayloadTooLarge) {
  7329. exceed_payload_max_length = true;
  7330. ret = false;
  7331. } else {
  7332. ret = false;
  7333. }
  7334. } else {
  7335. auto is_invalid_value = false;
  7336. auto len = get_header_value_u64(x.headers, "Content-Length",
  7337. (std::numeric_limits<size_t>::max)(),
  7338. 0, is_invalid_value);
  7339. if (is_invalid_value) {
  7340. ret = false;
  7341. } else if (len > 0) {
  7342. auto result = read_content_with_length(
  7343. strm, len, std::move(progress), out, payload_max_length);
  7344. ret = (result == ReadContentResult::Success);
  7345. if (result == ReadContentResult::PayloadTooLarge) {
  7346. exceed_payload_max_length = true;
  7347. }
  7348. }
  7349. }
  7350. if (!ret) {
  7351. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7352. : StatusCode::BadRequest_400;
  7353. }
  7354. return ret;
  7355. });
  7356. }
  7357. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7358. const std::string &path) {
  7359. // Neither the method nor the request target may carry CR/LF, SP or other
  7360. // control octets; otherwise a value smuggled into either splits the request
  7361. // line and injects headers or a whole request.
  7362. if (!fields::is_token(method)) { return -1; }
  7363. if (!fields::is_request_target(path)) { return -1; }
  7364. std::string s = method;
  7365. s += ' ';
  7366. s += path;
  7367. s += " HTTP/1.1\r\n";
  7368. return strm.write(s.data(), s.size());
  7369. }
  7370. inline ssize_t write_response_line(Stream &strm, int status) {
  7371. std::string s = "HTTP/1.1 ";
  7372. s += std::to_string(status);
  7373. s += ' ';
  7374. s += httplib::status_message(status);
  7375. s += "\r\n";
  7376. return strm.write(s.data(), s.size());
  7377. }
  7378. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7379. ssize_t write_len = 0;
  7380. for (const auto &x : headers) {
  7381. // Skip fields with invalid names or values to prevent response splitting
  7382. // via CR/LF injection, matching set_header(). The client validates request
  7383. // headers up front in check_and_write_headers, but the server passes
  7384. // res.headers straight to this writer, and res.headers is a public field
  7385. // an application can populate directly with request-derived values.
  7386. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7387. std::string s;
  7388. s = x.first;
  7389. s += ": ";
  7390. s += x.second;
  7391. s += "\r\n";
  7392. auto len = strm.write(s.data(), s.size());
  7393. if (len < 0) { return len; }
  7394. write_len += len;
  7395. }
  7396. auto len = strm.write("\r\n");
  7397. if (len < 0) { return len; }
  7398. write_len += len;
  7399. return write_len;
  7400. }
  7401. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7402. size_t offset = 0;
  7403. while (offset < l) {
  7404. auto length = strm.write(d + offset, l - offset);
  7405. if (length < 0) { return false; }
  7406. offset += static_cast<size_t>(length);
  7407. }
  7408. return true;
  7409. }
  7410. template <typename T>
  7411. inline bool write_content_with_progress(Stream &strm,
  7412. const ContentProvider &content_provider,
  7413. size_t offset, size_t length,
  7414. T is_shutting_down,
  7415. const UploadProgress &upload_progress,
  7416. Error &error) {
  7417. size_t end_offset = offset + length;
  7418. size_t start_offset = offset;
  7419. auto ok = true;
  7420. auto finished = false;
  7421. DataSink data_sink;
  7422. data_sink.write = [&](const char *d, size_t l) -> bool {
  7423. if (ok) {
  7424. // Bytes past `length` would follow the framed body, where the peer reads
  7425. // them as the next message. Write only what fits and fail the rest.
  7426. if (l > end_offset - offset) {
  7427. l = end_offset - offset;
  7428. ok = false;
  7429. }
  7430. if (write_data(strm, d, l)) {
  7431. offset += l;
  7432. if (upload_progress && length > 0) {
  7433. size_t current_written = offset - start_offset;
  7434. if (!upload_progress(current_written, length)) {
  7435. ok = false;
  7436. return false;
  7437. }
  7438. }
  7439. } else {
  7440. ok = false;
  7441. }
  7442. }
  7443. return ok;
  7444. };
  7445. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7446. // The body is framed by `length`, so a provider that reports itself done
  7447. // early has truncated it. Record that and let the short-body check below
  7448. // fail the write, rather than calling the provider again forever.
  7449. data_sink.done = [&]() { finished = true; };
  7450. while (offset < end_offset && !finished && !is_shutting_down()) {
  7451. auto last_offset = offset;
  7452. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7453. error = Error::Write;
  7454. return false;
  7455. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7456. error = Error::Canceled;
  7457. return false;
  7458. } else if (!ok) {
  7459. error = Error::Write;
  7460. return false;
  7461. }
  7462. // A provider that reports success without writing anything and without
  7463. // reporting itself done gets handed the same offset and length again on
  7464. // the next pass, so it would spin here for as long as the peer stays
  7465. // connected. Treat making no progress as a short body, like done() early.
  7466. if (!finished && offset == last_offset) {
  7467. error = Error::Write;
  7468. return false;
  7469. }
  7470. }
  7471. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7472. error = Error::Write;
  7473. return false;
  7474. }
  7475. error = Error::Success;
  7476. return true;
  7477. }
  7478. template <typename T>
  7479. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7480. size_t offset, size_t length, T is_shutting_down,
  7481. Error &error) {
  7482. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7483. is_shutting_down, nullptr, error);
  7484. }
  7485. template <typename T>
  7486. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7487. size_t offset, size_t length,
  7488. const T &is_shutting_down) {
  7489. auto error = Error::Success;
  7490. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7491. error);
  7492. }
  7493. template <typename T>
  7494. inline bool
  7495. write_content_without_length(Stream &strm,
  7496. const ContentProvider &content_provider,
  7497. const T &is_shutting_down) {
  7498. size_t offset = 0;
  7499. auto data_available = true;
  7500. auto ok = true;
  7501. DataSink data_sink;
  7502. data_sink.write = [&](const char *d, size_t l) -> bool {
  7503. if (ok) {
  7504. offset += l;
  7505. if (!write_data(strm, d, l)) { ok = false; }
  7506. }
  7507. return ok;
  7508. };
  7509. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7510. data_sink.done = [&](void) { data_available = false; };
  7511. while (data_available && !is_shutting_down()) {
  7512. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7513. return false;
  7514. } else if (!content_provider(offset, 0, data_sink)) {
  7515. return false;
  7516. } else if (!ok) {
  7517. return false;
  7518. }
  7519. }
  7520. return !data_available; // true only if done() was called, false if shutting
  7521. // down
  7522. }
  7523. // Runs a known-length content provider to completion and compresses what it
  7524. // writes into `out`, chunk by chunk, without holding the identity form.
  7525. inline bool compress_content_provider(const ContentProvider &content_provider,
  7526. size_t length, compressor &cmp,
  7527. std::string &out) {
  7528. size_t offset = 0;
  7529. auto ok = true;
  7530. auto finished = false;
  7531. DataSink data_sink;
  7532. auto append = [&](const char *data, size_t data_len) {
  7533. out.append(data, data_len);
  7534. return true;
  7535. };
  7536. data_sink.write = [&](const char *d, size_t l) -> bool {
  7537. if (!ok) { return false; }
  7538. offset += l;
  7539. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7540. return ok;
  7541. };
  7542. // The body is framed by `length`, so a provider that reports itself done
  7543. // early has truncated it; the short-body check below turns that into a
  7544. // failure rather than calling the provider again forever.
  7545. data_sink.done = [&]() { finished = true; };
  7546. while (offset < length && !finished) {
  7547. auto prev_offset = offset;
  7548. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7549. return false;
  7550. }
  7551. // No Stream to block on here, so a provider that keeps returning true
  7552. // without writing would spin. Treat a pass that made no progress as a
  7553. // failure.
  7554. if (offset == prev_offset) { return false; }
  7555. }
  7556. if (offset != length) { return false; }
  7557. return cmp.compress(nullptr, 0, true, append);
  7558. }
  7559. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7560. // and the file flag, so recording them has to come after; keeping all of it
  7561. // here means a third file-serving path cannot get that order wrong.
  7562. inline void set_file_content_provider(Response &res,
  7563. const std::shared_ptr<mmap> &m,
  7564. const std::string &content_type,
  7565. EncodingType encoding) {
  7566. // One read and one write move up to this much of the file at a time.
  7567. auto buf = std::make_shared<std::vector<char>>(
  7568. (std::min)(m->size(), size_t(256 * 1024)));
  7569. res.set_content_provider(
  7570. m->size(), content_type,
  7571. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7572. // Never read past the file, which ends the response early if it has
  7573. // shrunk since it was opened.
  7574. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7575. if (n == 0) { return false; }
  7576. sink.write(buf->data(), n);
  7577. return true;
  7578. });
  7579. res.is_file_content_provider_ = true;
  7580. res.content_coding_ = encoding;
  7581. }
  7582. template <typename T, typename U>
  7583. inline bool
  7584. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7585. const T &is_shutting_down, U &compressor, Error &error) {
  7586. size_t offset = 0;
  7587. auto data_available = true;
  7588. auto ok = true;
  7589. DataSink data_sink;
  7590. data_sink.write = [&](const char *d, size_t l) -> bool {
  7591. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7592. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7593. // zero-length chunk is the terminator, so it must not be emitted here.
  7594. if (ok && l > 0) {
  7595. offset += l;
  7596. std::string payload;
  7597. if (compressor.compress(d, l, false,
  7598. [&](const char *data, size_t data_len) {
  7599. payload.append(data, data_len);
  7600. return true;
  7601. })) {
  7602. if (!payload.empty()) {
  7603. // Emit chunked response header and footer for each chunk
  7604. auto chunk =
  7605. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7606. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7607. }
  7608. } else {
  7609. ok = false;
  7610. }
  7611. }
  7612. return ok;
  7613. };
  7614. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7615. auto done_with_trailer = [&](const Headers *trailer) {
  7616. if (!ok) { return; }
  7617. data_available = false;
  7618. std::string payload;
  7619. if (!compressor.compress(nullptr, 0, true,
  7620. [&](const char *data, size_t data_len) {
  7621. payload.append(data, data_len);
  7622. return true;
  7623. })) {
  7624. ok = false;
  7625. return;
  7626. }
  7627. if (!payload.empty()) {
  7628. // Emit chunked response header and footer for each chunk
  7629. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7630. if (!write_data(strm, chunk.data(), chunk.size())) {
  7631. ok = false;
  7632. return;
  7633. }
  7634. }
  7635. constexpr const char done_marker[] = "0\r\n";
  7636. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7637. // Trailer
  7638. if (trailer) {
  7639. for (const auto &kv : *trailer) {
  7640. // Skip fields with invalid names or values to prevent response
  7641. // splitting via CR/LF injection, matching set_header().
  7642. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7643. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7644. if (!write_data(strm, field_line.data(), field_line.size())) {
  7645. ok = false;
  7646. }
  7647. }
  7648. }
  7649. constexpr const char crlf[] = "\r\n";
  7650. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7651. };
  7652. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7653. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7654. done_with_trailer(&trailer);
  7655. };
  7656. while (data_available && !is_shutting_down()) {
  7657. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7658. error = Error::Write;
  7659. return false;
  7660. } else if (!content_provider(offset, 0, data_sink)) {
  7661. error = Error::Canceled;
  7662. return false;
  7663. } else if (!ok) {
  7664. error = Error::Write;
  7665. return false;
  7666. }
  7667. }
  7668. if (data_available) { // exited due to is_shutting_down(), not done()
  7669. error = Error::Write;
  7670. return false;
  7671. }
  7672. error = Error::Success;
  7673. return true;
  7674. }
  7675. template <typename T, typename U>
  7676. inline bool write_content_chunked(Stream &strm,
  7677. const ContentProvider &content_provider,
  7678. const T &is_shutting_down, U &compressor) {
  7679. auto error = Error::Success;
  7680. return write_content_chunked(strm, content_provider, is_shutting_down,
  7681. compressor, error);
  7682. }
  7683. template <typename T>
  7684. inline bool redirect(T &cli, Request &req, Response &res,
  7685. const std::string &path, const std::string &location,
  7686. Error &error) {
  7687. Request new_req = req;
  7688. new_req.path = path;
  7689. new_req.redirect_count_ -= 1;
  7690. if (res.status == StatusCode::SeeOther_303 &&
  7691. (req.method != "GET" && req.method != "HEAD")) {
  7692. new_req.method = "GET";
  7693. new_req.body.clear();
  7694. new_req.headers.clear();
  7695. new_req.content_length_ = 0;
  7696. new_req.content_provider_ = nullptr;
  7697. new_req.is_chunked_content_provider_ = false;
  7698. }
  7699. Response new_res;
  7700. auto ret = cli.send(new_req, new_res, error);
  7701. if (ret) {
  7702. req = std::move(new_req);
  7703. res = std::move(new_res);
  7704. if (res.location.empty()) { res.location = location; }
  7705. }
  7706. return ret;
  7707. }
  7708. inline std::string params_to_query_str(const Params &params) {
  7709. std::string query;
  7710. for (auto it = params.begin(); it != params.end(); ++it) {
  7711. if (it != params.begin()) { query += '&'; }
  7712. query += encode_query_component(it->first);
  7713. query += '=';
  7714. query += encode_query_component(it->second);
  7715. }
  7716. return query;
  7717. }
  7718. // Splits one "key=value" span of a query string at its first '='. A span with
  7719. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7720. // "?flag" keeps its name.
  7721. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7722. std::string &val) {
  7723. divide(b, static_cast<std::size_t>(e - b), '=',
  7724. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7725. std::size_t rhs_size) {
  7726. key.assign(lhs_data, lhs_size);
  7727. val.assign(rhs_data, rhs_size);
  7728. });
  7729. }
  7730. inline void parse_query_text(const char *data, std::size_t size,
  7731. Params &params) {
  7732. std::set<std::string> cache;
  7733. split(data, data + size, '&', [&](const char *b, const char *e) {
  7734. std::string kv(b, e);
  7735. if (cache.find(kv) != cache.end()) { return; }
  7736. cache.insert(std::move(kv));
  7737. std::string key;
  7738. std::string val;
  7739. divide_query_pair(b, e, key, val);
  7740. if (!key.empty()) {
  7741. params.emplace(decode_query_component(key), decode_query_component(val));
  7742. }
  7743. });
  7744. }
  7745. inline void parse_query_text(const std::string &s, Params &params) {
  7746. parse_query_text(s.data(), s.size(), params);
  7747. }
  7748. // Normalize a query string by decoding and re-encoding each key/value pair
  7749. // while preserving the original parameter order. This avoids double-encoding
  7750. // and ensures consistent encoding. It works on the raw string rather than
  7751. // parsing into Params and re-serializing, because that round trip cannot
  7752. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7753. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7754. // duplicated pairs.
  7755. inline std::string normalize_query_string(const std::string &query) {
  7756. std::string result;
  7757. split(query.data(), query.data() + query.size(), '&',
  7758. [&](const char *b, const char *e) {
  7759. std::string key;
  7760. std::string val;
  7761. divide_query_pair(b, e, key, val);
  7762. if (!key.empty()) {
  7763. auto dec_key = decode_query_component(key);
  7764. auto dec_val = decode_query_component(val);
  7765. if (!result.empty()) { result += '&'; }
  7766. result += encode_query_component(dec_key);
  7767. if (!val.empty() || std::find(b, e, '=') != e) {
  7768. result += '=';
  7769. result += encode_query_component(dec_val);
  7770. }
  7771. }
  7772. });
  7773. return result;
  7774. }
  7775. // Build the request target that goes on the wire from a caller-supplied path.
  7776. // Shared by the buffered send path and the streaming API so that both put the
  7777. // same bytes in the request line for the same input.
  7778. inline std::string encode_request_target(const std::string &uri,
  7779. bool path_encode) {
  7780. // The fragment stays with the client (RFC 9110 §7.1).
  7781. auto target = uri.substr(0, uri.find('#'));
  7782. // `substr(0, npos)` yields the whole string, which is what the no-query
  7783. // case needs.
  7784. auto query_pos = target.find('?');
  7785. auto path_part = target.substr(0, query_pos);
  7786. std::string query_part;
  7787. if (query_pos != std::string::npos) {
  7788. query_part = target.substr(query_pos + 1);
  7789. }
  7790. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7791. if (!query_part.empty()) {
  7792. // When path encoding is disabled the caller has supplied an already-encoded
  7793. // target and expects the exact bytes to be sent on the wire, so skip
  7794. // normalization for the query too. Normalizing would decode-then-re-encode
  7795. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7796. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7797. if (path_encode) {
  7798. auto normalized = normalize_query_string(query_part);
  7799. if (!normalized.empty()) {
  7800. result += '?';
  7801. result += normalized;
  7802. }
  7803. } else {
  7804. result += '?';
  7805. result += query_part;
  7806. }
  7807. }
  7808. return result;
  7809. }
  7810. inline bool parse_multipart_boundary(const std::string &content_type,
  7811. std::string &boundary) {
  7812. std::map<std::string, std::string> params;
  7813. extract_media_type(content_type, &params);
  7814. auto it = params.find("boundary");
  7815. if (it == params.end()) { return false; }
  7816. boundary = it->second;
  7817. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7818. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7819. // bytes costs a nearly full comparison at nearly every position: the
  7820. // boundary's length multiplies the worst-case cost of scanning a body.
  7821. return !boundary.empty() && boundary.size() <= 70;
  7822. }
  7823. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  7824. // here, as browsers send any other backslash, such as one in a Windows path,
  7825. // as it is.
  7826. inline std::string unquote_disposition_param(const std::string &s) {
  7827. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  7828. std::string out;
  7829. for (size_t i = 1; i + 1 < s.size(); i++) {
  7830. if (s[i] == '\\' && i + 2 < s.size() &&
  7831. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  7832. i++;
  7833. }
  7834. out += s[i];
  7835. }
  7836. return out;
  7837. }
  7838. inline void parse_disposition_params(const std::string &s, Params &params) {
  7839. std::set<std::string> cache;
  7840. split_unquoted(s.data(), s.data() + s.size(), ';',
  7841. [&](const char *b, const char *e) {
  7842. std::string kv(b, e);
  7843. if (cache.find(kv) != cache.end()) { return; }
  7844. cache.insert(kv);
  7845. std::string key;
  7846. std::string val;
  7847. divide_param_pair(b, e, key, val);
  7848. if (!key.empty()) {
  7849. params.emplace(trim_double_quotes_copy(key),
  7850. unquote_disposition_param(val));
  7851. }
  7852. });
  7853. }
  7854. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7855. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7856. #else
  7857. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7858. #endif
  7859. auto is_valid = [](const std::string &str) {
  7860. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7861. };
  7862. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7863. const auto pos = static_cast<size_t>(6);
  7864. const auto len = static_cast<size_t>(s.size() - 6);
  7865. auto all_valid_ranges = true;
  7866. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7867. if (!all_valid_ranges) { return; }
  7868. const auto it = std::find(b, e, '-');
  7869. if (it == e) {
  7870. all_valid_ranges = false;
  7871. return;
  7872. }
  7873. const auto lhs = std::string(b, it);
  7874. const auto rhs = std::string(it + 1, e);
  7875. if (!is_valid(lhs) || !is_valid(rhs)) {
  7876. all_valid_ranges = false;
  7877. return;
  7878. }
  7879. ssize_t first = -1;
  7880. if (!lhs.empty()) {
  7881. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7882. // would turn the range into a suffix range.
  7883. auto res =
  7884. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7885. if (res.ec != std::errc{}) {
  7886. all_valid_ranges = false;
  7887. return;
  7888. }
  7889. }
  7890. ssize_t last = -1;
  7891. if (!rhs.empty()) {
  7892. // An overflowing last-byte-pos is past any content length, so keeping
  7893. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7894. ssize_t v;
  7895. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7896. if (res.ec == std::errc{}) { last = v; }
  7897. }
  7898. if ((first == -1 && last == -1) ||
  7899. (first != -1 && last != -1 && first > last)) {
  7900. all_valid_ranges = false;
  7901. return;
  7902. }
  7903. ranges.emplace_back(first, last);
  7904. });
  7905. return all_valid_ranges && !ranges.empty();
  7906. }
  7907. return false;
  7908. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7909. }
  7910. #else
  7911. } catch (...) { return false; }
  7912. #endif
  7913. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7914. inline std::string remove_quoted_strings(const std::string &s) {
  7915. std::string out;
  7916. auto in_quotes = false;
  7917. for (size_t i = 0; i < s.size(); i++) {
  7918. if (s[i] == '"') {
  7919. in_quotes = !in_quotes;
  7920. } else if (!in_quotes) {
  7921. out += s[i];
  7922. } else if (s[i] == '\\') {
  7923. i++;
  7924. }
  7925. }
  7926. return out;
  7927. }
  7928. inline bool parse_accept_header(const std::string &s,
  7929. std::vector<std::string> &content_types) {
  7930. // Parameter values are not used here, so a quoted-string is dropped rather
  7931. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7932. if (s.find('"') != std::string::npos) {
  7933. return parse_accept_header(remove_quoted_strings(s), content_types);
  7934. }
  7935. content_types.clear();
  7936. // Empty string is considered valid (no preference)
  7937. if (s.empty()) { return true; }
  7938. struct AcceptEntry {
  7939. std::string media_type;
  7940. double quality;
  7941. int order;
  7942. };
  7943. std::vector<AcceptEntry> entries;
  7944. int order = 0;
  7945. bool has_invalid_entry = false;
  7946. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7947. // has to parse and ignore empty list elements, so a leading, trailing or
  7948. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7949. // split() skips them, and the header length limit bounds how many a sender
  7950. // can send, so ignoring all of them cannot be used as a denial-of-service
  7951. // vector.
  7952. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7953. std::string entry(b, e);
  7954. entry = trim_copy(entry);
  7955. AcceptEntry accept_entry;
  7956. accept_entry.order = order++;
  7957. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7958. accept_entry.media_type, accept_entry.quality)) {
  7959. has_invalid_entry = true;
  7960. return;
  7961. }
  7962. // Remove additional parameters from media type
  7963. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7964. // Basic validation of media type format
  7965. if (accept_entry.media_type.empty()) {
  7966. has_invalid_entry = true;
  7967. return;
  7968. }
  7969. // Check for basic media type format (should contain '/' or be '*')
  7970. if (accept_entry.media_type != "*" &&
  7971. accept_entry.media_type.find('/') == std::string::npos) {
  7972. has_invalid_entry = true;
  7973. return;
  7974. }
  7975. entries.push_back(std::move(accept_entry));
  7976. });
  7977. // Return false if any invalid entry was found
  7978. if (has_invalid_entry) { return false; }
  7979. // Sort by quality (descending), then by original order (ascending)
  7980. std::sort(entries.begin(), entries.end(),
  7981. [](const AcceptEntry &a, const AcceptEntry &b) {
  7982. if (a.quality != b.quality) {
  7983. return a.quality > b.quality; // Higher quality first
  7984. }
  7985. return a.order < b.order; // Earlier order first for same quality
  7986. });
  7987. // Extract sorted media types
  7988. content_types.reserve(entries.size());
  7989. for (auto &entry : entries) {
  7990. content_types.push_back(std::move(entry.media_type));
  7991. }
  7992. return true;
  7993. }
  7994. class FormDataParser {
  7995. public:
  7996. FormDataParser() = default;
  7997. void set_boundary(std::string &&boundary) {
  7998. boundary_ = std::move(boundary);
  7999. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8000. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8001. }
  8002. bool is_valid() const { return is_valid_; }
  8003. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8004. const ContentReceiver &content_callback) {
  8005. // Once the close delimiter has been seen the rest of the body is epilogue
  8006. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8007. // spread across reads is not copied in only to be erased right away.
  8008. if (state_ == 5) { return true; }
  8009. buf_append(buf, n);
  8010. while (buf_size() > 0) {
  8011. switch (state_) {
  8012. case 0: { // Initial boundary
  8013. auto pos = buf_find(dash_boundary_crlf_);
  8014. if (pos == buf_size()) {
  8015. // Not found yet: keep only a possible partial boundary at the tail so
  8016. // that a body which never contains the boundary cannot grow the
  8017. // buffer (and get rescanned from the start) without bound.
  8018. auto keep = dash_boundary_crlf_.size() - 1;
  8019. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8020. return true;
  8021. }
  8022. buf_erase(pos + dash_boundary_crlf_.size());
  8023. state_ = 1;
  8024. break;
  8025. }
  8026. case 1: { // New entry
  8027. clear_file_info();
  8028. header_searched_ = 0;
  8029. state_ = 2;
  8030. break;
  8031. }
  8032. case 2: { // Headers
  8033. // Resume where the last call stopped looking, so that a line arriving
  8034. // a few bytes at a time is not searched from its start each time.
  8035. auto pos = buf_find(crlf_, header_searched_);
  8036. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8037. while (pos < buf_size()) {
  8038. // Empty line
  8039. if (pos == 0) {
  8040. if (!header_callback(file_)) {
  8041. is_valid_ = false;
  8042. return false;
  8043. }
  8044. buf_erase(crlf_.size());
  8045. state_ = 3;
  8046. break;
  8047. }
  8048. // Check header count limit
  8049. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8050. is_valid_ = false;
  8051. return false;
  8052. }
  8053. header_count_++;
  8054. const auto header = buf_head(pos);
  8055. if (!parse_header(header.data(), header.data() + header.size(),
  8056. [&](const std::string &, const std::string &) {})) {
  8057. is_valid_ = false;
  8058. return false;
  8059. }
  8060. // Parse and emplace space trimmed headers into a map
  8061. if (!parse_header(
  8062. header.data(), header.data() + header.size(),
  8063. [&](const std::string &key, const std::string &val) {
  8064. file_.headers.emplace(key, val);
  8065. })) {
  8066. is_valid_ = false;
  8067. return false;
  8068. }
  8069. constexpr const char header_content_type[] = "Content-Type:";
  8070. if (start_with_case_ignore(header, header_content_type)) {
  8071. file_.content_type =
  8072. trim_copy(header.substr(str_len(header_content_type)));
  8073. } else {
  8074. std::string disposition_params;
  8075. if (parse_content_disposition(header, disposition_params)) {
  8076. Params params;
  8077. parse_disposition_params(disposition_params, params);
  8078. auto it = params.find("name");
  8079. if (it != params.end()) {
  8080. file_.name = it->second;
  8081. } else {
  8082. is_valid_ = false;
  8083. return false;
  8084. }
  8085. it = params.find("filename");
  8086. if (it != params.end()) { file_.filename = it->second; }
  8087. it = params.find("filename*");
  8088. if (it != params.end()) {
  8089. // RFC 5987: only UTF-8 encoding is allowed
  8090. const auto &val = it->second;
  8091. constexpr const char utf8_prefix[] = "UTF-8''";
  8092. constexpr size_t prefix_len = str_len(utf8_prefix);
  8093. if (val.size() > prefix_len &&
  8094. start_with_case_ignore(val, utf8_prefix)) {
  8095. file_.filename = decode_path_component(
  8096. val.substr(prefix_len)); // override...
  8097. } else {
  8098. is_valid_ = false;
  8099. return false;
  8100. }
  8101. }
  8102. }
  8103. }
  8104. buf_erase(pos + crlf_.size());
  8105. pos = buf_find(crlf_);
  8106. }
  8107. if (state_ != 3) {
  8108. // The CR of the CRLF may be the last byte so far.
  8109. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8110. return true;
  8111. }
  8112. break;
  8113. }
  8114. case 3: { // Body
  8115. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8116. auto pos = buf_find(crlf_dash_boundary_);
  8117. if (pos < buf_size()) {
  8118. if (!content_callback(buf_data(), pos)) {
  8119. is_valid_ = false;
  8120. return false;
  8121. }
  8122. buf_erase(pos + crlf_dash_boundary_.size());
  8123. state_ = 4;
  8124. } else {
  8125. auto len = buf_size() - crlf_dash_boundary_.size();
  8126. if (len > 0) {
  8127. if (!content_callback(buf_data(), len)) {
  8128. is_valid_ = false;
  8129. return false;
  8130. }
  8131. buf_erase(len);
  8132. }
  8133. return true;
  8134. }
  8135. break;
  8136. }
  8137. case 4: { // Boundary
  8138. if (crlf_.size() > buf_size()) { return true; }
  8139. if (buf_start_with(crlf_)) {
  8140. buf_erase(crlf_.size());
  8141. state_ = 1;
  8142. } else if (buf_start_with(dash_)) {
  8143. buf_erase(dash_.size());
  8144. is_valid_ = true;
  8145. state_ = 5;
  8146. } else {
  8147. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8148. // accepted after a boundary; RFC 2046 allows transport-padding in
  8149. // between, but this parser has never supported it. Either way the
  8150. // body is already destined to be rejected, so fail now instead of
  8151. // buffering the rest of it. Both are two bytes, so the check above
  8152. // already guarantees enough buffered data to decide.
  8153. is_valid_ = false;
  8154. return false;
  8155. }
  8156. break;
  8157. }
  8158. case 5: { // Epilogue
  8159. buf_erase(buf_size());
  8160. break;
  8161. }
  8162. }
  8163. }
  8164. return true;
  8165. }
  8166. private:
  8167. void clear_file_info() {
  8168. file_.name.clear();
  8169. file_.filename.clear();
  8170. file_.content_type.clear();
  8171. file_.headers.clear();
  8172. header_count_ = 0;
  8173. }
  8174. bool start_with_case_ignore(const std::string &a, const char *b,
  8175. size_t offset = 0) const {
  8176. const auto b_len = strlen(b);
  8177. if (a.size() < offset + b_len) { return false; }
  8178. for (size_t i = 0; i < b_len; i++) {
  8179. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8180. return false;
  8181. }
  8182. }
  8183. return true;
  8184. }
  8185. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8186. // Returns true if header matches, with the params portion in `params_out`.
  8187. bool parse_content_disposition(const std::string &header,
  8188. std::string &params_out) const {
  8189. constexpr const char prefix[] = "Content-Disposition:";
  8190. constexpr size_t prefix_len = str_len(prefix);
  8191. if (!start_with_case_ignore(header, prefix)) { return false; }
  8192. // Skip whitespace after "Content-Disposition:"
  8193. auto pos = prefix_len;
  8194. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8195. pos++;
  8196. }
  8197. // Match "form-data;" (case-insensitive)
  8198. constexpr const char form_data[] = "form-data;";
  8199. constexpr size_t form_data_len = str_len(form_data);
  8200. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8201. pos += form_data_len;
  8202. // Skip whitespace after "form-data;"
  8203. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8204. pos++;
  8205. }
  8206. params_out = header.substr(pos);
  8207. return true;
  8208. }
  8209. const std::string dash_ = "--";
  8210. const std::string crlf_ = "\r\n";
  8211. std::string boundary_;
  8212. std::string dash_boundary_crlf_;
  8213. std::string crlf_dash_boundary_;
  8214. size_t state_ = 0;
  8215. bool is_valid_ = false;
  8216. FormData file_;
  8217. size_t header_count_ = 0;
  8218. size_t header_searched_ = 0;
  8219. // Buffer
  8220. bool start_with(const std::string &a, size_t spos, size_t epos,
  8221. const std::string &b) const {
  8222. if (epos - spos < b.size()) { return false; }
  8223. for (size_t i = 0; i < b.size(); i++) {
  8224. if (a[i + spos] != b[i]) { return false; }
  8225. }
  8226. return true;
  8227. }
  8228. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8229. const char *buf_data() const { return &buf_[buf_spos_]; }
  8230. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8231. bool buf_start_with(const std::string &s) const {
  8232. return start_with(buf_, buf_spos_, buf_epos_, s);
  8233. }
  8234. size_t buf_find(const std::string &s, size_t from = 0) const {
  8235. auto c = s.front();
  8236. size_t off = buf_spos_ + from;
  8237. while (off < buf_epos_) {
  8238. auto pos = off;
  8239. while (true) {
  8240. if (pos == buf_epos_) { return buf_size(); }
  8241. if (buf_[pos] == c) { break; }
  8242. pos++;
  8243. }
  8244. auto remaining_size = buf_epos_ - pos;
  8245. if (s.size() > remaining_size) { return buf_size(); }
  8246. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8247. off = pos + 1;
  8248. }
  8249. return buf_size();
  8250. }
  8251. void buf_append(const char *data, size_t n) {
  8252. auto remaining_size = buf_size();
  8253. if (remaining_size > 0 && buf_spos_ > 0) {
  8254. for (size_t i = 0; i < remaining_size; i++) {
  8255. buf_[i] = buf_[buf_spos_ + i];
  8256. }
  8257. }
  8258. buf_spos_ = 0;
  8259. buf_epos_ = remaining_size;
  8260. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8261. for (size_t i = 0; i < n; i++) {
  8262. buf_[buf_epos_ + i] = data[i];
  8263. }
  8264. buf_epos_ += n;
  8265. }
  8266. void buf_erase(size_t size) { buf_spos_ += size; }
  8267. std::string buf_;
  8268. size_t buf_spos_ = 0;
  8269. size_t buf_epos_ = 0;
  8270. };
  8271. inline std::string random_string(size_t length) {
  8272. constexpr const char data[] =
  8273. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8274. std::string result(length, '\0');
  8275. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8276. for (auto &c : result) {
  8277. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8278. }
  8279. return result;
  8280. }
  8281. inline std::string make_multipart_data_boundary() {
  8282. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8283. }
  8284. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8285. auto valid = true;
  8286. for (size_t i = 0; i < boundary.size(); i++) {
  8287. auto c = boundary[i];
  8288. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8289. valid = false;
  8290. break;
  8291. }
  8292. }
  8293. return valid;
  8294. }
  8295. // Escape a multipart field name/filename following the WHATWG HTML standard
  8296. // ("escape a multipart form-data name"), which is what browsers send:
  8297. // '"' -> %22, CR -> %0D, LF -> %0A
  8298. // With escape_quote = false, only CR and LF are escaped; this is for header
  8299. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8300. inline std::string escape_multipart_field(const std::string &s,
  8301. bool escape_quote = true) {
  8302. std::string result;
  8303. result.reserve(s.size());
  8304. for (auto c : s) {
  8305. switch (c) {
  8306. case '"':
  8307. if (escape_quote) {
  8308. result += "%22";
  8309. } else {
  8310. result += c;
  8311. }
  8312. break;
  8313. case '\r': result += "%0D"; break;
  8314. case '\n': result += "%0A"; break;
  8315. default: result += c; break;
  8316. }
  8317. }
  8318. return result;
  8319. }
  8320. template <typename T>
  8321. inline std::string
  8322. serialize_multipart_formdata_item_begin(const T &item,
  8323. const std::string &boundary) {
  8324. std::string body = "--" + boundary + "\r\n";
  8325. body += "Content-Disposition: form-data; name=\"" +
  8326. escape_multipart_field(item.name) + "\"";
  8327. if (!item.filename.empty()) {
  8328. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8329. }
  8330. body += "\r\n";
  8331. if (!item.content_type.empty()) {
  8332. body +=
  8333. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8334. "\r\n";
  8335. }
  8336. body += "\r\n";
  8337. return body;
  8338. }
  8339. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8340. inline std::string
  8341. serialize_multipart_formdata_finish(const std::string &boundary) {
  8342. return "--" + boundary + "--\r\n";
  8343. }
  8344. inline std::string
  8345. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8346. return "multipart/form-data; boundary=" + boundary;
  8347. }
  8348. inline std::string
  8349. serialize_multipart_formdata(const UploadFormDataItems &items,
  8350. const std::string &boundary, bool finish = true) {
  8351. std::string body;
  8352. for (const auto &item : items) {
  8353. body += serialize_multipart_formdata_item_begin(item, boundary);
  8354. body += item.content + serialize_multipart_formdata_item_end();
  8355. }
  8356. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8357. return body;
  8358. }
  8359. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8360. const std::string &boundary) {
  8361. size_t total = 0;
  8362. for (const auto &item : items) {
  8363. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8364. total += item.content.size();
  8365. total += serialize_multipart_formdata_item_end().size();
  8366. }
  8367. total += serialize_multipart_formdata_finish(boundary).size();
  8368. return total;
  8369. }
  8370. struct MultipartSegment {
  8371. const char *data;
  8372. size_t size;
  8373. };
  8374. // NOTE: items must outlive the returned ContentProvider
  8375. // (safe for synchronous use inside Post/Put/Patch)
  8376. inline ContentProvider
  8377. make_multipart_content_provider(const UploadFormDataItems &items,
  8378. const std::string &boundary) {
  8379. // Own the per-item header strings and the finish string
  8380. std::vector<std::string> owned;
  8381. owned.reserve(items.size() + 1);
  8382. for (const auto &item : items)
  8383. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8384. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8385. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8386. std::vector<MultipartSegment> segs;
  8387. segs.reserve(items.size() * 3 + 1);
  8388. static const char crlf[] = "\r\n";
  8389. for (size_t i = 0; i < items.size(); i++) {
  8390. segs.push_back({owned[i].data(), owned[i].size()});
  8391. segs.push_back({items[i].content.data(), items[i].content.size()});
  8392. segs.push_back({crlf, 2});
  8393. }
  8394. segs.push_back({owned.back().data(), owned.back().size()});
  8395. struct MultipartState {
  8396. std::vector<std::string> owned;
  8397. std::vector<MultipartSegment> segs;
  8398. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8399. };
  8400. auto state = std::make_shared<MultipartState>();
  8401. state->owned = std::move(owned);
  8402. // `segs` holds raw pointers into owned strings; std::string move preserves
  8403. // the data pointer, so these pointers remain valid after the move above.
  8404. state->segs = std::move(segs);
  8405. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8406. // Buffer multiple small segments into fewer, larger writes to avoid
  8407. // excessive TCP packets when there are many form data items (#2410)
  8408. auto &buf = state->buf;
  8409. auto buf_size = buf.size();
  8410. size_t buf_len = 0;
  8411. size_t remaining = length;
  8412. // Find the first segment containing 'offset'
  8413. size_t pos = 0;
  8414. size_t seg_idx = 0;
  8415. for (; seg_idx < state->segs.size(); seg_idx++) {
  8416. const auto &seg = state->segs[seg_idx];
  8417. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8418. pos += seg.size;
  8419. }
  8420. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8421. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8422. const auto &seg = state->segs[seg_idx];
  8423. size_t available = seg.size - seg_offset;
  8424. size_t to_copy = (std::min)(available, remaining);
  8425. const char *src = seg.data + seg_offset;
  8426. seg_offset = 0; // only the first segment has a non-zero offset
  8427. while (to_copy > 0) {
  8428. size_t space = buf_size - buf_len;
  8429. size_t chunk = (std::min)(to_copy, space);
  8430. std::memcpy(buf.data() + buf_len, src, chunk);
  8431. buf_len += chunk;
  8432. src += chunk;
  8433. to_copy -= chunk;
  8434. remaining -= chunk;
  8435. if (buf_len == buf_size) {
  8436. if (!sink.write(buf.data(), buf_len)) { return false; }
  8437. buf_len = 0;
  8438. }
  8439. }
  8440. }
  8441. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8442. return true;
  8443. };
  8444. }
  8445. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8446. if (ranges.size() <= 1) return;
  8447. // Sort ranges by start position
  8448. std::sort(ranges.begin(), ranges.end(),
  8449. [](const Range &a, const Range &b) { return a.first < b.first; });
  8450. Ranges coalesced;
  8451. coalesced.reserve(ranges.size());
  8452. for (auto &r : ranges) {
  8453. auto first_pos = r.first;
  8454. auto last_pos = r.second;
  8455. // Handle special cases like in range_error
  8456. if (first_pos == -1 && last_pos == -1) {
  8457. first_pos = 0;
  8458. last_pos = static_cast<ssize_t>(content_length);
  8459. }
  8460. if (first_pos == -1) {
  8461. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8462. last_pos = static_cast<ssize_t>(content_length) - 1;
  8463. }
  8464. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8465. last_pos = static_cast<ssize_t>(content_length) - 1;
  8466. }
  8467. // Skip invalid ranges
  8468. if (!(0 <= first_pos && first_pos <= last_pos &&
  8469. last_pos < static_cast<ssize_t>(content_length))) {
  8470. continue;
  8471. }
  8472. // Coalesce with previous range if overlapping or adjacent (but not
  8473. // identical)
  8474. if (!coalesced.empty()) {
  8475. auto &prev = coalesced.back();
  8476. // Check if current range overlaps or is adjacent to previous range
  8477. // but don't coalesce identical ranges (allow duplicates)
  8478. if (first_pos <= prev.second + 1 &&
  8479. !(first_pos == prev.first && last_pos == prev.second)) {
  8480. // Extend the previous range
  8481. prev.second = (std::max)(prev.second, last_pos);
  8482. continue;
  8483. }
  8484. }
  8485. // Add new range
  8486. coalesced.emplace_back(first_pos, last_pos);
  8487. }
  8488. ranges = std::move(coalesced);
  8489. }
  8490. inline bool range_error(Request &req, Response &res) {
  8491. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8492. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8493. req.ranges.clear();
  8494. if (res.status == StatusCode::PartialContent_206) {
  8495. res.status = StatusCode::OK_200;
  8496. }
  8497. return false;
  8498. }
  8499. ssize_t content_len = static_cast<ssize_t>(
  8500. res.content_length_ ? res.content_length_ : res.body.size());
  8501. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8502. size_t overwrapping_count = 0;
  8503. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8504. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8505. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8506. // Too many ranges
  8507. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8508. for (auto &r : req.ranges) {
  8509. auto &first_pos = r.first;
  8510. auto &last_pos = r.second;
  8511. if (first_pos == -1 && last_pos == -1) {
  8512. first_pos = 0;
  8513. last_pos = content_len;
  8514. }
  8515. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8516. // selects the entire representation.
  8517. if (first_pos == -1) {
  8518. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8519. last_pos = content_len - 1;
  8520. }
  8521. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8522. // A client can limit the number of bytes requested without knowing the
  8523. // size of the selected representation. If the last-pos value is absent,
  8524. // or if the value is greater than or equal to the current length of the
  8525. // representation data, the byte range is interpreted as the remainder of
  8526. // the representation (i.e., the server replaces the value of last-pos
  8527. // with a value that is one less than the current length of the selected
  8528. // representation).
  8529. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8530. if (last_pos == -1 || last_pos >= content_len) {
  8531. last_pos = content_len - 1;
  8532. }
  8533. // Range must be within content length
  8534. if (!(0 <= first_pos && first_pos <= last_pos &&
  8535. last_pos <= content_len - 1)) {
  8536. return true;
  8537. }
  8538. // Request must not have more than two overlapping ranges
  8539. for (const auto &processed_range : processed_ranges) {
  8540. if (!(last_pos < processed_range.first ||
  8541. first_pos > processed_range.second)) {
  8542. overwrapping_count++;
  8543. if (overwrapping_count > 2) { return true; }
  8544. break; // Only count once per range
  8545. }
  8546. }
  8547. processed_ranges.emplace_back(first_pos, last_pos);
  8548. }
  8549. // After validation, coalesce overlapping ranges as per RFC 9110
  8550. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8551. }
  8552. return false;
  8553. }
  8554. inline std::pair<size_t, size_t>
  8555. get_range_offset_and_length(Range r, size_t content_length) {
  8556. assert(r.first != -1 && r.second != -1);
  8557. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8558. assert(r.first <= r.second &&
  8559. r.second < static_cast<ssize_t>(content_length));
  8560. (void)(content_length);
  8561. return std::make_pair(static_cast<size_t>(r.first),
  8562. static_cast<size_t>(r.second - r.first) + 1);
  8563. }
  8564. inline std::string make_content_range_header_field(
  8565. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8566. auto st = offset_and_length.first;
  8567. auto ed = st + offset_and_length.second - 1;
  8568. std::string field = "bytes ";
  8569. field += std::to_string(st);
  8570. field += '-';
  8571. field += std::to_string(ed);
  8572. field += '/';
  8573. field += std::to_string(content_length);
  8574. return field;
  8575. }
  8576. template <typename SToken, typename CToken, typename Content>
  8577. bool process_multipart_ranges_data(const Request &req,
  8578. const std::string &boundary,
  8579. const std::string &content_type,
  8580. size_t content_length, SToken stoken,
  8581. CToken ctoken, Content content) {
  8582. for (size_t i = 0; i < req.ranges.size(); i++) {
  8583. ctoken("--");
  8584. stoken(boundary);
  8585. ctoken("\r\n");
  8586. if (!content_type.empty()) {
  8587. ctoken("Content-Type: ");
  8588. stoken(content_type);
  8589. ctoken("\r\n");
  8590. }
  8591. auto offset_and_length =
  8592. get_range_offset_and_length(req.ranges[i], content_length);
  8593. ctoken("Content-Range: ");
  8594. stoken(make_content_range_header_field(offset_and_length, content_length));
  8595. ctoken("\r\n");
  8596. ctoken("\r\n");
  8597. if (!content(offset_and_length.first, offset_and_length.second)) {
  8598. return false;
  8599. }
  8600. ctoken("\r\n");
  8601. }
  8602. ctoken("--");
  8603. stoken(boundary);
  8604. ctoken("--");
  8605. return true;
  8606. }
  8607. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8608. const std::string &boundary,
  8609. const std::string &content_type,
  8610. size_t content_length,
  8611. std::string &data) {
  8612. process_multipart_ranges_data(
  8613. req, boundary, content_type, content_length,
  8614. [&](const std::string &token) { data += token; },
  8615. [&](const std::string &token) { data += token; },
  8616. [&](size_t offset, size_t length) {
  8617. assert(offset + length <= content_length);
  8618. data += res.body.substr(offset, length);
  8619. return true;
  8620. });
  8621. }
  8622. inline size_t get_multipart_ranges_data_length(const Request &req,
  8623. const std::string &boundary,
  8624. const std::string &content_type,
  8625. size_t content_length) {
  8626. size_t data_length = 0;
  8627. process_multipart_ranges_data(
  8628. req, boundary, content_type, content_length,
  8629. [&](const std::string &token) { data_length += token.size(); },
  8630. [&](const std::string &token) { data_length += token.size(); },
  8631. [&](size_t /*offset*/, size_t length) {
  8632. data_length += length;
  8633. return true;
  8634. });
  8635. return data_length;
  8636. }
  8637. template <typename T>
  8638. inline bool
  8639. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8640. const std::string &boundary,
  8641. const std::string &content_type,
  8642. size_t content_length, const T &is_shutting_down) {
  8643. return process_multipart_ranges_data(
  8644. req, boundary, content_type, content_length,
  8645. [&](const std::string &token) { strm.write(token); },
  8646. [&](const std::string &token) { strm.write(token); },
  8647. [&](size_t offset, size_t length) {
  8648. return write_content(strm, res.content_provider_, offset, length,
  8649. is_shutting_down);
  8650. });
  8651. }
  8652. inline bool has_framed_body(const Request &req) {
  8653. return is_chunked_transfer_encoding(req.headers) ||
  8654. req.get_header_value_u64("Content-Length") > 0;
  8655. }
  8656. inline bool is_connection_persistent(const Request &req) {
  8657. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8658. if (req.version == "HTTP/1.0" &&
  8659. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8660. return false;
  8661. }
  8662. return true;
  8663. }
  8664. inline bool expect_content(const Request &req) {
  8665. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8666. req.method == "DELETE") {
  8667. return true;
  8668. }
  8669. return has_framed_body(req);
  8670. }
  8671. #ifdef _WIN32
  8672. class WSInit {
  8673. public:
  8674. WSInit() {
  8675. WSADATA wsaData;
  8676. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8677. }
  8678. ~WSInit() {
  8679. if (is_valid_) WSACleanup();
  8680. }
  8681. bool is_valid_ = false;
  8682. };
  8683. static WSInit wsinit_;
  8684. #endif
  8685. inline std::string unescape_quoted_pairs(const std::string &s) {
  8686. std::string out;
  8687. out.reserve(s.size());
  8688. for (size_t i = 0; i < s.size(); i++) {
  8689. if (s[i] == '\\' && i + 1 < s.size()) {
  8690. out += s[++i];
  8691. } else {
  8692. out += s[i];
  8693. }
  8694. }
  8695. return out;
  8696. }
  8697. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8698. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8699. // quoted-pair, so the recipient recovers the original value.
  8700. inline std::string escape_quoted_pairs(const std::string &s) {
  8701. std::string out;
  8702. out.reserve(s.size());
  8703. for (auto c : s) {
  8704. if (c == '\\' || c == '"') { out += '\\'; }
  8705. out += c;
  8706. }
  8707. return out;
  8708. }
  8709. // RFC 9110 Section 11.6.1 defines a challenge list as
  8710. // WWW-Authenticate = #challenge
  8711. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8712. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8713. // so a server may offer several schemes, each with its own comma-separated
  8714. // auth-param list, in either order and either as separate field lines or
  8715. // packed into one. Splitting on every comma would break apart a challenge's
  8716. // own param list; splitting only on the first space would miss a Digest
  8717. // challenge that isn't first. Split on commas that aren't inside a
  8718. // quoted-string instead (split_unquoted), then track which scheme each
  8719. // resulting segment belongs to: a segment whose text before "=" contains
  8720. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8721. // leading token.
  8722. inline bool parse_www_authenticate(const Response &res,
  8723. std::map<std::string, std::string> &auth,
  8724. bool is_proxy) {
  8725. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8726. auto combined = get_combined_header_value(res.headers, auth_key);
  8727. if (combined.empty()) { return false; }
  8728. auto found_digest = false;
  8729. auto in_digest_challenge = false;
  8730. split_unquoted(
  8731. combined.data(), combined.data() + combined.size(), ',',
  8732. [&](const char *b, const char *e) {
  8733. std::string segment(b, e);
  8734. auto eq_pos = segment.find('=');
  8735. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8736. // for the first segment of a challenge, "<scheme> <key>") must be
  8737. // trimmed before its boundaries are inspected.
  8738. auto key_part = trim_copy(
  8739. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8740. auto space_pos = key_part.find_last_of(" \t");
  8741. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8742. // "<scheme>[ <key>]" starts a new challenge.
  8743. auto scheme_end =
  8744. space_pos == std::string::npos ? key_part.size() : space_pos;
  8745. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8746. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8747. // from one challenge is never paired with another's algorithm.
  8748. in_digest_challenge =
  8749. !found_digest &&
  8750. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8751. if (in_digest_challenge) { found_digest = true; }
  8752. if (space_pos == std::string::npos) {
  8753. // Bare scheme (or a token68), no auth-param on this segment.
  8754. return;
  8755. }
  8756. key_part = key_part.substr(space_pos + 1);
  8757. }
  8758. if (!in_digest_challenge) { return; }
  8759. auto val = trim_copy(segment.substr(eq_pos + 1));
  8760. auto unquoted = trim_double_quotes_copy(val);
  8761. if (unquoted.size() != val.size()) {
  8762. unquoted = unescape_quoted_pairs(unquoted);
  8763. }
  8764. auth[std::move(key_part)] = std::move(unquoted);
  8765. });
  8766. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8767. // make_digest_authentication_header() dereferences both unconditionally, so
  8768. // a challenge missing either can't produce a usable Authorization header.
  8769. // Treat it the same as no Digest challenge at all.
  8770. return found_digest && auth.find("realm") != auth.end() &&
  8771. auth.find("nonce") != auth.end();
  8772. }
  8773. class ContentProviderAdapter {
  8774. public:
  8775. explicit ContentProviderAdapter(
  8776. ContentProviderWithoutLength &&content_provider)
  8777. : content_provider_(std::move(content_provider)) {}
  8778. bool operator()(size_t offset, size_t, DataSink &sink) {
  8779. return content_provider_(offset, sink);
  8780. }
  8781. private:
  8782. ContentProviderWithoutLength content_provider_;
  8783. };
  8784. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8785. namespace fields {
  8786. inline bool is_token_char(char c) {
  8787. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8788. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8789. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8790. }
  8791. inline bool is_token(const std::string &s) {
  8792. if (s.empty()) { return false; }
  8793. for (auto c : s) {
  8794. if (!is_token_char(c)) { return false; }
  8795. }
  8796. return true;
  8797. }
  8798. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8799. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8800. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8801. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8802. inline bool is_field_content(const std::string &s) {
  8803. if (s.empty()) { return true; }
  8804. if (s.size() == 1) {
  8805. return is_field_vchar(s[0]);
  8806. } else if (s.size() == 2) {
  8807. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8808. } else {
  8809. size_t i = 0;
  8810. if (!is_field_vchar(s[i])) { return false; }
  8811. i++;
  8812. while (i < s.size() - 1) {
  8813. auto c = s[i++];
  8814. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8815. } else {
  8816. return false;
  8817. }
  8818. }
  8819. return is_field_vchar(s[i]);
  8820. }
  8821. }
  8822. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8823. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8824. return is_field_name(name) && is_field_value(value);
  8825. }
  8826. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8827. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8828. inline bool is_request_target(const std::string &s) {
  8829. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8830. }
  8831. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8832. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8833. inline bool is_host(const std::string &s) {
  8834. return std::all_of(s.begin(), s.end(), [](char c) {
  8835. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8836. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8837. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8838. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8839. });
  8840. }
  8841. } // namespace fields
  8842. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8843. WebSocketUpgradeResponse &upgrade) {
  8844. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8845. std::string key_bytes(16, '\0');
  8846. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8847. key_bytes.size());
  8848. auto client_key = base64_encode(key_bytes);
  8849. req.headers.erase("Upgrade");
  8850. req.headers.erase("Connection");
  8851. req.headers.erase("Sec-WebSocket-Key");
  8852. req.headers.erase("Sec-WebSocket-Version");
  8853. req.headers.emplace("Upgrade", "websocket");
  8854. req.headers.emplace("Connection", "Upgrade");
  8855. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8856. req.headers.emplace("Sec-WebSocket-Version", "13");
  8857. // Build the request in memory first, like ClientImpl::write_request does.
  8858. // Writing straight to the socket would leak a request line onto the wire
  8859. // before check_and_write_headers gets a chance to reject an invalid header,
  8860. // and would emit one small write per header.
  8861. BufferStream bstrm;
  8862. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8863. upgrade.error = Error::Write;
  8864. return false;
  8865. }
  8866. auto error = Error::Success;
  8867. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8868. upgrade.error = error;
  8869. return false;
  8870. }
  8871. const auto &data = bstrm.get_buffer();
  8872. if (!write_data(strm, data.data(), data.size())) {
  8873. upgrade.error = Error::Write;
  8874. return false;
  8875. }
  8876. // Verify 101 response and Sec-WebSocket-Accept header
  8877. auto expected_accept = websocket_accept_key(client_key);
  8878. auto offered_subprotocols =
  8879. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8880. return read_websocket_upgrade_response(strm, expected_accept,
  8881. offered_subprotocols, upgrade);
  8882. }
  8883. inline bool is_ip_address(const std::string &host) {
  8884. struct in_addr addr4;
  8885. struct in6_addr addr6;
  8886. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8887. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8888. }
  8889. // Resolve where a client should connect for `host`, honoring a user-supplied
  8890. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8891. // supplying the Host header and SNI; only the connection target changes.
  8892. //
  8893. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8894. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8895. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8896. // absent or empty mapping leaves `host` as the connection target; without the
  8897. // empty check the value would reach getaddrinfo as a null node and silently
  8898. // resolve to loopback.
  8899. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8900. const std::string &host, std::string &connect_host,
  8901. std::string &ip) {
  8902. connect_host = host;
  8903. ip.clear();
  8904. auto it = addr_map.find(host);
  8905. if (it == addr_map.end() || it->second.empty()) { return; }
  8906. if (is_ip_address(it->second)) {
  8907. ip = it->second;
  8908. } else {
  8909. connect_host = it->second;
  8910. }
  8911. }
  8912. } // namespace detail
  8913. /*
  8914. * Group 2: detail namespace - SSL common utilities
  8915. */
  8916. #ifdef CPPHTTPLIB_SSL_ENABLED
  8917. namespace detail {
  8918. class SSLSocketStream final : public Stream {
  8919. public:
  8920. SSLSocketStream(
  8921. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8922. time_t read_timeout_usec, time_t write_timeout_sec,
  8923. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8924. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8925. (std::chrono::steady_clock::time_point::min)());
  8926. ~SSLSocketStream() override;
  8927. bool is_readable() const override;
  8928. bool wait_readable() const override;
  8929. bool wait_writable() const override;
  8930. bool is_peer_alive() const override;
  8931. ssize_t read(char *ptr, size_t size) override;
  8932. ssize_t write(const char *ptr, size_t size) override;
  8933. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8934. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8935. socket_t socket() const override;
  8936. time_t duration() const override;
  8937. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8938. void set_max_timeout(time_t msec) override;
  8939. // See SocketStream::set_readable_hint().
  8940. void set_readable_hint() { readable_hint_ = true; }
  8941. private:
  8942. bool ensure_readable();
  8943. socket_t sock_;
  8944. tls::session_t session_;
  8945. time_t read_timeout_sec_;
  8946. time_t read_timeout_usec_;
  8947. time_t write_timeout_sec_;
  8948. time_t write_timeout_usec_;
  8949. time_t max_timeout_msec_;
  8950. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8951. bool readable_hint_ = false;
  8952. };
  8953. // A TLS stream for WebSocket connections, where the receive path and the
  8954. // send path (application send() plus the heartbeat ping thread) run on
  8955. // different threads. A single TLS session must never be entered
  8956. // concurrently, so every call into the session is serialized by one mutex.
  8957. //
  8958. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8959. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8960. // call under the lock, then waits for readiness with select() outside the
  8961. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8962. // blocked waiting for data never stalls a concurrent sender.
  8963. //
  8964. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8965. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8966. class WebSocketSSLStream final : public Stream {
  8967. public:
  8968. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8969. time_t read_timeout_sec, time_t read_timeout_usec,
  8970. time_t write_timeout_sec, time_t write_timeout_usec);
  8971. ~WebSocketSSLStream() override;
  8972. bool is_readable() const override;
  8973. bool wait_readable() const override;
  8974. bool wait_writable() const override;
  8975. ssize_t read(char *ptr, size_t size) override;
  8976. ssize_t write(const char *ptr, size_t size) override;
  8977. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8978. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8979. socket_t socket() const override;
  8980. time_t duration() const override;
  8981. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8982. private:
  8983. mutable std::mutex session_mutex_;
  8984. socket_t sock_;
  8985. tls::session_t session_;
  8986. // WebSocket::close() shortens the read timeout from the closing thread
  8987. // while the receive thread is inside wait_readable(), so these two are read
  8988. // and written concurrently. The write timeouts are never mutated.
  8989. std::atomic<time_t> read_timeout_sec_;
  8990. std::atomic<time_t> read_timeout_usec_;
  8991. time_t write_timeout_sec_;
  8992. time_t write_timeout_usec_;
  8993. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8994. };
  8995. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8996. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8997. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8998. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8999. unsigned int hash_length = 0;
  9000. unsigned char hash[EVP_MAX_MD_SIZE];
  9001. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9002. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9003. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9004. std::stringstream ss;
  9005. for (auto i = 0u; i < hash_length; ++i) {
  9006. ss << std::hex << std::setw(2) << std::setfill('0')
  9007. << static_cast<unsigned int>(hash[i]);
  9008. }
  9009. return ss.str();
  9010. }
  9011. inline std::string MD5(const std::string &s) {
  9012. return message_digest(s, EVP_md5());
  9013. }
  9014. inline std::string SHA_256(const std::string &s) {
  9015. return message_digest(s, EVP_sha256());
  9016. }
  9017. inline std::string SHA_512(const std::string &s) {
  9018. return message_digest(s, EVP_sha512());
  9019. }
  9020. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9021. namespace {
  9022. template <size_t N>
  9023. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9024. std::stringstream ss;
  9025. for (size_t i = 0; i < N; ++i) {
  9026. ss << std::hex << std::setw(2) << std::setfill('0')
  9027. << static_cast<unsigned int>(hash[i]);
  9028. }
  9029. return ss.str();
  9030. }
  9031. } // namespace
  9032. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9033. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9034. // initialized once. PSA state is process-global; do not free it.
  9035. inline bool ensure_mbedtls_psa_crypto() {
  9036. static std::once_flag once;
  9037. static bool ok = false;
  9038. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9039. return ok;
  9040. }
  9041. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9042. unsigned char *out, size_t out_size) {
  9043. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9044. size_t olen = 0;
  9045. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9046. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9047. olen == out_size;
  9048. }
  9049. #endif
  9050. inline std::string MD5(const std::string &s) {
  9051. unsigned char hash[16];
  9052. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9053. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9054. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9055. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9056. hash);
  9057. #else
  9058. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9059. hash);
  9060. #endif
  9061. return hash_to_hex(hash);
  9062. }
  9063. inline std::string SHA_256(const std::string &s) {
  9064. unsigned char hash[32];
  9065. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9066. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9067. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9068. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9069. hash, 0);
  9070. #else
  9071. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9072. s.size(), hash, 0);
  9073. #endif
  9074. return hash_to_hex(hash);
  9075. }
  9076. inline std::string SHA_512(const std::string &s) {
  9077. unsigned char hash[64];
  9078. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9079. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9080. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9081. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9082. hash, 0);
  9083. #else
  9084. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9085. s.size(), hash, 0);
  9086. #endif
  9087. return hash_to_hex(hash);
  9088. }
  9089. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9090. namespace {
  9091. template <size_t N>
  9092. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9093. std::stringstream ss;
  9094. for (size_t i = 0; i < N; ++i) {
  9095. ss << std::hex << std::setw(2) << std::setfill('0')
  9096. << static_cast<unsigned int>(hash[i]);
  9097. }
  9098. return ss.str();
  9099. }
  9100. } // namespace
  9101. inline std::string MD5(const std::string &s) {
  9102. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9103. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9104. static_cast<word32>(s.size()), hash);
  9105. return hash_to_hex(hash);
  9106. }
  9107. inline std::string SHA_256(const std::string &s) {
  9108. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9109. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9110. static_cast<word32>(s.size()), hash);
  9111. return hash_to_hex(hash);
  9112. }
  9113. inline std::string SHA_512(const std::string &s) {
  9114. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9115. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9116. static_cast<word32>(s.size()), hash);
  9117. return hash_to_hex(hash);
  9118. }
  9119. #endif
  9120. template <typename T>
  9121. inline bool process_server_socket_ssl(
  9122. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9123. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9124. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9125. time_t write_timeout_usec, T callback) {
  9126. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9127. // of a pipelined request, which keep_alive() cannot see on the socket.
  9128. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9129. write_timeout_sec, write_timeout_usec);
  9130. return process_server_socket_core(
  9131. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9132. [&]() { return strm.is_readable(); },
  9133. [&](bool socket_readable, bool close_connection,
  9134. bool &connection_closed) {
  9135. if (socket_readable) { strm.set_readable_hint(); }
  9136. return callback(strm, close_connection, connection_closed);
  9137. });
  9138. }
  9139. template <typename T>
  9140. inline bool process_client_socket_ssl(
  9141. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9142. time_t read_timeout_usec, time_t write_timeout_sec,
  9143. time_t write_timeout_usec, time_t max_timeout_msec,
  9144. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9145. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9146. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9147. start_time);
  9148. return callback(strm);
  9149. }
  9150. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9151. const Request &req, const std::map<std::string, std::string> &auth,
  9152. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  9153. const std::string &password, bool is_proxy = false) {
  9154. std::string nc;
  9155. {
  9156. std::stringstream ss;
  9157. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9158. nc = ss.str();
  9159. }
  9160. std::string qop;
  9161. if (auth.find("qop") != auth.end()) {
  9162. qop = auth.at("qop");
  9163. if (qop.find("auth-int") != std::string::npos) {
  9164. qop = "auth-int";
  9165. } else if (qop.find("auth") != std::string::npos) {
  9166. qop = "auth";
  9167. } else {
  9168. qop.clear();
  9169. }
  9170. }
  9171. std::string algo = "MD5";
  9172. if (auth.find("algorithm") != auth.end()) {
  9173. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9174. // not a token would otherwise be emitted verbatim and could carry commas
  9175. // or quotes that inject further auth-params into the header below.
  9176. const auto &a = auth.at("algorithm");
  9177. if (fields::is_token(a)) { algo = a; }
  9178. }
  9179. std::string response;
  9180. {
  9181. auto H = algo == "SHA-256" ? detail::SHA_256
  9182. : algo == "SHA-512" ? detail::SHA_512
  9183. : detail::MD5;
  9184. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9185. auto A2 = req.method + ":" + req.path;
  9186. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9187. if (qop.empty()) {
  9188. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9189. } else {
  9190. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9191. ":" + qop + ":" + H(A2));
  9192. }
  9193. }
  9194. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9195. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9196. // close the string early. realm, nonce and opaque come straight from the
  9197. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9198. // without this a crafted challenge injects extra auth-params into the header.
  9199. auto field =
  9200. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9201. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9202. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9203. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  9204. "\", algorithm=" + algo +
  9205. (qop.empty() ? ", response=\""
  9206. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9207. "\", response=\"") +
  9208. response + "\"" +
  9209. (opaque.empty()
  9210. ? ""
  9211. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9212. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9213. return std::make_pair(key, field);
  9214. }
  9215. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9216. // backend accepts the same names.
  9217. inline bool match_hostname(const std::string &pattern,
  9218. const std::string &hostname) {
  9219. // A trailing dot on the host is ignored
  9220. auto host = hostname;
  9221. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9222. // Exact match (case-insensitive)
  9223. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9224. // Split both pattern and hostname into components by '.', keeping any empty
  9225. // one, which no name may have
  9226. auto labels = [](const std::string &s) {
  9227. std::vector<std::string> v;
  9228. size_t b = 0;
  9229. while (true) {
  9230. auto e = s.find('.', b);
  9231. v.push_back(s.substr(b, e - b));
  9232. if (e == std::string::npos) { return v; }
  9233. b = e + 1;
  9234. }
  9235. };
  9236. auto pattern_components = labels(pattern);
  9237. auto host_components = labels(host);
  9238. auto has_empty_label = [](const std::vector<std::string> &v) {
  9239. return std::any_of(v.begin(), v.end(),
  9240. [](const std::string &l) { return l.empty(); });
  9241. };
  9242. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9243. return false;
  9244. }
  9245. // Component count must match
  9246. if (host_components.size() != pattern_components.size()) { return false; }
  9247. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9248. // and an IDNA label may not have one
  9249. const auto &leftmost = pattern_components.front();
  9250. if (leftmost.find('*') != std::string::npos &&
  9251. (pattern_components.size() < 3 ||
  9252. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9253. return false;
  9254. }
  9255. // Compare each component with wildcard support
  9256. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9257. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9258. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9259. auto itr = pattern_components.begin();
  9260. for (const auto &h : host_components) {
  9261. auto &p = *itr;
  9262. auto is_leftmost = itr == pattern_components.begin();
  9263. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9264. bool partial_match = false;
  9265. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9266. const auto prefix_length = p.size() - 1;
  9267. if (prefix_length == 0) {
  9268. partial_match = true;
  9269. } else if (h.size() >= prefix_length) {
  9270. partial_match =
  9271. std::equal(p.begin(),
  9272. p.begin() + static_cast<std::string::difference_type>(
  9273. prefix_length),
  9274. h.begin(), [](const char ca, const char cb) {
  9275. return detail::case_ignore::to_lower(ca) ==
  9276. detail::case_ignore::to_lower(cb);
  9277. });
  9278. }
  9279. }
  9280. if (!partial_match) { return false; }
  9281. }
  9282. ++itr;
  9283. }
  9284. return true;
  9285. }
  9286. #ifdef _WIN32
  9287. // Verify certificate using Windows CertGetCertificateChain API.
  9288. // This provides real-time certificate validation with Windows Update
  9289. // integration, independent of the TLS backend.
  9290. inline bool verify_cert_with_windows_schannel(
  9291. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9292. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9293. if (der_cert.empty()) { return false; }
  9294. out_error = 0;
  9295. // Create Windows certificate context from DER data
  9296. auto cert_context = CertCreateCertificateContext(
  9297. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9298. static_cast<DWORD>(der_cert.size()));
  9299. if (!cert_context) {
  9300. out_error = GetLastError();
  9301. return false;
  9302. }
  9303. auto cert_guard =
  9304. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9305. // Give CryptoAPI the certificates the server sent. Without them it follows
  9306. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9307. std::vector<tls::cert_t> peer_certs;
  9308. tls::get_peer_certs(session, peer_certs);
  9309. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9310. auto store_guard = scope_exit([&] {
  9311. for (auto cert : peer_certs) {
  9312. tls::free_cert(cert);
  9313. }
  9314. if (store) { CertCloseStore(store, 0); }
  9315. });
  9316. for (auto cert : peer_certs) {
  9317. std::vector<unsigned char> der;
  9318. if (store && tls::get_cert_der(cert, der)) {
  9319. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9320. static_cast<DWORD>(der.size()),
  9321. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9322. }
  9323. }
  9324. // Setup chain parameters
  9325. CERT_CHAIN_PARA chain_para = {};
  9326. chain_para.cbSize = sizeof(chain_para);
  9327. // Require the server authentication usage along the chain, which also
  9328. // rejects roots that Windows trusts only for other purposes.
  9329. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9330. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9331. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9332. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9333. // Build certificate chain with revocation checking
  9334. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9335. auto chain_result = CertGetCertificateChain(
  9336. nullptr, cert_context, nullptr, store, &chain_para,
  9337. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9338. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9339. nullptr, &chain_context);
  9340. if (!chain_result || !chain_context) {
  9341. out_error = GetLastError();
  9342. return false;
  9343. }
  9344. auto chain_guard =
  9345. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9346. // Verify SSL policy
  9347. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9348. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9349. #ifdef AUTHTYPE_SERVER
  9350. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9351. #endif
  9352. std::wstring whost;
  9353. if (verify_hostname) {
  9354. whost = u8string_to_wstring(hostname.c_str());
  9355. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9356. }
  9357. CERT_CHAIN_POLICY_PARA policy_para = {};
  9358. policy_para.cbSize = sizeof(policy_para);
  9359. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9360. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9361. #else
  9362. policy_para.dwFlags = 0;
  9363. #endif
  9364. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9365. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9366. policy_status.cbSize = sizeof(policy_status);
  9367. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9368. &policy_para, &policy_status)) {
  9369. out_error = GetLastError();
  9370. return false;
  9371. }
  9372. if (policy_status.dwError != 0) {
  9373. out_error = policy_status.dwError;
  9374. return false;
  9375. }
  9376. return true;
  9377. }
  9378. #endif // _WIN32
  9379. // Loads CA file/dir configuration and applies the system CA policy to a
  9380. // client TLS context. PEM data and native stores are applied to the context
  9381. // directly at set time; has_custom_store reflects them for the Auto policy
  9382. // decision.
  9383. inline bool load_client_ca_config(tls::ctx_t ctx,
  9384. const std::string &ca_cert_file_path,
  9385. const std::string &ca_cert_dir_path,
  9386. bool has_custom_store, SystemCAMode mode,
  9387. uint64_t &backend_error) {
  9388. auto ret = true;
  9389. if (!ca_cert_file_path.empty()) {
  9390. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9391. backend_error = tls::get_error();
  9392. ret = false;
  9393. }
  9394. } else if (!ca_cert_dir_path.empty()) {
  9395. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9396. backend_error = tls::get_error();
  9397. ret = false;
  9398. }
  9399. }
  9400. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9401. !ca_cert_dir_path.empty() || has_custom_store;
  9402. if (mode == SystemCAMode::Enabled ||
  9403. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9404. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9405. }
  9406. return ret;
  9407. }
  9408. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9409. std::vector<tls::cert_t> certs;
  9410. tls::get_ca_certs(ctx, certs);
  9411. std::string pem;
  9412. for (auto cert : certs) {
  9413. std::vector<unsigned char> der;
  9414. if (tls::get_cert_der(cert, der)) {
  9415. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9416. pem += "-----BEGIN CERTIFICATE-----\n";
  9417. for (size_t i = 0; i < b64.size(); i += 64) {
  9418. pem += b64.substr(i, 64) + "\n";
  9419. }
  9420. pem += "-----END CERTIFICATE-----\n";
  9421. }
  9422. tls::free_cert(cert);
  9423. }
  9424. return pem;
  9425. }
  9426. // The parts of session setup that only SSLClient needs, plus the handful
  9427. // WebSocketClient also exposes; everything else takes the defaults, which is
  9428. // what keeps the two clients on one implementation.
  9429. struct ClientTlsSessionOptions {
  9430. // Both SSLClient and WebSocketClient expose this independently of
  9431. // certificate verification.
  9432. bool server_hostname_verification = true;
  9433. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9434. // When non-null, guards session creation against concurrent use of the
  9435. // context. A WebSocketClient is not safe to use from several threads to
  9436. // begin with, so it passes nothing.
  9437. std::mutex *ctx_mutex = nullptr;
  9438. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9439. // The caller decides whether Schannel has anything to say about this
  9440. // connection; see SSLClient::initialize_ssl().
  9441. bool windows_cert_verification = false;
  9442. // A server certificate verifier works on the backend's chain verification,
  9443. // so the backend keeps deciding and Schannel only adds its own check.
  9444. bool server_certificate_verifier_set = false;
  9445. #endif
  9446. };
  9447. // Filled in on failure for callers that report error details.
  9448. struct ClientTlsSessionError {
  9449. Error error = Error::Success;
  9450. int ssl_error = 0;
  9451. uint64_t backend_error = 0;
  9452. };
  9453. // Establishes a client TLS session on an already connected socket. On failure
  9454. // the session is left for the caller to free: SSLClient frees it right away,
  9455. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9456. inline bool setup_client_tls_session(
  9457. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9458. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9459. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9460. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9461. using namespace tls;
  9462. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9463. if (out_error) {
  9464. out_error->error = error;
  9465. out_error->ssl_error = ssl_error;
  9466. out_error->backend_error = backend_error;
  9467. }
  9468. return false;
  9469. };
  9470. if (!ctx) {
  9471. session = nullptr;
  9472. return fail(Error::SSLConnection, 0, 0);
  9473. }
  9474. // With Windows verification on and no server certificate verifier set,
  9475. // Schannel is the only chain verifier. The backend's trust store is a
  9476. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9477. // demand, so the backend's verdict is not used.
  9478. auto windows_verifies_chain = false;
  9479. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9480. windows_verifies_chain = options.windows_cert_verification &&
  9481. !options.server_certificate_verifier_set;
  9482. #endif
  9483. {
  9484. std::unique_lock<std::mutex> guard;
  9485. if (options.ctx_mutex) {
  9486. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9487. }
  9488. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9489. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9490. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9491. // all verification post-handshake. Unless Schannel verifies the chain
  9492. // instead, chain verification happens during the handshake even for IP
  9493. // hosts; the certificate identity is verified post-handshake via
  9494. // verify_hostname().
  9495. set_verify_client(ctx, server_certificate_verification &&
  9496. !windows_verifies_chain);
  9497. #endif
  9498. session = create_session(ctx, sock);
  9499. }
  9500. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9501. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9502. // their identity is checked post-handshake below instead. On Mbed TLS and
  9503. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9504. // options.server_hostname_verification is threaded through here.
  9505. if (!is_ip_address(host)) {
  9506. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9507. return fail(Error::SSLConnection, 0, get_error());
  9508. }
  9509. }
  9510. TlsError tls_err;
  9511. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9512. &tls_err)) {
  9513. auto error = Error::SSLConnection;
  9514. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9515. error = Error::SSLServerVerification;
  9516. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9517. error = Error::SSLServerHostnameVerification;
  9518. }
  9519. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9520. }
  9521. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9522. if (options.session_verifier) {
  9523. verification_status = options.session_verifier(session);
  9524. }
  9525. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9526. return fail(Error::SSLServerVerification, 0, get_error());
  9527. }
  9528. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9529. server_certificate_verification) {
  9530. if (!windows_verifies_chain) {
  9531. auto verify_result = get_verify_result(session);
  9532. if (verify_result != 0) {
  9533. return fail(Error::SSLServerVerification, 0,
  9534. static_cast<uint64_t>(verify_result));
  9535. }
  9536. }
  9537. auto server_cert = get_peer_cert(session);
  9538. if (!server_cert) {
  9539. return fail(Error::SSLServerVerification, 0, get_error());
  9540. }
  9541. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9542. // Identity check against the peer certificate, post-handshake for all
  9543. // backends. For IP hosts this is the only identity verification, since no
  9544. // hostname is bound during the handshake.
  9545. if (options.server_hostname_verification) {
  9546. if (!verify_hostname(server_cert, host.c_str())) {
  9547. return fail(Error::SSLServerHostnameVerification, 0,
  9548. hostname_mismatch_code());
  9549. }
  9550. }
  9551. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9552. // Windows Schannel verification, which lets Windows fetch missing roots
  9553. // and intermediates on demand. It must not be skipped: unless a server
  9554. // certificate verifier is set, it is the only chain check.
  9555. if (options.windows_cert_verification) {
  9556. std::vector<unsigned char> der;
  9557. uint64_t wincrypt_error = 0;
  9558. if (!get_cert_der(server_cert, der) ||
  9559. !verify_cert_with_windows_schannel(
  9560. der, host, options.server_hostname_verification, wincrypt_error,
  9561. session)) {
  9562. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9563. }
  9564. }
  9565. #endif
  9566. }
  9567. return true;
  9568. }
  9569. } // namespace detail
  9570. #endif // CPPHTTPLIB_SSL_ENABLED
  9571. /*
  9572. * Group 3: httplib namespace - Non-SSL public API implementations
  9573. */
  9574. inline void default_socket_options(socket_t sock) {
  9575. set_socket_opt(sock, SOL_SOCKET,
  9576. #ifdef SO_REUSEPORT
  9577. SO_REUSEPORT,
  9578. #else
  9579. SO_REUSEADDR,
  9580. #endif
  9581. 1);
  9582. }
  9583. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9584. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9585. sizeof(optval));
  9586. }
  9587. inline std::string get_bearer_token_auth(const Request &req) {
  9588. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9589. // than the prefix carries no token.
  9590. constexpr const char bearer_prefix[] = "Bearer ";
  9591. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9592. auto value = req.get_header_value("Authorization");
  9593. if (value.size() >= bearer_prefix_len &&
  9594. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9595. bearer_prefix)) {
  9596. return value.substr(bearer_prefix_len);
  9597. }
  9598. return "";
  9599. }
  9600. inline const char *status_message(int status) {
  9601. switch (status) {
  9602. case StatusCode::Continue_100: return "Continue";
  9603. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9604. case StatusCode::Processing_102: return "Processing";
  9605. case StatusCode::EarlyHints_103: return "Early Hints";
  9606. case StatusCode::OK_200: return "OK";
  9607. case StatusCode::Created_201: return "Created";
  9608. case StatusCode::Accepted_202: return "Accepted";
  9609. case StatusCode::NonAuthoritativeInformation_203:
  9610. return "Non-Authoritative Information";
  9611. case StatusCode::NoContent_204: return "No Content";
  9612. case StatusCode::ResetContent_205: return "Reset Content";
  9613. case StatusCode::PartialContent_206: return "Partial Content";
  9614. case StatusCode::MultiStatus_207: return "Multi-Status";
  9615. case StatusCode::AlreadyReported_208: return "Already Reported";
  9616. case StatusCode::IMUsed_226: return "IM Used";
  9617. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9618. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9619. case StatusCode::Found_302: return "Found";
  9620. case StatusCode::SeeOther_303: return "See Other";
  9621. case StatusCode::NotModified_304: return "Not Modified";
  9622. case StatusCode::UseProxy_305: return "Use Proxy";
  9623. case StatusCode::unused_306: return "unused";
  9624. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9625. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9626. case StatusCode::BadRequest_400: return "Bad Request";
  9627. case StatusCode::Unauthorized_401: return "Unauthorized";
  9628. case StatusCode::PaymentRequired_402: return "Payment Required";
  9629. case StatusCode::Forbidden_403: return "Forbidden";
  9630. case StatusCode::NotFound_404: return "Not Found";
  9631. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9632. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9633. case StatusCode::ProxyAuthenticationRequired_407:
  9634. return "Proxy Authentication Required";
  9635. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9636. case StatusCode::Conflict_409: return "Conflict";
  9637. case StatusCode::Gone_410: return "Gone";
  9638. case StatusCode::LengthRequired_411: return "Length Required";
  9639. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9640. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9641. case StatusCode::UriTooLong_414: return "URI Too Long";
  9642. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9643. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9644. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9645. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9646. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9647. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9648. case StatusCode::Locked_423: return "Locked";
  9649. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9650. case StatusCode::TooEarly_425: return "Too Early";
  9651. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9652. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9653. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9654. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9655. return "Request Header Fields Too Large";
  9656. case StatusCode::UnavailableForLegalReasons_451:
  9657. return "Unavailable For Legal Reasons";
  9658. case StatusCode::NotImplemented_501: return "Not Implemented";
  9659. case StatusCode::BadGateway_502: return "Bad Gateway";
  9660. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9661. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9662. case StatusCode::HttpVersionNotSupported_505:
  9663. return "HTTP Version Not Supported";
  9664. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9665. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9666. case StatusCode::LoopDetected_508: return "Loop Detected";
  9667. case StatusCode::NotExtended_510: return "Not Extended";
  9668. case StatusCode::NetworkAuthenticationRequired_511:
  9669. return "Network Authentication Required";
  9670. default:
  9671. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9672. }
  9673. }
  9674. inline std::string to_string(const Error error) {
  9675. switch (error) {
  9676. case Error::Success: return "Success (no error)";
  9677. case Error::Unknown: return "Unknown";
  9678. case Error::Connection: return "Could not establish connection";
  9679. case Error::BindIPAddress: return "Failed to bind IP address";
  9680. case Error::Read: return "Failed to read connection";
  9681. case Error::Write: return "Failed to write connection";
  9682. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9683. case Error::Canceled: return "Connection handling canceled";
  9684. case Error::SSLConnection: return "SSL connection failed";
  9685. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9686. case Error::SSLServerVerification: return "SSL server verification failed";
  9687. case Error::SSLServerHostnameVerification:
  9688. return "SSL server hostname verification failed";
  9689. case Error::UnsupportedMultipartBoundaryChars:
  9690. return "Unsupported HTTP multipart boundary characters";
  9691. case Error::Compression: return "Compression failed";
  9692. case Error::ConnectionTimeout: return "Connection timed out";
  9693. case Error::ProxyConnection: return "Proxy connection failed";
  9694. case Error::ConnectionClosed: return "Connection closed by server";
  9695. case Error::Timeout: return "Read timeout";
  9696. case Error::ResourceExhaustion: return "Resource exhaustion";
  9697. case Error::TooManyFormDataFiles: return "Too many form data files";
  9698. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9699. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9700. case Error::ExceedMaxSocketDescriptorCount:
  9701. return "Exceeded maximum socket descriptor count";
  9702. case Error::InvalidRequestLine: return "Invalid request line";
  9703. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9704. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9705. case Error::InvalidHeaders: return "Invalid headers";
  9706. case Error::MultipartParsing: return "Multipart parsing failed";
  9707. case Error::OpenFile: return "Failed to open file";
  9708. case Error::Listen: return "Failed to listen on socket";
  9709. case Error::GetSockName: return "Failed to get socket name";
  9710. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9711. case Error::HTTPParsing: return "HTTP parsing failed";
  9712. case Error::InvalidRangeHeader: return "Invalid Range header";
  9713. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9714. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9715. case Error::UserCallbackException: return "User callback threw an exception";
  9716. default: break;
  9717. }
  9718. return "Invalid";
  9719. }
  9720. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9721. os << to_string(obj);
  9722. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9723. return os;
  9724. }
  9725. inline std::string hosted_at(const std::string &hostname) {
  9726. std::vector<std::string> addrs;
  9727. hosted_at(hostname, addrs);
  9728. if (addrs.empty()) { return std::string(); }
  9729. return addrs[0];
  9730. }
  9731. inline void hosted_at(const std::string &hostname,
  9732. std::vector<std::string> &addrs) {
  9733. struct addrinfo hints;
  9734. struct addrinfo *result;
  9735. memset(&hints, 0, sizeof(struct addrinfo));
  9736. hints.ai_family = AF_UNSPEC;
  9737. hints.ai_socktype = SOCK_STREAM;
  9738. hints.ai_protocol = 0;
  9739. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9740. &result, 0)) {
  9741. #if defined __linux__ && !defined __ANDROID__
  9742. res_init();
  9743. #endif
  9744. return;
  9745. }
  9746. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9747. for (auto rp = result; rp; rp = rp->ai_next) {
  9748. const auto &addr =
  9749. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9750. std::string ip;
  9751. auto dummy = -1;
  9752. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9753. dummy)) {
  9754. addrs.emplace_back(std::move(ip));
  9755. }
  9756. }
  9757. }
  9758. inline std::string encode_uri_component(const std::string &value) {
  9759. std::ostringstream escaped;
  9760. escaped.fill('0');
  9761. escaped << std::hex;
  9762. for (auto c : value) {
  9763. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9764. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9765. escaped << c;
  9766. } else {
  9767. escaped << std::uppercase;
  9768. escaped << '%' << std::setw(2)
  9769. << static_cast<int>(static_cast<unsigned char>(c));
  9770. escaped << std::nouppercase;
  9771. }
  9772. }
  9773. return escaped.str();
  9774. }
  9775. inline std::string encode_uri(const std::string &value) {
  9776. std::ostringstream escaped;
  9777. escaped.fill('0');
  9778. escaped << std::hex;
  9779. for (auto c : value) {
  9780. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9781. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9782. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9783. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9784. escaped << c;
  9785. } else {
  9786. escaped << std::uppercase;
  9787. escaped << '%' << std::setw(2)
  9788. << static_cast<int>(static_cast<unsigned char>(c));
  9789. escaped << std::nouppercase;
  9790. }
  9791. }
  9792. return escaped.str();
  9793. }
  9794. inline std::string decode_uri_component(const std::string &value) {
  9795. std::string result;
  9796. for (size_t i = 0; i < value.size(); i++) {
  9797. if (value[i] == '%' && i + 2 < value.size()) {
  9798. auto val = 0;
  9799. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9800. result += static_cast<char>(val);
  9801. i += 2;
  9802. } else {
  9803. result += value[i];
  9804. }
  9805. } else {
  9806. result += value[i];
  9807. }
  9808. }
  9809. return result;
  9810. }
  9811. inline std::string decode_uri(const std::string &value) {
  9812. std::string result;
  9813. for (size_t i = 0; i < value.size(); i++) {
  9814. if (value[i] == '%' && i + 2 < value.size()) {
  9815. auto val = 0;
  9816. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9817. auto c = static_cast<char>(val);
  9818. // Keep escapes of the reserved characters that encode_uri leaves
  9819. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9820. // delimiter is not promoted into a real one (as with JS decodeURI).
  9821. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9822. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9823. c == '#') {
  9824. result += value[i];
  9825. result += value[i + 1];
  9826. result += value[i + 2];
  9827. } else {
  9828. result += c;
  9829. }
  9830. i += 2;
  9831. } else {
  9832. result += value[i];
  9833. }
  9834. } else {
  9835. result += value[i];
  9836. }
  9837. }
  9838. return result;
  9839. }
  9840. inline std::string encode_path_component(const std::string &component) {
  9841. std::string result;
  9842. result.reserve(component.size() * 3);
  9843. for (size_t i = 0; i < component.size(); i++) {
  9844. auto c = static_cast<unsigned char>(component[i]);
  9845. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9846. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9847. c == '_' || c == '~') {
  9848. result += static_cast<char>(c);
  9849. }
  9850. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9851. // "," / ";" / "="
  9852. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9853. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9854. c == '=') {
  9855. result += static_cast<char>(c);
  9856. }
  9857. // Colon is allowed in path segments except first segment
  9858. else if (c == ':') {
  9859. result += static_cast<char>(c);
  9860. }
  9861. // @ is allowed in path
  9862. else if (c == '@') {
  9863. result += static_cast<char>(c);
  9864. } else {
  9865. result += '%';
  9866. char hex[3];
  9867. snprintf(hex, sizeof(hex), "%02X", c);
  9868. result.append(hex, 2);
  9869. }
  9870. }
  9871. return result;
  9872. }
  9873. inline std::string decode_path_component(const std::string &component) {
  9874. std::string result;
  9875. result.reserve(component.size());
  9876. for (size_t i = 0; i < component.size(); i++) {
  9877. if (component[i] == '%' && i + 1 < component.size()) {
  9878. if (component[i + 1] == 'u') {
  9879. // Unicode %uXXXX encoding
  9880. auto val = 0;
  9881. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9882. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9883. char buff[4];
  9884. size_t len = 0;
  9885. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9886. (len = detail::to_utf8(val, buff)) > 0) {
  9887. result.append(buff, len);
  9888. i += 5; // 'u0000'
  9889. } else {
  9890. // Not 4 hex digits, or a surrogate, which is no character: the
  9891. // escape is kept as it is rather than joining its neighbours
  9892. result += component[i];
  9893. }
  9894. } else {
  9895. // Standard %XX encoding
  9896. auto val = 0;
  9897. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9898. // 2 digits hex codes
  9899. result += static_cast<char>(val);
  9900. i += 2; // 'XX'
  9901. } else {
  9902. result += component[i];
  9903. }
  9904. }
  9905. } else {
  9906. result += component[i];
  9907. }
  9908. }
  9909. return result;
  9910. }
  9911. inline std::string encode_query_component(const std::string &component,
  9912. bool space_as_plus) {
  9913. std::string result;
  9914. result.reserve(component.size() * 3);
  9915. for (size_t i = 0; i < component.size(); i++) {
  9916. auto c = static_cast<unsigned char>(component[i]);
  9917. // Unreserved characters per RFC 3986
  9918. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9919. c == '_' || c == '~') {
  9920. result += static_cast<char>(c);
  9921. }
  9922. // Space handling
  9923. else if (c == ' ') {
  9924. if (space_as_plus) {
  9925. result += '+';
  9926. } else {
  9927. result += "%20";
  9928. }
  9929. }
  9930. // Plus sign handling
  9931. else if (c == '+') {
  9932. if (space_as_plus) {
  9933. result += "%2B";
  9934. } else {
  9935. result += static_cast<char>(c);
  9936. }
  9937. }
  9938. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9939. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9940. c == '*' || c == ',' || c == ';') {
  9941. result += static_cast<char>(c);
  9942. }
  9943. // Colon and @ are allowed in query
  9944. else if (c == ':' || c == '@') {
  9945. result += static_cast<char>(c);
  9946. }
  9947. // Forward slash is allowed in query values
  9948. else if (c == '/') {
  9949. result += static_cast<char>(c);
  9950. }
  9951. // Question mark is allowed in query values (after first ?)
  9952. else if (c == '?') {
  9953. result += static_cast<char>(c);
  9954. } else {
  9955. result += '%';
  9956. char hex[3];
  9957. snprintf(hex, sizeof(hex), "%02X", c);
  9958. result.append(hex, 2);
  9959. }
  9960. }
  9961. return result;
  9962. }
  9963. inline std::string decode_query_component(const std::string &component,
  9964. bool plus_as_space) {
  9965. std::string result;
  9966. result.reserve(component.size());
  9967. for (size_t i = 0; i < component.size(); i++) {
  9968. if (component[i] == '%' && i + 2 < component.size()) {
  9969. auto val = 0;
  9970. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9971. result += static_cast<char>(val);
  9972. i += 2;
  9973. } else {
  9974. result += component[i];
  9975. }
  9976. } else if (component[i] == '+' && plus_as_space) {
  9977. result += ' '; // + becomes space in form-urlencoded
  9978. } else {
  9979. result += component[i];
  9980. }
  9981. }
  9982. return result;
  9983. }
  9984. inline std::string sanitize_filename(const std::string &filename) {
  9985. // Extract basename: find the last path separator (/ or \)
  9986. auto pos = filename.find_last_of("/\\");
  9987. auto result =
  9988. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9989. // Strip null bytes
  9990. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9991. // Trim whitespace
  9992. {
  9993. auto start = result.find_first_not_of(" \t");
  9994. auto end = result.find_last_not_of(" \t");
  9995. result = (start == std::string::npos)
  9996. ? ""
  9997. : result.substr(start, end - start + 1);
  9998. }
  9999. // Reject . and ..
  10000. if (result == "." || result == "..") { return ""; }
  10001. return result;
  10002. }
  10003. inline std::string append_query_params(const std::string &path,
  10004. const Params &params) {
  10005. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10006. auto fragment_pos = path.find('#');
  10007. auto path_with_query = path.substr(0, fragment_pos);
  10008. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10009. path_with_query += detail::params_to_query_str(params);
  10010. if (fragment_pos != std::string::npos) {
  10011. path_with_query.append(path, fragment_pos, std::string::npos);
  10012. }
  10013. return path_with_query;
  10014. }
  10015. // Header utilities
  10016. inline std::pair<std::string, std::string>
  10017. make_range_header(const Ranges &ranges) {
  10018. std::string field = "bytes=";
  10019. auto i = 0;
  10020. for (const auto &r : ranges) {
  10021. if (i != 0) { field += ", "; }
  10022. if (r.first != -1) { field += std::to_string(r.first); }
  10023. field += '-';
  10024. if (r.second != -1) { field += std::to_string(r.second); }
  10025. i++;
  10026. }
  10027. return std::make_pair("Range", std::move(field));
  10028. }
  10029. inline std::pair<std::string, std::string>
  10030. make_basic_authentication_header(const std::string &username,
  10031. const std::string &password, bool is_proxy) {
  10032. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10033. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10034. return std::make_pair(key, std::move(field));
  10035. }
  10036. inline std::pair<std::string, std::string>
  10037. make_bearer_token_authentication_header(const std::string &token,
  10038. bool is_proxy = false) {
  10039. auto field = "Bearer " + token;
  10040. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10041. return std::make_pair(key, std::move(field));
  10042. }
  10043. // Request implementation
  10044. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10045. size_t id) const {
  10046. return detail::get_header_value_u64(headers, key, def, id);
  10047. }
  10048. inline bool Request::has_header(const std::string &key) const {
  10049. return detail::has_header(headers, key);
  10050. }
  10051. inline std::string Request::get_header_value(const std::string &key,
  10052. const char *def, size_t id) const {
  10053. return detail::get_header_value(headers, key, def, id);
  10054. }
  10055. inline size_t Request::get_header_value_count(const std::string &key) const {
  10056. return detail::get_header_value_count(headers, key);
  10057. }
  10058. inline void Request::set_header(const std::string &key,
  10059. const std::string &val) {
  10060. detail::set_header(headers, key, val);
  10061. }
  10062. inline bool Request::has_trailer(const std::string &key) const {
  10063. return trailers.find(key) != trailers.end();
  10064. }
  10065. inline std::string Request::get_trailer_value(const std::string &key,
  10066. size_t id) const {
  10067. return detail::get_multimap_value(trailers, key, id);
  10068. }
  10069. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10070. return trailers.count(key);
  10071. }
  10072. inline bool Request::has_param(const std::string &key) const {
  10073. return params.find(key) != params.end();
  10074. }
  10075. inline std::string Request::get_param_value(const std::string &key,
  10076. size_t id) const {
  10077. return detail::get_multimap_value(params, key, id);
  10078. }
  10079. inline std::vector<std::string>
  10080. Request::get_param_values(const std::string &key) const {
  10081. auto rng = params.equal_range(key);
  10082. std::vector<std::string> values;
  10083. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10084. for (auto it = rng.first; it != rng.second; ++it) {
  10085. values.push_back(it->second);
  10086. }
  10087. return values;
  10088. }
  10089. inline size_t Request::get_param_value_count(const std::string &key) const {
  10090. return params.count(key);
  10091. }
  10092. inline bool Request::is_multipart_form_data() const {
  10093. const auto &content_type = get_header_value("Content-Type");
  10094. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10095. "multipart/form-data");
  10096. }
  10097. // Multipart FormData implementation
  10098. inline std::string MultipartFormData::get_field(const std::string &key,
  10099. size_t id) const {
  10100. auto rng = fields.equal_range(key);
  10101. auto it = detail::bounded_next(rng.first, id, rng.second);
  10102. if (it != rng.second) { return it->second.content; }
  10103. return std::string();
  10104. }
  10105. inline std::vector<std::string>
  10106. MultipartFormData::get_fields(const std::string &key) const {
  10107. std::vector<std::string> values;
  10108. auto rng = fields.equal_range(key);
  10109. for (auto it = rng.first; it != rng.second; it++) {
  10110. values.push_back(it->second.content);
  10111. }
  10112. return values;
  10113. }
  10114. inline bool MultipartFormData::has_field(const std::string &key) const {
  10115. return fields.find(key) != fields.end();
  10116. }
  10117. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10118. return fields.count(key);
  10119. }
  10120. inline FormData MultipartFormData::get_file(const std::string &key,
  10121. size_t id) const {
  10122. return detail::get_multimap_value(files, key, id);
  10123. }
  10124. inline std::vector<FormData>
  10125. MultipartFormData::get_files(const std::string &key) const {
  10126. std::vector<FormData> values;
  10127. auto rng = files.equal_range(key);
  10128. for (auto it = rng.first; it != rng.second; it++) {
  10129. values.push_back(it->second);
  10130. }
  10131. return values;
  10132. }
  10133. inline bool MultipartFormData::has_file(const std::string &key) const {
  10134. return files.find(key) != files.end();
  10135. }
  10136. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10137. return files.count(key);
  10138. }
  10139. // Multipart FormData writer implementation
  10140. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10141. return detail::is_multipart_boundary_chars_valid(boundary);
  10142. }
  10143. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10144. : boundary_(detail::make_multipart_data_boundary()) {}
  10145. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10146. : boundary_(std::move(boundary)) {}
  10147. inline const std::string &MultipartFormDataWriter::boundary() const {
  10148. return boundary_;
  10149. }
  10150. inline std::string MultipartFormDataWriter::content_type() const {
  10151. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10152. }
  10153. inline std::string
  10154. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10155. return detail::serialize_multipart_formdata(items, boundary_);
  10156. }
  10157. inline size_t MultipartFormDataWriter::content_length(
  10158. const UploadFormDataItems &items) const {
  10159. return detail::get_multipart_content_length(items, boundary_);
  10160. }
  10161. inline std::string
  10162. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10163. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10164. }
  10165. inline std::string MultipartFormDataWriter::item_end() {
  10166. return detail::serialize_multipart_formdata_item_end();
  10167. }
  10168. inline std::string MultipartFormDataWriter::finish() const {
  10169. return detail::serialize_multipart_formdata_finish(boundary_);
  10170. }
  10171. // Response implementation
  10172. namespace detail {
  10173. // A response has one content source: `body`, a content provider, or a file.
  10174. // Each content setter calls this so that the one called last wins.
  10175. inline void clear_content_provider(Response &res) {
  10176. auto releaser = std::move(res.content_provider_resource_releaser_);
  10177. auto success = res.content_provider_success_;
  10178. res.content_length_ = 0;
  10179. res.content_provider_ = nullptr;
  10180. res.content_provider_resource_releaser_ = nullptr;
  10181. res.is_chunked_content_provider_ = false;
  10182. res.is_file_content_provider_ = false;
  10183. res.content_provider_success_ = false;
  10184. res.content_coding_ = EncodingType::None;
  10185. res.file_content_path_.clear();
  10186. res.file_content_content_type_.clear();
  10187. if (releaser) { releaser(success); }
  10188. }
  10189. inline void clear_content(Response &res) {
  10190. res.body.clear();
  10191. clear_content_provider(res);
  10192. }
  10193. // `body` is public, so it can be assigned directly after a provider or a file
  10194. // was set. It came last, so it wins.
  10195. inline void prefer_assigned_body(Response &res) {
  10196. if (!res.body.empty() &&
  10197. (res.content_provider_ || !res.file_content_path_.empty())) {
  10198. clear_content_provider(res);
  10199. }
  10200. }
  10201. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10202. inline bool body_allowed_for_status(int status) {
  10203. return status >= 200 && status != StatusCode::NoContent_204 &&
  10204. status != StatusCode::NotModified_304;
  10205. }
  10206. // Only a 206 response is served as a partial representation. range_error()
  10207. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10208. // status would start from an unchecked offset.
  10209. inline bool is_partial_content(const Request &req, const Response &res) {
  10210. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10211. }
  10212. // Sets the Content-Length or Transfer-Encoding framing the body that
  10213. // Server::write_response_core() writes. Only the library sets them: one from a
  10214. // handler would go out next to it, or describe some other body.
  10215. inline void set_framing_headers(const Request &req, Response &res,
  10216. const std::string &boundary,
  10217. const std::string &content_type) {
  10218. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10219. auto head_length = req.method == "HEAD"
  10220. ? res.get_header_value("Content-Length")
  10221. : std::string();
  10222. res.headers.erase("Content-Length");
  10223. res.headers.erase("Transfer-Encoding");
  10224. if (!body_allowed_for_status(res.status)) { return; }
  10225. if (res.content_provider_) {
  10226. if (res.content_length_ == 0) {
  10227. if (res.is_chunked_content_provider_) {
  10228. res.set_header("Transfer-Encoding", "chunked");
  10229. }
  10230. return;
  10231. }
  10232. // The part Server::write_content_with_provider() writes.
  10233. auto length = res.content_length_;
  10234. if (is_partial_content(req, res)) {
  10235. length = req.ranges.size() == 1
  10236. ? get_range_offset_and_length(req.ranges[0], length).second
  10237. : get_multipart_ranges_data_length(req, boundary,
  10238. content_type, length);
  10239. }
  10240. res.set_header("Content-Length", std::to_string(length));
  10241. } else if (!res.body.empty()) {
  10242. res.set_header("Content-Length", std::to_string(res.body.size()));
  10243. } else {
  10244. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10245. }
  10246. }
  10247. } // namespace detail
  10248. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10249. size_t id) const {
  10250. return detail::get_header_value_u64(headers, key, def, id);
  10251. }
  10252. inline bool Response::has_header(const std::string &key) const {
  10253. return headers.find(key) != headers.end();
  10254. }
  10255. inline std::string Response::get_header_value(const std::string &key,
  10256. const char *def,
  10257. size_t id) const {
  10258. return detail::get_header_value(headers, key, def, id);
  10259. }
  10260. inline size_t Response::get_header_value_count(const std::string &key) const {
  10261. return detail::get_header_value_count(headers, key);
  10262. }
  10263. inline void Response::set_header(const std::string &key,
  10264. const std::string &val) {
  10265. detail::set_header(headers, key, val);
  10266. }
  10267. inline bool Response::has_trailer(const std::string &key) const {
  10268. return trailers.find(key) != trailers.end();
  10269. }
  10270. inline std::string Response::get_trailer_value(const std::string &key,
  10271. size_t id) const {
  10272. return detail::get_multimap_value(trailers, key, id);
  10273. }
  10274. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10275. return trailers.count(key);
  10276. }
  10277. inline void Response::set_redirect(const std::string &url, int stat) {
  10278. if (detail::fields::is_field_value(url)) {
  10279. set_header("Location", url);
  10280. if (300 <= stat && stat < 400) {
  10281. this->status = stat;
  10282. } else {
  10283. this->status = StatusCode::Found_302;
  10284. }
  10285. }
  10286. }
  10287. inline void Response::set_content(const char *s, size_t n,
  10288. const std::string &content_type) {
  10289. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10290. detail::clear_content_provider(*this);
  10291. auto rng = headers.equal_range("Content-Type");
  10292. headers.erase(rng.first, rng.second);
  10293. set_header("Content-Type", content_type);
  10294. }
  10295. inline void Response::set_content(const std::string &s,
  10296. const std::string &content_type) {
  10297. set_content(s.data(), s.size(), content_type);
  10298. }
  10299. inline void Response::set_content(std::string &&s,
  10300. const std::string &content_type) {
  10301. body = std::move(s);
  10302. detail::clear_content_provider(*this);
  10303. auto rng = headers.equal_range("Content-Type");
  10304. headers.erase(rng.first, rng.second);
  10305. set_header("Content-Type", content_type);
  10306. }
  10307. inline void Response::set_content_provider(
  10308. size_t in_length, const std::string &content_type, ContentProvider provider,
  10309. ContentProviderResourceReleaser resource_releaser) {
  10310. detail::clear_content(*this);
  10311. set_header("Content-Type", content_type);
  10312. content_length_ = in_length;
  10313. if (in_length > 0) { content_provider_ = std::move(provider); }
  10314. content_provider_resource_releaser_ = std::move(resource_releaser);
  10315. }
  10316. inline void Response::set_content_provider(
  10317. const std::string &content_type, ContentProviderWithoutLength provider,
  10318. ContentProviderResourceReleaser resource_releaser) {
  10319. detail::clear_content(*this);
  10320. set_header("Content-Type", content_type);
  10321. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10322. content_provider_resource_releaser_ = std::move(resource_releaser);
  10323. }
  10324. inline void Response::set_chunked_content_provider(
  10325. const std::string &content_type, ContentProviderWithoutLength provider,
  10326. ContentProviderResourceReleaser resource_releaser) {
  10327. set_content_provider(content_type, std::move(provider),
  10328. std::move(resource_releaser));
  10329. is_chunked_content_provider_ = true;
  10330. }
  10331. inline void Response::set_file_content(const std::string &path,
  10332. const std::string &content_type) {
  10333. detail::clear_content(*this);
  10334. file_content_path_ = path;
  10335. file_content_content_type_ = content_type;
  10336. }
  10337. inline void Response::set_file_content(const std::string &path) {
  10338. set_file_content(path, std::string());
  10339. }
  10340. // Result implementation
  10341. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10342. size_t def,
  10343. size_t id) const {
  10344. return detail::get_header_value_u64(request_headers_, key, def, id);
  10345. }
  10346. inline bool Result::has_request_header(const std::string &key) const {
  10347. return request_headers_.find(key) != request_headers_.end();
  10348. }
  10349. inline std::string Result::get_request_header_value(const std::string &key,
  10350. const char *def,
  10351. size_t id) const {
  10352. return detail::get_header_value(request_headers_, key, def, id);
  10353. }
  10354. inline size_t
  10355. Result::get_request_header_value_count(const std::string &key) const {
  10356. return request_headers_.count(key);
  10357. }
  10358. // Stream implementation
  10359. inline ssize_t Stream::write(const char *ptr) {
  10360. return write(ptr, strlen(ptr));
  10361. }
  10362. inline ssize_t Stream::write(const std::string &s) {
  10363. return write(s.data(), s.size());
  10364. }
  10365. // BodyReader implementation
  10366. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10367. if (!stream) {
  10368. last_error = Error::Connection;
  10369. return -1;
  10370. }
  10371. if (eof) { return 0; }
  10372. if (!chunked) {
  10373. // Content-Length based reading
  10374. if (has_content_length && bytes_read >= content_length) {
  10375. eof = true;
  10376. return 0;
  10377. }
  10378. auto to_read = len;
  10379. if (has_content_length) {
  10380. auto remaining = content_length - bytes_read;
  10381. to_read = (std::min)(len, remaining);
  10382. }
  10383. auto n = stream->read(buf, to_read);
  10384. if (n < 0) {
  10385. last_error = stream->get_error();
  10386. if (last_error == Error::Success) { last_error = Error::Read; }
  10387. eof = true;
  10388. return n;
  10389. }
  10390. if (n == 0) {
  10391. // Unexpected EOF before content_length
  10392. last_error = stream->get_error();
  10393. if (last_error == Error::Success) { last_error = Error::Read; }
  10394. eof = true;
  10395. return 0;
  10396. }
  10397. bytes_read += static_cast<size_t>(n);
  10398. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10399. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10400. last_error = Error::ExceedMaxPayloadSize;
  10401. eof = true;
  10402. return -1;
  10403. }
  10404. return n;
  10405. }
  10406. // Chunked transfer encoding: delegate to shared decoder instance.
  10407. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10408. size_t chunk_offset = 0;
  10409. size_t chunk_total = 0;
  10410. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10411. if (n < 0) {
  10412. last_error = stream->get_error();
  10413. if (last_error == Error::Success) { last_error = Error::Read; }
  10414. eof = true;
  10415. return n;
  10416. }
  10417. if (n == 0) {
  10418. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10419. eof = true;
  10420. return 0;
  10421. }
  10422. bytes_read += static_cast<size_t>(n);
  10423. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10424. last_error = Error::ExceedMaxPayloadSize;
  10425. eof = true;
  10426. return -1;
  10427. }
  10428. return n;
  10429. }
  10430. // ThreadPool implementation
  10431. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10432. time_t idle_timeout_sec)
  10433. : base_thread_count_(n), max_queued_requests_(mqr),
  10434. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10435. shutdown_(false) {
  10436. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10437. if (max_n != 0 && max_n < n) {
  10438. std::string msg = "max_threads must be >= base_threads";
  10439. throw std::invalid_argument(msg);
  10440. }
  10441. #endif
  10442. max_thread_count_ = max_n == 0 ? n : max_n;
  10443. threads_.reserve(base_thread_count_);
  10444. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10445. try {
  10446. #endif
  10447. for (size_t i = 0; i < base_thread_count_; i++) {
  10448. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10449. }
  10450. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10451. } catch (...) {
  10452. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10453. // signal the workers we already spawned to exit and join them so the
  10454. // vector destructor does not see joinable threads (which would call
  10455. // std::terminate). Then rethrow so the caller learns of the failure.
  10456. {
  10457. std::unique_lock<std::mutex> lock(mutex_);
  10458. shutdown_ = true;
  10459. }
  10460. cond_.notify_all();
  10461. for (auto &t : threads_) {
  10462. if (t.joinable()) { t.join(); }
  10463. }
  10464. throw;
  10465. }
  10466. #endif
  10467. }
  10468. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10469. {
  10470. std::unique_lock<std::mutex> lock(mutex_);
  10471. if (shutdown_) { return false; }
  10472. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10473. return false;
  10474. }
  10475. jobs_.push_back(std::move(fn));
  10476. // Spawn a dynamic thread if no idle threads and under max
  10477. if (idle_thread_count_ == 0 &&
  10478. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10479. cleanup_finished_threads();
  10480. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10481. }
  10482. }
  10483. cond_.notify_one();
  10484. return true;
  10485. }
  10486. inline void ThreadPool::shutdown() {
  10487. {
  10488. std::unique_lock<std::mutex> lock(mutex_);
  10489. shutdown_ = true;
  10490. }
  10491. cond_.notify_all();
  10492. for (auto &t : threads_) {
  10493. if (t.joinable()) { t.join(); }
  10494. }
  10495. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10496. // with worker threads that call move_to_finished() concurrently.
  10497. std::list<std::thread> remaining_dynamic;
  10498. {
  10499. std::unique_lock<std::mutex> lock(mutex_);
  10500. remaining_dynamic = std::move(dynamic_threads_);
  10501. }
  10502. for (auto &t : remaining_dynamic) {
  10503. if (t.joinable()) { t.join(); }
  10504. }
  10505. std::unique_lock<std::mutex> lock(mutex_);
  10506. cleanup_finished_threads();
  10507. }
  10508. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10509. // Must be called with mutex_ held
  10510. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10511. if (it->get_id() == id) {
  10512. finished_threads_.push_back(std::move(*it));
  10513. dynamic_threads_.erase(it);
  10514. return;
  10515. }
  10516. }
  10517. }
  10518. inline void ThreadPool::cleanup_finished_threads() {
  10519. // Must be called with mutex_ held
  10520. for (auto &t : finished_threads_) {
  10521. if (t.joinable()) { t.join(); }
  10522. }
  10523. finished_threads_.clear();
  10524. }
  10525. inline void ThreadPool::worker(bool is_dynamic) {
  10526. for (;;) {
  10527. std::function<void()> fn;
  10528. {
  10529. std::unique_lock<std::mutex> lock(mutex_);
  10530. idle_thread_count_++;
  10531. if (is_dynamic) {
  10532. auto has_work =
  10533. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10534. [&] { return !jobs_.empty() || shutdown_; });
  10535. if (!has_work) {
  10536. // Timed out with no work - exit this dynamic thread
  10537. idle_thread_count_--;
  10538. move_to_finished(std::this_thread::get_id());
  10539. break;
  10540. }
  10541. } else {
  10542. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10543. }
  10544. idle_thread_count_--;
  10545. if (shutdown_ && jobs_.empty()) { break; }
  10546. fn = std::move(jobs_.front());
  10547. jobs_.pop_front();
  10548. }
  10549. assert(true == static_cast<bool>(fn));
  10550. fn();
  10551. }
  10552. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10553. !defined(LIBRESSL_VERSION_NUMBER)
  10554. OPENSSL_thread_stop();
  10555. #endif
  10556. }
  10557. /*
  10558. * Group 1 (continued): detail namespace - Stream implementations
  10559. */
  10560. namespace detail {
  10561. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10562. time_t timeout_sec, time_t timeout_usec,
  10563. time_t &actual_timeout_sec,
  10564. time_t &actual_timeout_usec) {
  10565. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10566. auto actual_timeout_msec =
  10567. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10568. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10569. actual_timeout_sec = actual_timeout_msec / 1000;
  10570. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10571. }
  10572. // Socket stream implementation
  10573. inline SocketStream::SocketStream(
  10574. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10575. time_t write_timeout_sec, time_t write_timeout_usec,
  10576. time_t max_timeout_msec,
  10577. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10578. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10579. read_timeout_usec_(read_timeout_usec),
  10580. write_timeout_sec_(write_timeout_sec),
  10581. write_timeout_usec_(write_timeout_usec),
  10582. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10583. read_buff_(read_buff_size_, 0) {}
  10584. inline SocketStream::~SocketStream() = default;
  10585. inline bool SocketStream::is_readable() const {
  10586. return read_buff_off_ < read_buff_content_size_;
  10587. }
  10588. inline bool SocketStream::wait_readable() const {
  10589. if (max_timeout_msec_ <= 0) {
  10590. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10591. }
  10592. time_t read_timeout_sec;
  10593. time_t read_timeout_usec;
  10594. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10595. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10596. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10597. }
  10598. inline bool SocketStream::wait_writable() const {
  10599. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10600. }
  10601. inline bool SocketStream::ensure_readable() {
  10602. if (readable_hint_) {
  10603. readable_hint_ = false;
  10604. return true;
  10605. }
  10606. return wait_readable();
  10607. }
  10608. inline const char *SocketStream::buffered_data(size_t &size) const {
  10609. size = read_buff_content_size_ - read_buff_off_;
  10610. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10611. }
  10612. inline void SocketStream::consume_buffered(size_t size) {
  10613. assert(size <= read_buff_content_size_ - read_buff_off_);
  10614. read_buff_off_ += size;
  10615. }
  10616. inline bool SocketStream::is_peer_alive() const {
  10617. return detail::is_socket_alive(sock_);
  10618. }
  10619. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10620. #ifdef _WIN32
  10621. size =
  10622. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10623. #else
  10624. size = (std::min)(size,
  10625. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10626. #endif
  10627. if (read_buff_off_ < read_buff_content_size_) {
  10628. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10629. if (size <= remaining_size) {
  10630. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10631. read_buff_off_ += size;
  10632. return static_cast<ssize_t>(size);
  10633. } else {
  10634. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10635. read_buff_off_ += remaining_size;
  10636. return static_cast<ssize_t>(remaining_size);
  10637. }
  10638. }
  10639. if (!ensure_readable()) {
  10640. error_ = Error::Timeout;
  10641. return -1;
  10642. }
  10643. read_buff_off_ = 0;
  10644. read_buff_content_size_ = 0;
  10645. if (size < read_buff_size_) {
  10646. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10647. CPPHTTPLIB_RECV_FLAGS);
  10648. if (n <= 0) {
  10649. if (n == 0) {
  10650. error_ = Error::ConnectionClosed;
  10651. } else {
  10652. error_ = Error::Read;
  10653. }
  10654. return n;
  10655. } else if (n <= static_cast<ssize_t>(size)) {
  10656. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10657. return n;
  10658. } else {
  10659. memcpy(ptr, read_buff_.data(), size);
  10660. read_buff_off_ = size;
  10661. read_buff_content_size_ = static_cast<size_t>(n);
  10662. return static_cast<ssize_t>(size);
  10663. }
  10664. } else {
  10665. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10666. if (n <= 0) {
  10667. if (n == 0) {
  10668. error_ = Error::ConnectionClosed;
  10669. } else {
  10670. error_ = Error::Read;
  10671. }
  10672. }
  10673. return n;
  10674. }
  10675. }
  10676. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10677. if (!wait_writable()) { return -1; }
  10678. #if defined(_WIN32) && !defined(_WIN64)
  10679. size =
  10680. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10681. #endif
  10682. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10683. }
  10684. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10685. int &port) const {
  10686. return detail::get_remote_ip_and_port(sock_, ip, port);
  10687. }
  10688. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10689. int &port) const {
  10690. return detail::get_local_ip_and_port(sock_, ip, port);
  10691. }
  10692. inline socket_t SocketStream::socket() const { return sock_; }
  10693. inline time_t SocketStream::duration() const {
  10694. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10695. std::chrono::steady_clock::now() - start_time_)
  10696. .count();
  10697. }
  10698. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10699. read_timeout_sec_ = sec;
  10700. read_timeout_usec_ = usec;
  10701. }
  10702. inline void SocketStream::set_max_timeout(time_t msec) {
  10703. max_timeout_msec_ = msec;
  10704. start_time_ = std::chrono::steady_clock::now();
  10705. }
  10706. // Buffer stream implementation
  10707. inline bool BufferStream::is_readable() const { return true; }
  10708. inline bool BufferStream::wait_readable() const { return true; }
  10709. inline bool BufferStream::wait_writable() const { return true; }
  10710. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10711. #if defined(_MSC_VER) && _MSC_VER < 1910
  10712. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10713. #else
  10714. auto len_read = buffer.copy(ptr, size, position);
  10715. #endif
  10716. position += static_cast<size_t>(len_read);
  10717. return static_cast<ssize_t>(len_read);
  10718. }
  10719. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10720. buffer.append(ptr, size);
  10721. return static_cast<ssize_t>(size);
  10722. }
  10723. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10724. int & /*port*/) const {}
  10725. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10726. int & /*port*/) const {}
  10727. inline socket_t BufferStream::socket() const { return 0; }
  10728. inline time_t BufferStream::duration() const { return 0; }
  10729. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10730. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10731. : MatcherBase(pattern) {
  10732. constexpr const char marker[] = "/:";
  10733. // One past the last ending position of a path param substring
  10734. std::size_t last_param_end = 0;
  10735. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10736. // Needed to ensure that parameter names are unique during matcher
  10737. // construction
  10738. // If exceptions are disabled, only last duplicate path
  10739. // parameter will be set
  10740. std::unordered_set<std::string> param_name_set;
  10741. #endif
  10742. while (true) {
  10743. const auto marker_pos = pattern.find(
  10744. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10745. if (marker_pos == std::string::npos) { break; }
  10746. static_fragments_.push_back(
  10747. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10748. const auto param_name_start = marker_pos + str_len(marker);
  10749. auto sep_pos = pattern.find(separator, param_name_start);
  10750. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10751. auto param_name =
  10752. pattern.substr(param_name_start, sep_pos - param_name_start);
  10753. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10754. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10755. std::string msg = "Encountered path parameter '" + param_name +
  10756. "' multiple times in route pattern '" + pattern + "'.";
  10757. throw std::invalid_argument(msg);
  10758. }
  10759. #endif
  10760. param_names_.push_back(std::move(param_name));
  10761. last_param_end = sep_pos + 1;
  10762. }
  10763. if (last_param_end < pattern.length()) {
  10764. static_fragments_.push_back(pattern.substr(last_param_end));
  10765. }
  10766. }
  10767. inline bool PathParamsMatcher::match(Request &request) const {
  10768. request.matches = std::smatch();
  10769. request.path_params.clear();
  10770. // A pattern without parameters is just a literal path to compare against
  10771. if (param_names_.empty()) { return request.path == pattern(); }
  10772. request.path_params.reserve(param_names_.size());
  10773. // One past the position at which the path matched the pattern last time
  10774. std::size_t starting_pos = 0;
  10775. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10776. const auto &fragment = static_fragments_[i];
  10777. if (starting_pos + fragment.length() > request.path.length()) {
  10778. return false;
  10779. }
  10780. // Avoid unnecessary allocation by using strncmp instead of substr +
  10781. // comparison
  10782. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10783. fragment.length()) != 0) {
  10784. return false;
  10785. }
  10786. starting_pos += fragment.length();
  10787. // Should only happen when we have a static fragment after a param
  10788. // Example: '/users/:id/subscriptions'
  10789. // The 'subscriptions' fragment here does not have a corresponding param
  10790. if (i >= param_names_.size()) { continue; }
  10791. auto sep_pos = request.path.find(separator, starting_pos);
  10792. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10793. const auto &param_name = param_names_[i];
  10794. request.path_params.emplace(
  10795. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10796. // Mark everything up to '/' as matched
  10797. starting_pos = sep_pos + 1;
  10798. }
  10799. // Returns false if the path is longer than the pattern
  10800. return starting_pos >= request.path.length();
  10801. }
  10802. inline bool RegexMatcher::match(Request &request) const {
  10803. request.path_params.clear();
  10804. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10805. // a non-match rather than risking a stack overflow in std::regex_match.
  10806. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10807. return false;
  10808. }
  10809. return std::regex_match(request.path, request.matches, regex_);
  10810. }
  10811. // Enclose IPv6 address in brackets if needed
  10812. inline std::string prepare_host_string(const std::string &host) {
  10813. // Enclose IPv6 address in brackets (but not if already enclosed)
  10814. if (host.find(':') == std::string::npos ||
  10815. (!host.empty() && host[0] == '[')) {
  10816. // IPv4, hostname, or already bracketed IPv6
  10817. return host;
  10818. } else {
  10819. // IPv6 address without brackets
  10820. return "[" + host + "]";
  10821. }
  10822. }
  10823. inline std::string make_host_and_port_string(const std::string &host, int port,
  10824. bool is_ssl) {
  10825. auto result = prepare_host_string(host);
  10826. // Append port if not default
  10827. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10828. ; // do nothing
  10829. } else {
  10830. result += ":" + std::to_string(port);
  10831. }
  10832. return result;
  10833. }
  10834. // Create "host:port" string always including port number (for CONNECT method)
  10835. inline std::string
  10836. make_host_and_port_string_always_port(const std::string &host, int port) {
  10837. return prepare_host_string(host) + ":" + std::to_string(port);
  10838. }
  10839. // Value for the Host header a client sends when the caller supplied none.
  10840. // Only the value: callers decide where in their header list it goes.
  10841. inline std::string make_default_host_header_value(const std::string &host,
  10842. int port, bool is_ssl,
  10843. int address_family) {
  10844. if (address_family == AF_UNIX) { return "localhost"; }
  10845. return make_host_and_port_string(host, port, is_ssl);
  10846. }
  10847. inline void add_default_user_agent_header(Request &req) {
  10848. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10849. if (!req.has_header("User-Agent")) {
  10850. req.set_header("User-Agent",
  10851. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10852. }
  10853. #else
  10854. (void)req;
  10855. #endif
  10856. }
  10857. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10858. NormalizedTarget normalize_target(const std::string &host);
  10859. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10860. bool host_matches_no_proxy(const NormalizedTarget &target,
  10861. const std::vector<NoProxyEntry> &entries);
  10862. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10863. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10864. if (prefix_bits == 0) { return true; }
  10865. int full_bytes = prefix_bits / 8;
  10866. int rem_bits = prefix_bits % 8;
  10867. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10868. static_cast<size_t>(full_bytes)) != 0) {
  10869. return false;
  10870. }
  10871. if (rem_bits == 0) { return true; }
  10872. auto i = static_cast<size_t>(full_bytes);
  10873. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10874. return (ip[i] & mask) == (net[i] & mask);
  10875. }
  10876. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10877. if (token.empty()) { return false; }
  10878. if (token == "*") {
  10879. out.kind = NoProxyKind::Wildcard;
  10880. return true;
  10881. }
  10882. auto slash = token.find('/');
  10883. std::string addr_part =
  10884. (slash == std::string::npos) ? token : token.substr(0, slash);
  10885. std::string prefix_part =
  10886. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10887. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10888. // don't silently treat it as a /32 (or /128).
  10889. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10890. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10891. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10892. // when brackets are present.
  10893. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10894. addr_part.back() == ']';
  10895. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10896. if (!bracketed) {
  10897. struct in_addr v4;
  10898. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10899. int prefix = 32;
  10900. if (!prefix_part.empty() &&
  10901. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10902. prefix)) {
  10903. return false;
  10904. }
  10905. out.kind = NoProxyKind::IPv4Cidr;
  10906. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10907. out.prefix_bits = prefix;
  10908. return true;
  10909. }
  10910. }
  10911. struct in6_addr v6;
  10912. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10913. int prefix = 128;
  10914. if (!prefix_part.empty() &&
  10915. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10916. prefix)) {
  10917. return false;
  10918. }
  10919. out.kind = NoProxyKind::IPv6Cidr;
  10920. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10921. out.prefix_bits = prefix;
  10922. return true;
  10923. }
  10924. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10925. // the entry is malformed — don't fall through to the hostname branch.
  10926. if (bracketed) { return false; }
  10927. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10928. if (slash != std::string::npos) { return false; }
  10929. // Port-specific entries (host:port) are not supported.
  10930. if (token.find(':') != std::string::npos) { return false; }
  10931. std::string hostname = case_ignore::to_lower(token);
  10932. while (!hostname.empty() && hostname.front() == '.') {
  10933. hostname.erase(hostname.begin());
  10934. }
  10935. while (!hostname.empty() && hostname.back() == '.') {
  10936. hostname.pop_back();
  10937. }
  10938. if (hostname.empty()) { return false; }
  10939. out.kind = NoProxyKind::HostnameSuffix;
  10940. out.hostname_pattern = std::move(hostname);
  10941. return true;
  10942. }
  10943. inline NormalizedTarget normalize_target(const std::string &host) {
  10944. NormalizedTarget t;
  10945. std::string h = host;
  10946. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10947. h = h.substr(1, h.size() - 2);
  10948. }
  10949. // Strip a single trailing dot so "example.com." canonicalizes to
  10950. // "example.com".
  10951. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10952. t.hostname = case_ignore::to_lower(h);
  10953. if (!t.hostname.empty()) {
  10954. struct in_addr v4;
  10955. struct in6_addr v6;
  10956. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10957. t.is_ipv4 = true;
  10958. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10959. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10960. t.is_ipv6 = true;
  10961. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10962. }
  10963. }
  10964. return t;
  10965. }
  10966. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10967. const std::vector<NoProxyEntry> &entries) {
  10968. if (target.hostname.empty()) { return false; }
  10969. for (const auto &e : entries) {
  10970. switch (e.kind) {
  10971. case NoProxyKind::Wildcard: return true;
  10972. case NoProxyKind::IPv4Cidr:
  10973. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10974. return true;
  10975. }
  10976. break;
  10977. case NoProxyKind::IPv6Cidr:
  10978. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10979. return true;
  10980. }
  10981. break;
  10982. case NoProxyKind::HostnameSuffix:
  10983. if (target.is_ipv4 || target.is_ipv6) { break; }
  10984. if (target.hostname == e.hostname_pattern) { return true; }
  10985. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10986. // an entry of "example.com".
  10987. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10988. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10989. if (target.hostname[offset - 1] == '.' &&
  10990. target.hostname.compare(offset, e.hostname_pattern.size(),
  10991. e.hostname_pattern) == 0) {
  10992. return true;
  10993. }
  10994. }
  10995. break;
  10996. }
  10997. }
  10998. return false;
  10999. }
  11000. template <typename T>
  11001. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11002. T header_writer, Error &error) {
  11003. for (const auto &h : headers) {
  11004. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11005. error = Error::InvalidHeaders;
  11006. return false;
  11007. }
  11008. }
  11009. if (header_writer(strm, headers) <= 0) {
  11010. error = Error::Write;
  11011. return false;
  11012. }
  11013. return true;
  11014. }
  11015. } // namespace detail
  11016. /*
  11017. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11018. */
  11019. #ifdef CPPHTTPLIB_SSL_ENABLED
  11020. namespace detail {
  11021. // SSL socket stream implementation
  11022. inline SSLSocketStream::SSLSocketStream(
  11023. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11024. time_t read_timeout_usec, time_t write_timeout_sec,
  11025. time_t write_timeout_usec, time_t max_timeout_msec,
  11026. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11027. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11028. read_timeout_usec_(read_timeout_usec),
  11029. write_timeout_sec_(write_timeout_sec),
  11030. write_timeout_usec_(write_timeout_usec),
  11031. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11032. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11033. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11034. // Note: create_session() also clears this, but SSLClient currently
  11035. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11036. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11037. // SSL session was created.
  11038. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11039. #endif
  11040. }
  11041. inline SSLSocketStream::~SSLSocketStream() = default;
  11042. inline bool SSLSocketStream::is_readable() const {
  11043. return tls::pending(session_) > 0;
  11044. }
  11045. inline bool SSLSocketStream::wait_readable() const {
  11046. if (max_timeout_msec_ <= 0) {
  11047. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11048. }
  11049. time_t read_timeout_sec;
  11050. time_t read_timeout_usec;
  11051. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11052. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11053. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  11054. }
  11055. inline bool SSLSocketStream::wait_writable() const {
  11056. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11057. !tls::is_peer_closed(session_, sock_);
  11058. }
  11059. inline bool SSLSocketStream::ensure_readable() {
  11060. if (readable_hint_) {
  11061. readable_hint_ = false;
  11062. return true;
  11063. }
  11064. return wait_readable();
  11065. }
  11066. inline bool SSLSocketStream::is_peer_alive() const {
  11067. return !tls::is_peer_closed(session_, sock_);
  11068. }
  11069. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11070. if (tls::pending(session_) > 0) {
  11071. tls::TlsError err;
  11072. auto ret = tls::read(session_, ptr, size, err);
  11073. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11074. error_ = Error::ConnectionClosed;
  11075. }
  11076. return ret;
  11077. } else if (ensure_readable()) {
  11078. tls::TlsError err;
  11079. auto ret = tls::read(session_, ptr, size, err);
  11080. if (ret < 0) {
  11081. auto n = 1000;
  11082. #ifdef _WIN32
  11083. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11084. (err.code == tls::ErrorCode::SyscallError &&
  11085. WSAGetLastError() == WSAETIMEDOUT))) {
  11086. #else
  11087. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11088. #endif
  11089. if (tls::pending(session_) > 0) {
  11090. return tls::read(session_, ptr, size, err);
  11091. } else if (wait_readable()) {
  11092. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11093. ret = tls::read(session_, ptr, size, err);
  11094. if (ret >= 0) { return ret; }
  11095. } else {
  11096. break;
  11097. }
  11098. }
  11099. assert(ret < 0);
  11100. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11101. error_ = Error::ConnectionClosed;
  11102. }
  11103. return ret;
  11104. } else {
  11105. error_ = Error::Timeout;
  11106. return -1;
  11107. }
  11108. }
  11109. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11110. if (wait_writable()) {
  11111. auto handle_size =
  11112. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11113. tls::TlsError err;
  11114. auto ret = tls::write(session_, ptr, handle_size, err);
  11115. if (ret < 0) {
  11116. auto n = 1000;
  11117. #ifdef _WIN32
  11118. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11119. (err.code == tls::ErrorCode::SyscallError &&
  11120. WSAGetLastError() == WSAETIMEDOUT))) {
  11121. #else
  11122. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11123. #endif
  11124. if (wait_writable()) {
  11125. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11126. ret = tls::write(session_, ptr, handle_size, err);
  11127. if (ret >= 0) { return ret; }
  11128. } else {
  11129. break;
  11130. }
  11131. }
  11132. assert(ret < 0);
  11133. }
  11134. return ret;
  11135. }
  11136. return -1;
  11137. }
  11138. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11139. int &port) const {
  11140. detail::get_remote_ip_and_port(sock_, ip, port);
  11141. }
  11142. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11143. int &port) const {
  11144. detail::get_local_ip_and_port(sock_, ip, port);
  11145. }
  11146. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11147. inline time_t SSLSocketStream::duration() const {
  11148. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11149. std::chrono::steady_clock::now() - start_time_)
  11150. .count();
  11151. }
  11152. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11153. read_timeout_sec_ = sec;
  11154. read_timeout_usec_ = usec;
  11155. }
  11156. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11157. max_timeout_msec_ = msec;
  11158. start_time_ = std::chrono::steady_clock::now();
  11159. }
  11160. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11161. tls::session_t session,
  11162. time_t read_timeout_sec,
  11163. time_t read_timeout_usec,
  11164. time_t write_timeout_sec,
  11165. time_t write_timeout_usec)
  11166. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11167. read_timeout_usec_(read_timeout_usec),
  11168. write_timeout_sec_(write_timeout_sec),
  11169. write_timeout_usec_(write_timeout_usec),
  11170. start_time_(std::chrono::steady_clock::now()) {
  11171. // The receive and send paths run on different threads, so each TLS call is
  11172. // driven in non-blocking mode and readiness is awaited with select()
  11173. // outside the session lock. Set the socket non-blocking once here; it is
  11174. // never flipped back, so no thread races on the flag.
  11175. detail::set_nonblocking(sock_, true);
  11176. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11177. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11178. #endif
  11179. }
  11180. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11181. inline bool WebSocketSSLStream::is_readable() const {
  11182. std::lock_guard<std::mutex> guard(session_mutex_);
  11183. return tls::pending(session_) > 0;
  11184. }
  11185. inline bool WebSocketSSLStream::wait_readable() const {
  11186. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11187. }
  11188. inline bool WebSocketSSLStream::wait_writable() const {
  11189. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11190. // that probe toggles the socket's blocking flag, which would race with the
  11191. // concurrent reader on a permanently non-blocking socket.
  11192. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11193. }
  11194. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11195. tls::TlsError err;
  11196. auto n = 1000;
  11197. while (--n >= 0) {
  11198. {
  11199. std::lock_guard<std::mutex> guard(session_mutex_);
  11200. auto ret = tls::read(session_, ptr, size, err);
  11201. if (ret > 0) { return ret; }
  11202. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11203. error_ = Error::ConnectionClosed;
  11204. return ret;
  11205. }
  11206. }
  11207. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11208. // direction: the send path shares this session, so output it left pending
  11209. // has to be flushed before more input can be decrypted. Anything else is
  11210. // a hard error.
  11211. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11212. #ifdef _WIN32
  11213. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11214. needs_readable =
  11215. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11216. WSAGetLastError() == WSAETIMEDOUT);
  11217. #endif
  11218. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11219. error_ = Error::Read;
  11220. return -1;
  11221. }
  11222. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11223. error_ = Error::Timeout;
  11224. return -1;
  11225. }
  11226. }
  11227. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11228. // to tell a timeout from a close would otherwise see whatever the previous
  11229. // failure left behind (error_ is never cleared on success).
  11230. error_ = Error::Read;
  11231. return -1;
  11232. }
  11233. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11234. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11235. tls::TlsError err;
  11236. auto n = 1000;
  11237. while (--n >= 0) {
  11238. {
  11239. std::lock_guard<std::mutex> guard(session_mutex_);
  11240. auto ret = tls::write(session_, ptr, handle_size, err);
  11241. if (ret >= 0) { return ret; }
  11242. }
  11243. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11244. // or a post-handshake message must be consumed before the record goes
  11245. // out. Anything else is a hard error.
  11246. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11247. #ifdef _WIN32
  11248. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11249. needs_writable =
  11250. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11251. WSAGetLastError() == WSAETIMEDOUT);
  11252. #endif
  11253. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11254. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11255. }
  11256. return -1;
  11257. }
  11258. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11259. int &port) const {
  11260. detail::get_remote_ip_and_port(sock_, ip, port);
  11261. }
  11262. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11263. int &port) const {
  11264. detail::get_local_ip_and_port(sock_, ip, port);
  11265. }
  11266. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11267. inline time_t WebSocketSSLStream::duration() const {
  11268. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11269. std::chrono::steady_clock::now() - start_time_)
  11270. .count();
  11271. }
  11272. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11273. read_timeout_sec_ = sec;
  11274. read_timeout_usec_ = usec;
  11275. }
  11276. } // namespace detail
  11277. #endif // CPPHTTPLIB_SSL_ENABLED
  11278. /*
  11279. * Group 4: Server implementation
  11280. */
  11281. // HTTP server implementation
  11282. inline Server::Server()
  11283. : new_task_queue([] {
  11284. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11285. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11286. }) {
  11287. #ifndef _WIN32
  11288. signal(SIGPIPE, SIG_IGN);
  11289. #endif
  11290. }
  11291. inline Server::~Server() = default;
  11292. inline std::unique_ptr<detail::MatcherBase>
  11293. Server::make_matcher(const std::string &pattern) {
  11294. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11295. // a path params pattern
  11296. if (pattern.find("/:") != std::string::npos) {
  11297. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11298. }
  11299. // A pattern with no regex metacharacter only has to be compared literally,
  11300. // which is what PathParamsMatcher already does when it captures no
  11301. // parameter, so std::regex is only worth building for the patterns that
  11302. // actually need it
  11303. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11304. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11305. }
  11306. return detail::make_unique<detail::RegexMatcher>(pattern);
  11307. }
  11308. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11309. return add_handler(get_handlers_, pattern, std::move(handler));
  11310. }
  11311. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11312. return add_handler(post_handlers_, pattern, std::move(handler));
  11313. }
  11314. inline Server &Server::Post(const std::string &pattern,
  11315. HandlerWithContentReader handler) {
  11316. return add_handler(post_handlers_for_content_reader_, pattern,
  11317. std::move(handler));
  11318. }
  11319. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11320. return add_handler(put_handlers_, pattern, std::move(handler));
  11321. }
  11322. inline Server &Server::Put(const std::string &pattern,
  11323. HandlerWithContentReader handler) {
  11324. return add_handler(put_handlers_for_content_reader_, pattern,
  11325. std::move(handler));
  11326. }
  11327. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11328. return add_handler(patch_handlers_, pattern, std::move(handler));
  11329. }
  11330. inline Server &Server::Patch(const std::string &pattern,
  11331. HandlerWithContentReader handler) {
  11332. return add_handler(patch_handlers_for_content_reader_, pattern,
  11333. std::move(handler));
  11334. }
  11335. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11336. return add_handler(delete_handlers_, pattern, std::move(handler));
  11337. }
  11338. inline Server &Server::Delete(const std::string &pattern,
  11339. HandlerWithContentReader handler) {
  11340. return add_handler(delete_handlers_for_content_reader_, pattern,
  11341. std::move(handler));
  11342. }
  11343. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11344. return add_handler(options_handlers_, pattern, std::move(handler));
  11345. }
  11346. inline const std::set<std::string> &Server::builtin_methods() {
  11347. thread_local const std::set<std::string> methods{
  11348. "GET", "HEAD", "POST", "PUT", "DELETE",
  11349. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11350. return methods;
  11351. }
  11352. inline Server::CustomHandlerEntry *
  11353. Server::custom_entry_for_registration(const std::string &method) {
  11354. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11355. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11356. // routing() before the custom tables are consulted, so a route registered
  11357. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11358. // there and would be reachable, but they carry protocol-level meaning
  11359. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11360. // library does not route.
  11361. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11362. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11363. has_invalid_registration_ = true;
  11364. return nullptr;
  11365. }
  11366. return &custom_handlers_[method];
  11367. }
  11368. inline Server &Server::CustomRoute(const std::string &method,
  11369. const std::string &pattern,
  11370. Handler handler) {
  11371. auto *entry = custom_entry_for_registration(method);
  11372. if (!entry) { return *this; }
  11373. return add_handler(entry->handlers, pattern, std::move(handler));
  11374. }
  11375. inline Server &Server::CustomRoute(const std::string &method,
  11376. const std::string &pattern,
  11377. HandlerWithContentReader handler) {
  11378. auto *entry = custom_entry_for_registration(method);
  11379. if (!entry) { return *this; }
  11380. return add_handler(entry->handlers_for_content_reader, pattern,
  11381. std::move(handler));
  11382. }
  11383. inline const Server::CustomHandlerEntry *
  11384. Server::find_custom_entry(const std::string &method) const {
  11385. // find() alone would be correct here. The empty() check is what keeps the
  11386. // per-request cost off servers that never call CustomRoute(), which is the
  11387. // overwhelmingly common case; keep it rather than walking into the tree.
  11388. if (custom_handlers_.empty()) { return nullptr; }
  11389. auto it = custom_handlers_.find(method);
  11390. return it == custom_handlers_.end() ? nullptr : &it->second;
  11391. }
  11392. inline Server &Server::WebSocket(const std::string &pattern,
  11393. WebSocketHandler handler) {
  11394. websocket_handlers_.push_back(
  11395. {make_matcher(pattern), std::move(handler), nullptr});
  11396. return *this;
  11397. }
  11398. inline Server &Server::WebSocket(const std::string &pattern,
  11399. WebSocketHandler handler,
  11400. SubProtocolSelector sub_protocol_selector) {
  11401. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11402. std::move(sub_protocol_selector)});
  11403. return *this;
  11404. }
  11405. inline bool Server::set_base_dir(const std::string &dir,
  11406. const std::string &mount_point) {
  11407. return set_mount_point(mount_point, dir);
  11408. }
  11409. inline bool Server::set_mount_point(const std::string &mount_point,
  11410. const std::string &dir, Headers headers) {
  11411. detail::FileStat stat(dir);
  11412. if (stat.is_dir()) {
  11413. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11414. if (!mnt.empty() && mnt[0] == '/') {
  11415. // Without the resolved directory, a file could not be checked to be
  11416. // inside it.
  11417. std::string resolved_base;
  11418. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11419. return false;
  11420. }
  11421. #if defined(_WIN32)
  11422. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11423. resolved_base += '\\';
  11424. }
  11425. #else
  11426. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11427. #endif
  11428. base_dirs_.push_back(
  11429. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11430. return true;
  11431. }
  11432. }
  11433. return false;
  11434. }
  11435. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11436. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11437. if (it->mount_point == mount_point) {
  11438. base_dirs_.erase(it);
  11439. return true;
  11440. }
  11441. }
  11442. return false;
  11443. }
  11444. inline Server &
  11445. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11446. const std::string &mime) {
  11447. file_extension_and_mimetype_map_[ext] = mime;
  11448. return *this;
  11449. }
  11450. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11451. default_file_mimetype_ = mime;
  11452. return *this;
  11453. }
  11454. inline Server &Server::set_file_request_handler(Handler handler) {
  11455. file_request_handler_ = std::move(handler);
  11456. return *this;
  11457. }
  11458. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11459. std::true_type) {
  11460. error_handler_ = std::move(handler);
  11461. return *this;
  11462. }
  11463. inline Server &Server::set_error_handler_core(Handler handler,
  11464. std::false_type) {
  11465. error_handler_ = [handler](const Request &req, Response &res) {
  11466. handler(req, res);
  11467. return HandlerResponse::Handled;
  11468. };
  11469. return *this;
  11470. }
  11471. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11472. exception_handler_ = std::move(handler);
  11473. return *this;
  11474. }
  11475. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11476. pre_routing_handler_ = std::move(handler);
  11477. return *this;
  11478. }
  11479. inline Server &Server::set_post_routing_handler(Handler handler) {
  11480. post_routing_handler_ = std::move(handler);
  11481. return *this;
  11482. }
  11483. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11484. pre_request_handler_ = std::move(handler);
  11485. return *this;
  11486. }
  11487. inline Server &Server::set_logger(Logger logger) {
  11488. logger_ = std::move(logger);
  11489. return *this;
  11490. }
  11491. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11492. error_logger_ = std::move(error_logger);
  11493. return *this;
  11494. }
  11495. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11496. pre_compression_logger_ = std::move(logger);
  11497. return *this;
  11498. }
  11499. inline Server &
  11500. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11501. expect_100_continue_handler_ = std::move(handler);
  11502. return *this;
  11503. }
  11504. inline Server &Server::set_start_handler(StartHandler handler) {
  11505. start_handler_ = std::move(handler);
  11506. return *this;
  11507. }
  11508. inline Server &Server::set_address_family(int family) {
  11509. address_family_ = family;
  11510. return *this;
  11511. }
  11512. inline Server &Server::set_tcp_nodelay(bool on) {
  11513. tcp_nodelay_ = on;
  11514. return *this;
  11515. }
  11516. inline Server &Server::set_ipv6_v6only(bool on) {
  11517. ipv6_v6only_ = on;
  11518. return *this;
  11519. }
  11520. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11521. socket_options_ = std::move(socket_options);
  11522. return *this;
  11523. }
  11524. inline Server &Server::set_default_headers(Headers headers) {
  11525. default_headers_ = std::move(headers);
  11526. return *this;
  11527. }
  11528. inline Server &Server::set_header_writer(
  11529. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11530. header_writer_ = writer;
  11531. return *this;
  11532. }
  11533. inline Server &
  11534. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11535. trusted_proxies_ = proxies;
  11536. return *this;
  11537. }
  11538. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11539. keep_alive_max_count_ = count;
  11540. return *this;
  11541. }
  11542. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11543. keep_alive_timeout_sec_ = sec;
  11544. return *this;
  11545. }
  11546. template <class Rep, class Period>
  11547. inline Server &Server::set_keep_alive_timeout(
  11548. const std::chrono::duration<Rep, Period> &duration) {
  11549. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11550. set_keep_alive_timeout(sec);
  11551. });
  11552. return *this;
  11553. }
  11554. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11555. read_timeout_sec_ = sec;
  11556. read_timeout_usec_ = usec;
  11557. return *this;
  11558. }
  11559. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11560. write_timeout_sec_ = sec;
  11561. write_timeout_usec_ = usec;
  11562. return *this;
  11563. }
  11564. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11565. idle_interval_sec_ = sec;
  11566. idle_interval_usec_ = usec;
  11567. return *this;
  11568. }
  11569. inline Server &Server::set_payload_max_length(size_t length) {
  11570. payload_max_length_ = length;
  11571. return *this;
  11572. }
  11573. inline Server &Server::set_static_file_compression(bool on) {
  11574. static_file_compression_ = on;
  11575. return *this;
  11576. }
  11577. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11578. static_file_compression_min_length_ = length;
  11579. return *this;
  11580. }
  11581. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11582. static_file_compression_max_length_ = length;
  11583. return *this;
  11584. }
  11585. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11586. websocket_max_missed_pongs_ = count;
  11587. return *this;
  11588. }
  11589. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11590. websocket_ping_interval_sec_ = sec;
  11591. return *this;
  11592. }
  11593. template <class Rep, class Period>
  11594. inline Server &Server::set_websocket_ping_interval(
  11595. const std::chrono::duration<Rep, Period> &duration) {
  11596. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11597. set_websocket_ping_interval(sec);
  11598. });
  11599. return *this;
  11600. }
  11601. inline bool Server::bind_to_port(const std::string &host, int port,
  11602. int socket_flags) {
  11603. auto ret = bind_internal(host, port, socket_flags);
  11604. if (ret == -1) { is_decommissioned = true; }
  11605. return ret >= 0;
  11606. }
  11607. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11608. auto ret = bind_internal(host, 0, socket_flags);
  11609. if (ret == -1) { is_decommissioned = true; }
  11610. return ret;
  11611. }
  11612. inline bool Server::listen_after_bind() { return listen_internal(); }
  11613. inline bool Server::listen(const std::string &host, int port,
  11614. int socket_flags) {
  11615. return bind_to_port(host, port, socket_flags) && listen_internal();
  11616. }
  11617. inline bool Server::is_running() const { return is_running_; }
  11618. inline void Server::wait_until_ready() const {
  11619. while (!is_running_ && !is_decommissioned) {
  11620. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11621. }
  11622. }
  11623. inline void Server::stop() noexcept {
  11624. // Release the listening socket whether or not the accept loop is running:
  11625. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11626. // exchange is what makes this safe to call concurrently with the accept loop.
  11627. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11628. if (sock != INVALID_SOCKET) {
  11629. detail::shutdown_socket(sock);
  11630. detail::close_socket(sock);
  11631. }
  11632. is_decommissioned = false;
  11633. }
  11634. inline void Server::decommission() { is_decommissioned = true; }
  11635. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11636. auto len = strlen(s);
  11637. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11638. len -= 2;
  11639. {
  11640. // RFC 9112 §3: exactly one SP between the method, the target and the
  11641. // version. Taking other whitespace as a separator too lets recipients
  11642. // that parse more strictly see a different request.
  11643. auto end = s + len;
  11644. if (std::count(s, end, ' ') != 2) { return false; }
  11645. auto sp1 = std::find(s, end, ' ');
  11646. auto sp2 = std::find(sp1 + 1, end, ' ');
  11647. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11648. req.method.assign(s, sp1);
  11649. req.target.assign(sp1 + 1, sp2);
  11650. req.version.assign(sp2 + 1, end);
  11651. }
  11652. // A method outside the built-in set is accepted only when a handler has been
  11653. // registered for it with CustomRoute().
  11654. const auto &methods = builtin_methods();
  11655. if (methods.find(req.method) == methods.end() &&
  11656. !find_custom_entry(req.method)) {
  11657. output_error_log(Error::InvalidHTTPMethod, &req);
  11658. return false;
  11659. }
  11660. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11661. output_error_log(Error::InvalidHTTPVersion, &req);
  11662. return false;
  11663. }
  11664. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11665. // would leave this server routing a different path than a cache or a
  11666. // filter in front of it sees.
  11667. if (!detail::fields::is_request_target(req.target) ||
  11668. req.target.find('#') != std::string::npos) {
  11669. return false;
  11670. }
  11671. {
  11672. detail::divide(req.target, '?',
  11673. [&](const char *lhs_data, std::size_t lhs_size,
  11674. const char *rhs_data, std::size_t rhs_size) {
  11675. req.path =
  11676. decode_path_component(std::string(lhs_data, lhs_size));
  11677. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11678. });
  11679. }
  11680. return true;
  11681. }
  11682. inline bool Server::write_response(Stream &strm, bool close_connection,
  11683. Request &req, Response &res) {
  11684. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11685. // incorrectly to the error content.
  11686. req.ranges.clear();
  11687. return write_response_core(strm, close_connection, req, res, false);
  11688. }
  11689. inline bool Server::write_response_with_content(Stream &strm,
  11690. bool close_connection,
  11691. const Request &req,
  11692. Response &res) {
  11693. return write_response_core(strm, close_connection, req, res, true);
  11694. }
  11695. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11696. const Request &req, Response &res,
  11697. bool need_apply_ranges) {
  11698. assert(res.status != -1);
  11699. if (400 <= res.status && error_handler_ &&
  11700. error_handler_(req, res) == HandlerResponse::Handled) {
  11701. need_apply_ranges = true;
  11702. }
  11703. if (!detail::body_allowed_for_status(res.status)) {
  11704. detail::clear_content(res);
  11705. }
  11706. detail::prefer_assigned_body(res);
  11707. std::string content_type;
  11708. std::string boundary;
  11709. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11710. // Prepare additional headers
  11711. if (close_connection ||
  11712. detail::has_header_token(req.headers, "Connection", "close") ||
  11713. 400 <= res.status || // Don't leave connections open after errors
  11714. // The client withholds the body until `100 Continue`, which was never
  11715. // sent, so whether and when the body follows is unknown.
  11716. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11717. // The body was left partway, e.g. by a content receiver that returned
  11718. // false, so the rest of it cannot be told from the next request.
  11719. (req.body_read_started_ && !req.body_consumed_)) {
  11720. res.set_header("Connection", "close");
  11721. } else {
  11722. std::string s = "timeout=";
  11723. s += std::to_string(keep_alive_timeout_sec_);
  11724. s += ", max=";
  11725. s += std::to_string(keep_alive_max_count_);
  11726. res.set_header("Keep-Alive", s);
  11727. }
  11728. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11729. !res.has_header("Content-Type")) {
  11730. res.set_header("Content-Type", "text/plain");
  11731. }
  11732. detail::set_framing_headers(req, res, boundary, content_type);
  11733. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11734. res.set_header("Accept-Ranges", "bytes");
  11735. }
  11736. if (post_routing_handler_) {
  11737. post_routing_handler_(req, res);
  11738. // Again, for a body or framing headers the handler changed.
  11739. detail::set_framing_headers(req, res, boundary, content_type);
  11740. }
  11741. // Response line and headers
  11742. detail::BufferStream bstrm;
  11743. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11744. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11745. // Combine a small body with the headers so the whole response leaves in a
  11746. // single write. A large body is written on its own instead: a copy of it
  11747. // costs more than the extra write saves.
  11748. auto send_body =
  11749. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11750. auto body_is_separate = false;
  11751. auto provider_done = false;
  11752. if (send_body && !res.body.empty() && !res.content_provider_) {
  11753. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11754. bstrm.write(res.body.data(), res.body.size());
  11755. } else {
  11756. body_is_separate = true;
  11757. }
  11758. } else if (send_body && res.content_provider_ &&
  11759. res.is_file_content_provider_ &&
  11760. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11761. // A small file is read into the same buffer. Other providers may produce
  11762. // their data over time, so they are never held back.
  11763. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11764. return false;
  11765. }
  11766. provider_done = true;
  11767. }
  11768. // Log before writing to avoid race condition with client-side code that
  11769. // accesses logger-captured data immediately after receiving the response.
  11770. output_log(req, res);
  11771. // Flush buffer
  11772. auto &data = bstrm.get_buffer();
  11773. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11774. if (body_is_separate) {
  11775. return detail::write_data(strm, res.body.data(), res.body.size());
  11776. }
  11777. // Streaming body
  11778. if (send_body && res.content_provider_) {
  11779. if (!provider_done &&
  11780. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11781. return false;
  11782. }
  11783. res.content_provider_success_ = true;
  11784. }
  11785. return true;
  11786. }
  11787. inline bool
  11788. Server::write_content_with_provider(Stream &strm, const Request &req,
  11789. Response &res, const std::string &boundary,
  11790. const std::string &content_type) {
  11791. auto is_shutting_down = [this]() {
  11792. return this->svr_sock_ == INVALID_SOCKET;
  11793. };
  11794. if (res.content_length_ > 0) {
  11795. if (!detail::is_partial_content(req, res)) {
  11796. return detail::write_content(strm, res.content_provider_, 0,
  11797. res.content_length_, is_shutting_down);
  11798. } else if (req.ranges.size() == 1) {
  11799. auto offset_and_length = detail::get_range_offset_and_length(
  11800. req.ranges[0], res.content_length_);
  11801. return detail::write_content(strm, res.content_provider_,
  11802. offset_and_length.first,
  11803. offset_and_length.second, is_shutting_down);
  11804. } else {
  11805. return detail::write_multipart_ranges_data(
  11806. strm, req, res, boundary, content_type, res.content_length_,
  11807. is_shutting_down);
  11808. }
  11809. } else {
  11810. if (res.is_chunked_content_provider_) {
  11811. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11812. // re-negotiating here would disagree with them, e.g. once a handler's
  11813. // own Content-Encoding header suppresses the negotiation.
  11814. auto compressor = detail::make_compressor(res.content_coding_);
  11815. if (!compressor) {
  11816. compressor = detail::make_unique<detail::nocompressor>();
  11817. }
  11818. return detail::write_content_chunked(strm, res.content_provider_,
  11819. is_shutting_down, *compressor);
  11820. } else {
  11821. return detail::write_content_without_length(strm, res.content_provider_,
  11822. is_shutting_down);
  11823. }
  11824. }
  11825. }
  11826. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11827. FormFields::iterator cur_field;
  11828. FormFiles::iterator cur_file;
  11829. auto is_text_field = false;
  11830. size_t count = 0;
  11831. if (read_content_core(
  11832. strm, req, res,
  11833. // Regular
  11834. [&](const char *buf, size_t n) {
  11835. // Prevent arithmetic overflow when checking sizes.
  11836. // Avoid computing (req.body.size() + n) directly because
  11837. // adding two unsigned `size_t` values can wrap around and
  11838. // produce a small result instead of indicating overflow.
  11839. // Instead, check using subtraction: ensure `n` does not
  11840. // exceed the remaining capacity `max_size() - size()`.
  11841. if (req.body.size() >= req.body.max_size() ||
  11842. n > req.body.max_size() - req.body.size()) {
  11843. return false;
  11844. }
  11845. // Limit decompressed body size to payload_max_length_ to protect
  11846. // against "zip bomb" attacks where a small compressed payload
  11847. // decompresses to a massive size.
  11848. if (payload_max_length_ > 0 &&
  11849. (req.body.size() >= payload_max_length_ ||
  11850. n > payload_max_length_ - req.body.size())) {
  11851. return false;
  11852. }
  11853. req.body.append(buf, n);
  11854. return true;
  11855. },
  11856. // Multipart FormData
  11857. [&](const FormData &file) {
  11858. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11859. output_error_log(Error::TooManyFormDataFiles, &req);
  11860. return false;
  11861. }
  11862. if (file.filename.empty()) {
  11863. cur_field = req.form.fields.emplace(
  11864. file.name, FormField{file.name, file.content, file.headers});
  11865. is_text_field = true;
  11866. } else {
  11867. cur_file = req.form.files.emplace(file.name, file);
  11868. is_text_field = false;
  11869. }
  11870. return true;
  11871. },
  11872. [&](const char *buf, size_t n) {
  11873. if (is_text_field) {
  11874. auto &content = cur_field->second.content;
  11875. if (content.size() + n > content.max_size()) { return false; }
  11876. content.append(buf, n);
  11877. } else {
  11878. auto &content = cur_file->second.content;
  11879. if (content.size() + n > content.max_size()) { return false; }
  11880. content.append(buf, n);
  11881. }
  11882. return true;
  11883. })) {
  11884. const auto &content_type = req.get_header_value("Content-Type");
  11885. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  11886. "application/x-www-form-urlencoded")) {
  11887. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11888. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11889. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11890. return false;
  11891. }
  11892. detail::parse_query_text(req.body, req.params);
  11893. }
  11894. return true;
  11895. }
  11896. return false;
  11897. }
  11898. inline bool Server::read_content_with_content_receiver(
  11899. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11900. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11901. return read_content_core(strm, req, res, std::move(receiver),
  11902. std::move(multipart_header),
  11903. std::move(multipart_receiver));
  11904. }
  11905. inline bool Server::read_content_core(
  11906. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11907. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11908. detail::FormDataParser multipart_form_data_parser;
  11909. ContentReceiverWithProgress out;
  11910. if (req.is_multipart_form_data()) {
  11911. const auto &content_type = req.get_header_value("Content-Type");
  11912. std::string boundary;
  11913. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11914. res.status = StatusCode::BadRequest_400;
  11915. output_error_log(Error::MultipartParsing, &req);
  11916. return false;
  11917. }
  11918. multipart_form_data_parser.set_boundary(std::move(boundary));
  11919. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11920. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11921. multipart_receiver);
  11922. };
  11923. } else {
  11924. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11925. size_t /*len*/) { return receiver(buf, n); };
  11926. }
  11927. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11928. // For non-SSL builds we still scan non-persistent connections for stray
  11929. // body bytes so the payload limit is enforced (413). On keep-alive,
  11930. // pending bytes may be the next request (issue #2450), so skip.
  11931. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11932. if (!req.has_header("Content-Length") &&
  11933. !detail::is_chunked_transfer_encoding(req.headers)) {
  11934. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11935. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11936. auto has_data = strm.is_readable();
  11937. if (!has_data) {
  11938. auto s = strm.socket();
  11939. if (s != INVALID_SOCKET) {
  11940. has_data = detail::select_read(s, 0, 0) > 0;
  11941. }
  11942. }
  11943. if (has_data) {
  11944. // Route through the same decompressing reader used by the
  11945. // length-framed and chunked paths below, so payload_max_length_ is
  11946. // enforced on the decompressed size here too instead of only on the
  11947. // compressed wire bytes.
  11948. return detail::read_content(strm, req, payload_max_length_, res.status,
  11949. nullptr, out, true);
  11950. }
  11951. }
  11952. return true;
  11953. }
  11954. #else
  11955. if (!req.has_header("Content-Length") &&
  11956. !detail::is_chunked_transfer_encoding(req.headers)) {
  11957. return true;
  11958. }
  11959. #endif
  11960. // A second read would start where the first one stopped, or in the next
  11961. // request.
  11962. if (req.body_read_started_) { return false; }
  11963. // The client is waiting for this before it sends the body.
  11964. if (req.expect_100_continue_pending_) {
  11965. req.expect_100_continue_pending_ = false;
  11966. detail::write_response_line(strm, StatusCode::Continue_100);
  11967. strm.write("\r\n");
  11968. }
  11969. // Set before reading, since a receiver may also stop by throwing.
  11970. req.body_read_started_ = true;
  11971. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11972. out, true)) {
  11973. return false;
  11974. }
  11975. req.body_consumed_ = true;
  11976. if (req.is_multipart_form_data()) {
  11977. if (!multipart_form_data_parser.is_valid()) {
  11978. res.status = StatusCode::BadRequest_400;
  11979. output_error_log(Error::MultipartParsing, &req);
  11980. return false;
  11981. }
  11982. }
  11983. return true;
  11984. }
  11985. inline bool Server::handle_file_request(Request &req, Response &res) {
  11986. for (const auto &entry : base_dirs_) {
  11987. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11988. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11989. // One that already ends in '/' (the root mount among them) carries its own
  11990. // boundary; set_mount_point() guarantees the mount point is not empty.
  11991. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11992. (entry.mount_point.back() == '/' ||
  11993. req.path.size() == entry.mount_point.size() ||
  11994. req.path[entry.mount_point.size()] == '/')) {
  11995. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11996. if (detail::is_valid_path(sub_path)) {
  11997. auto path = entry.base_dir + sub_path;
  11998. if (path.back() == '/') { path += "index.html"; }
  11999. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12000. // but symlinks/junctions can still escape the base directory. A path
  12001. // that cannot be resolved, which includes one that does not exist, is
  12002. // not served from here.
  12003. std::string resolved_path;
  12004. if (!detail::canonicalize_path(path.c_str(), resolved_path)) {
  12005. continue;
  12006. }
  12007. if (!detail::is_path_within_base(resolved_path,
  12008. entry.resolved_base_dir)) {
  12009. res.status = StatusCode::Forbidden_403;
  12010. return true;
  12011. }
  12012. detail::FileStat stat(path);
  12013. if (stat.is_dir()) {
  12014. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12015. // in the name from reading as a scheme.
  12016. auto name = req.path.substr(req.path.rfind('/') + 1);
  12017. res.set_redirect("./" + encode_path_component(name) + "/",
  12018. StatusCode::MovedPermanently_301);
  12019. return true;
  12020. }
  12021. if (stat.is_file()) {
  12022. for (const auto &kv : entry.headers) {
  12023. res.set_header(kv.first, kv.second);
  12024. }
  12025. auto content_type = detail::find_content_type(
  12026. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12027. auto encoding = detail::EncodingType::None;
  12028. if (static_file_compression_) {
  12029. encoding =
  12030. static_file_encoding(req, res, content_type, stat.size());
  12031. }
  12032. // The ETag names the representation actually sent, so a client that
  12033. // cached the compressed form revalidates against the compressed ETag
  12034. // and still gets a 304, while one that took identity keeps the plain
  12035. // ETag.
  12036. auto etag = detail::compute_etag(
  12037. stat, encoding == detail::EncodingType::None
  12038. ? std::string()
  12039. : std::string("-") + detail::encoding_name(encoding));
  12040. if (!etag.empty()) { res.set_header("ETag", etag); }
  12041. auto mtime = stat.mtime();
  12042. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12043. if (!last_modified.empty()) {
  12044. res.set_header("Last-Modified", last_modified);
  12045. }
  12046. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12047. check_if_range(req, etag, mtime);
  12048. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12049. if (!mm->is_open()) {
  12050. output_error_log(Error::OpenFile, &req);
  12051. return false;
  12052. }
  12053. detail::set_file_content_provider(res, mm, content_type, encoding);
  12054. if (req.method != "HEAD" && file_request_handler_) {
  12055. file_request_handler_(req, res);
  12056. }
  12057. return true;
  12058. } else {
  12059. output_error_log(Error::OpenFile, &req);
  12060. }
  12061. }
  12062. }
  12063. }
  12064. return false;
  12065. }
  12066. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12067. const std::string &etag,
  12068. time_t mtime) const {
  12069. // Handle conditional GET:
  12070. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12071. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12072. if (req.has_header("If-None-Match")) {
  12073. if (!etag.empty()) {
  12074. auto val =
  12075. detail::get_combined_header_value(req.headers, "If-None-Match");
  12076. // NOTE: We use exact string matching here. This works correctly
  12077. // because our server always generates weak ETags (W/"..."), and
  12078. // clients typically send back the same ETag they received.
  12079. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12080. // If-None-Match, where W/"x" and "x" would match, but this
  12081. // simplified implementation requires exact matches.
  12082. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12083. [&](const char *b, const char *e) {
  12084. auto seg_len = static_cast<size_t>(e - b);
  12085. return (seg_len == 1 && *b == '*') ||
  12086. (seg_len == etag.size() &&
  12087. std::equal(b, e, etag.begin()));
  12088. });
  12089. if (ret) {
  12090. res.status = StatusCode::NotModified_304;
  12091. return true;
  12092. }
  12093. }
  12094. } else if (req.has_header("If-Modified-Since")) {
  12095. auto val = req.get_header_value("If-Modified-Since");
  12096. auto t = detail::parse_http_date(val);
  12097. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12098. res.status = StatusCode::NotModified_304;
  12099. return true;
  12100. }
  12101. }
  12102. return false;
  12103. }
  12104. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12105. time_t mtime) const {
  12106. // Handle If-Range for partial content requests (RFC 9110
  12107. // Section 13.1.5). If-Range is only evaluated when Range header is
  12108. // present. If the validator matches, serve partial content; otherwise
  12109. // serve full content.
  12110. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12111. auto val = req.get_header_value("If-Range");
  12112. auto is_valid_range = [&]() {
  12113. if (detail::is_strong_etag(val)) {
  12114. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12115. // comparison.
  12116. return (!etag.empty() && val == etag);
  12117. } else if (detail::is_weak_etag(val)) {
  12118. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12119. return false;
  12120. } else {
  12121. // HTTP-date comparison
  12122. auto t = detail::parse_http_date(val);
  12123. return (t != static_cast<time_t>(-1) && mtime <= t);
  12124. }
  12125. };
  12126. if (!is_valid_range()) {
  12127. // Validator doesn't match: ignore Range and serve full content
  12128. req.ranges.clear();
  12129. return false;
  12130. }
  12131. }
  12132. return true;
  12133. }
  12134. inline socket_t
  12135. Server::create_server_socket(const std::string &host, int port,
  12136. int socket_flags,
  12137. SocketOptions socket_options) const {
  12138. return detail::create_socket(
  12139. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12140. ipv6_v6only_, std::move(socket_options),
  12141. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12142. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12143. output_error_log(Error::BindIPAddress, nullptr);
  12144. return false;
  12145. }
  12146. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12147. output_error_log(Error::Listen, nullptr);
  12148. return false;
  12149. }
  12150. return true;
  12151. });
  12152. }
  12153. inline int Server::bind_internal(const std::string &host, int port,
  12154. int socket_flags) {
  12155. if (is_decommissioned) { return -1; }
  12156. if (!is_valid()) { return -1; }
  12157. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12158. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12159. if (port == 0) {
  12160. struct sockaddr_storage addr;
  12161. socklen_t addr_len = sizeof(addr);
  12162. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12163. &addr_len) == -1) {
  12164. output_error_log(Error::GetSockName, nullptr);
  12165. return -1;
  12166. }
  12167. if (addr.ss_family == AF_INET) {
  12168. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12169. } else if (addr.ss_family == AF_INET6) {
  12170. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12171. } else {
  12172. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12173. return -1;
  12174. }
  12175. } else {
  12176. return port;
  12177. }
  12178. }
  12179. inline bool Server::listen_internal() {
  12180. // A stop() between bind and listen leaves nothing to accept on. Report
  12181. // failure instead of returning success without ever serving, and mark the
  12182. // server decommissioned the way any failed listen does so that a concurrent
  12183. // wait_until_ready() wakes up instead of spinning forever.
  12184. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12185. is_decommissioned = true;
  12186. return false;
  12187. }
  12188. auto ret = true;
  12189. is_running_ = true;
  12190. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12191. if (start_handler_) { start_handler_(); }
  12192. {
  12193. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12194. while (svr_sock_ != INVALID_SOCKET) {
  12195. #ifndef _WIN32
  12196. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12197. #endif
  12198. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12199. idle_interval_usec_);
  12200. if (val == 0) { // Timeout
  12201. task_queue->on_idle();
  12202. continue;
  12203. }
  12204. #ifndef _WIN32
  12205. }
  12206. #endif
  12207. #if defined _WIN32
  12208. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12209. // OVERLAPPED
  12210. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12211. #elif defined SOCK_CLOEXEC
  12212. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12213. #else
  12214. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12215. #endif
  12216. if (sock == INVALID_SOCKET) {
  12217. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12218. // touches the CRT errno, so the two have to be asked platform by
  12219. // platform rather than by testing errno here.
  12220. if (detail::is_accept_resource_error()) {
  12221. // The per-process descriptor limit or the network stack's buffer
  12222. // space has been reached. Try to accept new connections after a
  12223. // short sleep.
  12224. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12225. continue;
  12226. } else if (detail::is_accept_transient_error()) {
  12227. continue;
  12228. }
  12229. // Take the descriptor out of svr_sock_ before closing it: a later
  12230. // stop() would otherwise shutdown()/close() a value the OS may have
  12231. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12232. // gone. The exchange also settles the race with a concurrent stop(),
  12233. // since whichever side takes the descriptor closes it exactly once.
  12234. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12235. if (listen_sock != INVALID_SOCKET) {
  12236. detail::close_socket(listen_sock);
  12237. ret = false;
  12238. output_error_log(Error::Connection, nullptr);
  12239. } else {
  12240. ; // The server socket was closed by user.
  12241. }
  12242. break;
  12243. }
  12244. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12245. read_timeout_sec_, read_timeout_usec_);
  12246. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12247. write_timeout_sec_, write_timeout_usec_);
  12248. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12249. if (!task_queue->enqueue(
  12250. [this, sock]() { process_and_close_socket(sock); })) {
  12251. output_error_log(Error::ResourceExhaustion, nullptr);
  12252. detail::shutdown_socket(sock);
  12253. detail::close_socket(sock);
  12254. }
  12255. }
  12256. task_queue->shutdown();
  12257. }
  12258. is_decommissioned = !ret;
  12259. return ret;
  12260. }
  12261. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12262. if (pre_routing_handler_ &&
  12263. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12264. return true;
  12265. }
  12266. // File handler
  12267. if ((req.method == "GET" || req.method == "HEAD") &&
  12268. handle_file_request(req, res)) {
  12269. return true;
  12270. }
  12271. const auto *custom = find_custom_entry(req.method);
  12272. // The second clause mirrors what expect_content() does unconditionally for
  12273. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12274. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12275. // `allprop`) would skip its handler and fall through to 404.
  12276. if (detail::expect_content(req) ||
  12277. (custom && !custom->handlers_for_content_reader.empty())) {
  12278. // Content reader handler
  12279. {
  12280. // Track whether the ContentReader was aborted due to the decompressed
  12281. // payload exceeding `payload_max_length_`.
  12282. // The user handler runs after the lambda returns, so we must restore the
  12283. // 413 status if the handler overwrites it.
  12284. bool content_reader_payload_too_large = false;
  12285. ContentReader reader(
  12286. [&](ContentReceiver receiver) {
  12287. auto result = read_content_with_content_receiver(
  12288. strm, req, res, std::move(receiver), nullptr, nullptr);
  12289. if (!result) {
  12290. output_error_log(Error::Read, &req);
  12291. if (res.status == StatusCode::PayloadTooLarge_413) {
  12292. content_reader_payload_too_large = true;
  12293. }
  12294. }
  12295. return result;
  12296. },
  12297. [&](FormDataHeader header, ContentReceiver receiver) {
  12298. auto result = read_content_with_content_receiver(
  12299. strm, req, res, nullptr, std::move(header),
  12300. std::move(receiver));
  12301. if (!result) {
  12302. output_error_log(Error::Read, &req);
  12303. if (res.status == StatusCode::PayloadTooLarge_413) {
  12304. content_reader_payload_too_large = true;
  12305. }
  12306. }
  12307. return result;
  12308. });
  12309. bool dispatched = false;
  12310. if (req.method == "POST") {
  12311. dispatched = dispatch_request_for_content_reader(
  12312. req, res, std::move(reader), post_handlers_for_content_reader_);
  12313. } else if (req.method == "PUT") {
  12314. dispatched = dispatch_request_for_content_reader(
  12315. req, res, std::move(reader), put_handlers_for_content_reader_);
  12316. } else if (req.method == "PATCH") {
  12317. dispatched = dispatch_request_for_content_reader(
  12318. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12319. } else if (req.method == "DELETE") {
  12320. dispatched = dispatch_request_for_content_reader(
  12321. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12322. } else if (custom) {
  12323. dispatched = dispatch_request_for_content_reader(
  12324. req, res, std::move(reader), custom->handlers_for_content_reader);
  12325. }
  12326. if (dispatched) {
  12327. if (content_reader_payload_too_large) {
  12328. // Enforce the limit: override any status the handler may have set
  12329. // and return false so the error path sends a plain 413 response.
  12330. res.status = StatusCode::PayloadTooLarge_413;
  12331. detail::clear_content(res);
  12332. return false;
  12333. }
  12334. return true;
  12335. }
  12336. }
  12337. // NOTE: `req.body` is not read here. For a regular handler the body is
  12338. // read inside dispatch_request(), after the route has matched and the
  12339. // pre-request handler has approved the request, so that a rejected
  12340. // request (e.g. failed authentication) never forces us to buffer a
  12341. // potentially large body.
  12342. }
  12343. // Regular handler
  12344. if (req.method == "GET" || req.method == "HEAD") {
  12345. return dispatch_request(req, res, get_handlers_, strm);
  12346. } else if (req.method == "POST") {
  12347. return dispatch_request(req, res, post_handlers_, strm);
  12348. } else if (req.method == "PUT") {
  12349. return dispatch_request(req, res, put_handlers_, strm);
  12350. } else if (req.method == "DELETE") {
  12351. return dispatch_request(req, res, delete_handlers_, strm);
  12352. } else if (req.method == "OPTIONS") {
  12353. return dispatch_request(req, res, options_handlers_, strm);
  12354. } else if (req.method == "PATCH") {
  12355. return dispatch_request(req, res, patch_handlers_, strm);
  12356. } else if (custom) {
  12357. return dispatch_request(req, res, custom->handlers, strm);
  12358. }
  12359. res.status = StatusCode::BadRequest_400;
  12360. return false;
  12361. }
  12362. inline bool Server::dispatch_request(Request &req, Response &res,
  12363. const Handlers &handlers, Stream &strm) {
  12364. for (const auto &x : handlers) {
  12365. const auto &matcher = x.first;
  12366. const auto &handler = x.second;
  12367. if (matcher->match(req)) {
  12368. req.matched_route = matcher->pattern();
  12369. // Run the pre-request handler before reading the body so a rejected
  12370. // request (e.g. failed authentication) never forces us to buffer a
  12371. // potentially large body. `req.matched_route` is available here.
  12372. if (pre_request_handler_ &&
  12373. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12374. return true;
  12375. }
  12376. // The route matched and the request was approved; read the body now.
  12377. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12378. output_error_log(Error::Read, &req);
  12379. return false;
  12380. }
  12381. handler(req, res);
  12382. return true;
  12383. }
  12384. }
  12385. return false;
  12386. }
  12387. // Decides the content coding for a response served straight from a file. Both
  12388. // the ETag, which has to name the representation actually sent, and
  12389. // `apply_static_file_compression()` go through this, so the two cannot drift
  12390. // apart.
  12391. inline detail::EncodingType
  12392. Server::static_file_encoding(const Request &req, const Response &res,
  12393. const std::string &content_type,
  12394. size_t length) const {
  12395. if (!static_file_compression_) { return detail::EncodingType::None; }
  12396. // Nothing to compress, and an empty file already answers with
  12397. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12398. // turn an empty body into a 20-byte gzip stream.
  12399. if (length == 0) { return detail::EncodingType::None; }
  12400. // A file that already fits in a single packet gains nothing from being made
  12401. // smaller, since it still travels in that one segment, and a file of a few
  12402. // bytes comes out larger than it went in.
  12403. if (length < static_file_compression_min_length_) {
  12404. return detail::EncodingType::None;
  12405. }
  12406. // RFC 9110 applies Range to the representation after content coding, so a
  12407. // compressed 206 would mean compressing the whole file and then slicing it.
  12408. // Serve ranges from the identity representation instead.
  12409. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12410. if (static_file_compression_max_length_ > 0 &&
  12411. length > static_file_compression_max_length_) {
  12412. return detail::EncodingType::None;
  12413. }
  12414. return detail::encoding_type(req, res, content_type);
  12415. }
  12416. // Compresses a file-backed content provider into `res.body`. Returns false when
  12417. // the response is left untouched.
  12418. inline bool Server::apply_static_file_compression(const Request &req,
  12419. Response &res) const {
  12420. auto type = res.content_coding_;
  12421. if (type == detail::EncodingType::None || !res.content_provider_) {
  12422. return false;
  12423. }
  12424. auto compressor = detail::make_compressor(type);
  12425. if (!compressor) { return false; }
  12426. output_pre_compression_log(req, res);
  12427. std::string compressed;
  12428. if (!detail::compress_content_provider(res.content_provider_,
  12429. res.content_length_, *compressor,
  12430. compressed)) {
  12431. return false;
  12432. }
  12433. res.body.swap(compressed);
  12434. // The provider was consumed in full, so its releaser hears about a success.
  12435. res.content_provider_success_ = true;
  12436. detail::clear_content_provider(res);
  12437. res.set_header("Content-Encoding", detail::encoding_name(type));
  12438. res.set_header("Vary", "Accept-Encoding");
  12439. return true;
  12440. }
  12441. inline void Server::apply_ranges(const Request &req, Response &res,
  12442. std::string &content_type,
  12443. std::string &boundary) const {
  12444. // A known-length content provider leaves `res.body` empty, so the compressor
  12445. // at the end of this function never runs for one (issue #2545). A file-backed
  12446. // provider is fully readable right here, so compress it and answer with an
  12447. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12448. // takes the same path as `set_content()` from here on. Range requests never
  12449. // get a content coding, so `Content-Range` still names identity bytes and
  12450. // none of the range handling below applies.
  12451. if (apply_static_file_compression(req, res)) { return; }
  12452. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12453. auto it = res.headers.find("Content-Type");
  12454. if (it != res.headers.end()) {
  12455. content_type = it->second;
  12456. res.headers.erase(it);
  12457. }
  12458. boundary = detail::make_multipart_data_boundary();
  12459. res.set_header("Content-Type",
  12460. "multipart/byteranges; boundary=" + boundary);
  12461. }
  12462. auto type = detail::encoding_type(req, res);
  12463. if (res.body.empty()) {
  12464. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12465. res.status == StatusCode::PartialContent_206) {
  12466. auto offset_and_length = detail::get_range_offset_and_length(
  12467. req.ranges[0], res.content_length_);
  12468. auto content_range = detail::make_content_range_header_field(
  12469. offset_and_length, res.content_length_);
  12470. res.set_header("Content-Range", content_range);
  12471. } else if (res.is_chunked_content_provider_) {
  12472. res.content_coding_ = type;
  12473. if (type != detail::EncodingType::None) {
  12474. res.set_header("Content-Encoding", detail::encoding_name(type));
  12475. res.set_header("Vary", "Accept-Encoding");
  12476. }
  12477. }
  12478. } else {
  12479. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12480. ;
  12481. } else if (req.ranges.size() == 1) {
  12482. auto offset_and_length =
  12483. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12484. auto offset = offset_and_length.first;
  12485. auto length = offset_and_length.second;
  12486. auto content_range = detail::make_content_range_header_field(
  12487. offset_and_length, res.body.size());
  12488. res.set_header("Content-Range", content_range);
  12489. assert(offset + length <= res.body.size());
  12490. res.body = res.body.substr(offset, length);
  12491. } else {
  12492. std::string data;
  12493. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12494. res.body.size(), data);
  12495. res.body.swap(data);
  12496. }
  12497. if (type != detail::EncodingType::None) {
  12498. output_pre_compression_log(req, res);
  12499. if (auto compressor = detail::make_compressor(type)) {
  12500. std::string compressed;
  12501. if (compressor->compress(res.body.data(), res.body.size(), true,
  12502. [&](const char *data, size_t data_len) {
  12503. compressed.append(data, data_len);
  12504. return true;
  12505. })) {
  12506. res.body.swap(compressed);
  12507. res.set_header("Content-Encoding", detail::encoding_name(type));
  12508. res.set_header("Vary", "Accept-Encoding");
  12509. }
  12510. }
  12511. }
  12512. res.content_length_ = res.body.size();
  12513. }
  12514. }
  12515. inline bool Server::dispatch_request_for_content_reader(
  12516. Request &req, Response &res, ContentReader content_reader,
  12517. const HandlersForContentReader &handlers) const {
  12518. for (const auto &x : handlers) {
  12519. const auto &matcher = x.first;
  12520. const auto &handler = x.second;
  12521. if (matcher->match(req)) {
  12522. req.matched_route = matcher->pattern();
  12523. if (!pre_request_handler_ ||
  12524. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12525. handler(req, res, content_reader);
  12526. }
  12527. return true;
  12528. }
  12529. }
  12530. return false;
  12531. }
  12532. inline std::string
  12533. get_client_ip(const std::string &x_forwarded_for,
  12534. const std::vector<std::string> &trusted_proxies) {
  12535. // X-Forwarded-For is a comma-separated list per RFC 7239
  12536. std::vector<std::string> ip_list;
  12537. detail::split(x_forwarded_for.data(),
  12538. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12539. [&](const char *b, const char *e) {
  12540. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12541. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12542. });
  12543. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12544. // no segments. Signal "no client IP derived" with an empty string so the
  12545. // caller can fall back to the connection-level remote address.
  12546. if (ip_list.empty()) { return std::string(); }
  12547. // Each hop appends the address it received the request from, so the rightmost
  12548. // entries are the ones written by our own infrastructure while the leftmost
  12549. // are whatever the original client chose to send. Walk from the right and
  12550. // skip trusted proxies; the first address that is not a trusted proxy is the
  12551. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12552. // from the left instead lets a client forge an arbitrary address by following
  12553. // it with a trusted proxy's address, which the left-to-right scan then
  12554. // returned as the client.
  12555. for (size_t i = ip_list.size(); i-- > 0;) {
  12556. const auto &ip = ip_list[i];
  12557. auto is_trusted_proxy =
  12558. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12559. [&](const std::string &proxy) { return ip == proxy; });
  12560. if (!is_trusted_proxy) { return ip; }
  12561. }
  12562. // Every hop was a trusted proxy; fall back to the first entry.
  12563. return ip_list.front();
  12564. }
  12565. inline bool
  12566. Server::process_request(Stream &strm, const std::string &remote_addr,
  12567. int remote_port, const std::string &local_addr,
  12568. int local_port, bool close_connection,
  12569. bool &connection_closed,
  12570. const std::function<void(Request &)> &setup_request,
  12571. bool *websocket_upgraded) {
  12572. std::array<char, 2048> buf{};
  12573. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12574. // The read timeout bounds the request line and headers as a whole, so a
  12575. // client sending them a byte at a time cannot hold the worker any longer.
  12576. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12577. // Connection has been closed on client
  12578. if (!line_reader.getline()) { return false; }
  12579. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12580. // clients send an extra CRLF after a request body, which would otherwise be
  12581. // parsed as the next request on a persistent connection.
  12582. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12583. return false;
  12584. }
  12585. Request req;
  12586. req.start_time_ = std::chrono::steady_clock::now();
  12587. req.remote_addr = remote_addr;
  12588. req.remote_port = remote_port;
  12589. req.local_addr = local_addr;
  12590. req.local_port = local_port;
  12591. Response res;
  12592. res.version = "HTTP/1.1";
  12593. res.headers = default_headers_;
  12594. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12595. // close the connection after that response, whichever path wrote it (an
  12596. // error status, a handler, or a rejected request). Reading on would also
  12597. // parse whatever the client sent next on a connection it considers done.
  12598. auto honor_connection_close = detail::scope_exit([&] {
  12599. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12600. connection_closed = true;
  12601. }
  12602. });
  12603. // Request line and headers. A rejected message leaves the rest of it (and
  12604. // any body) unread, so the connection cannot be reused: the leftover bytes
  12605. // would be parsed as the next request.
  12606. if (!parse_request_line(line_reader.ptr(), req)) {
  12607. connection_closed = true;
  12608. res.status = StatusCode::BadRequest_400;
  12609. output_error_log(Error::InvalidRequestLine, &req);
  12610. return write_response(strm, close_connection, req, res);
  12611. }
  12612. // Request headers
  12613. if (!detail::read_headers(strm, req.headers)) {
  12614. connection_closed = true;
  12615. res.status = StatusCode::BadRequest_400;
  12616. output_error_log(Error::InvalidHeaders, &req);
  12617. return write_response(strm, close_connection, req, res);
  12618. }
  12619. strm.set_max_timeout(0);
  12620. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12621. // which would otherwise let an intermediary and this parser disagree on
  12622. // where the body ends and enable request smuggling. Three cases: a
  12623. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12624. // or empty), which would otherwise be read as "no body"; a non-zero
  12625. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12626. // tolerated for compatibility with existing clients); and a
  12627. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12628. // length undeterminable. None of them may fall through to the "no body"
  12629. // path, or the body bytes are parsed as the next request on a persistent
  12630. // connection.
  12631. auto is_invalid_content_length = false;
  12632. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12633. is_invalid_content_length);
  12634. if (is_invalid_content_length ||
  12635. detail::has_conflicting_content_length(req.headers) ||
  12636. (req.has_header("Transfer-Encoding") &&
  12637. !detail::is_chunked_transfer_encoding(req.headers))) {
  12638. connection_closed = true;
  12639. res.status = StatusCode::BadRequest_400;
  12640. return write_response(strm, close_connection, req, res);
  12641. }
  12642. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12643. // HTTP/1.0 request, is honoured, but the connection closes after the
  12644. // response.
  12645. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12646. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12647. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12648. // the same authority.
  12649. auto host_count = req.get_header_value_count("Host");
  12650. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12651. !detail::fields::is_host(req.get_header_value("Host"))) {
  12652. connection_closed = true;
  12653. res.status = StatusCode::BadRequest_400;
  12654. output_error_log(Error::InvalidHeaders, &req);
  12655. return write_response(strm, close_connection, req, res);
  12656. }
  12657. // Check if the request URI doesn't exceed the limit
  12658. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12659. connection_closed = true;
  12660. res.status = StatusCode::UriTooLong_414;
  12661. output_error_log(Error::ExceedUriMaxLength, &req);
  12662. return write_response(strm, close_connection, req, res);
  12663. }
  12664. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12665. connection_closed = true;
  12666. }
  12667. if (req.version == "HTTP/1.0" &&
  12668. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12669. connection_closed = true;
  12670. }
  12671. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12672. // itself a trusted proxy. Otherwise any direct client could spoof
  12673. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12674. auto is_trusted_peer = std::any_of(
  12675. trusted_proxies_.begin(), trusted_proxies_.end(),
  12676. [&](const std::string &proxy) { return proxy == remote_addr; });
  12677. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12678. // Some proxies append the address they observed as a separate
  12679. // X-Forwarded-For field line instead of extending the one the client sent
  12680. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12681. // be scanned. Reading only the first occurrence would hand back the
  12682. // client-supplied, and therefore forgeable, value.
  12683. auto x_forwarded_for =
  12684. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12685. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12686. req.remote_addr = derived.empty() ? remote_addr : derived;
  12687. } else {
  12688. req.remote_addr = remote_addr;
  12689. }
  12690. req.remote_port = remote_port;
  12691. req.local_addr = local_addr;
  12692. req.local_port = local_port;
  12693. if (req.has_header("Accept")) {
  12694. auto accept_header =
  12695. detail::get_combined_header_value(req.headers, "Accept");
  12696. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12697. connection_closed = true;
  12698. res.status = StatusCode::BadRequest_400;
  12699. output_error_log(Error::HTTPParsing, &req);
  12700. return write_response(strm, close_connection, req, res);
  12701. }
  12702. }
  12703. if (req.has_header("Range")) {
  12704. const auto &range_header_value = req.get_header_value("Range");
  12705. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12706. connection_closed = true;
  12707. res.status = StatusCode::RangeNotSatisfiable_416;
  12708. output_error_log(Error::InvalidRangeHeader, &req);
  12709. return write_response(strm, close_connection, req, res);
  12710. }
  12711. }
  12712. if (setup_request) { setup_request(req); }
  12713. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12714. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12715. // must be ignored. An expectation we do not recognize is left alone; the
  12716. // 417 the section allows for one is a MAY, not a requirement.
  12717. //
  12718. // `100 Continue` itself is deferred until the body is actually read (see
  12719. // read_content_core), so a request rejected by a later handler never
  12720. // invites the client to send a body nobody will read.
  12721. if (req.version != "HTTP/1.0" &&
  12722. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12723. int status = StatusCode::Continue_100;
  12724. if (expect_100_continue_handler_) {
  12725. status = expect_100_continue_handler_(req, res);
  12726. }
  12727. if (status == StatusCode::Continue_100) {
  12728. req.expect_100_continue_pending_ = true;
  12729. } else {
  12730. if (res.status == -1) { res.status = status; }
  12731. connection_closed = true;
  12732. return write_response(strm, true, req, res);
  12733. }
  12734. }
  12735. // Setup `is_connection_closed` method
  12736. auto sock = strm.socket();
  12737. req.is_connection_closed = [sock]() {
  12738. return !detail::is_socket_alive(sock);
  12739. };
  12740. // WebSocket upgrade
  12741. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12742. // that authentication and other middleware can reject the request with an
  12743. // HTTP response (e.g., 401) before the protocol switches.
  12744. // The response says so when this connection closes after it.
  12745. auto close_after_response = close_connection || connection_closed;
  12746. if (detail::is_websocket_upgrade(req)) {
  12747. if (pre_routing_handler_ &&
  12748. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12749. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12750. return write_response_with_content(strm, close_after_response, req, res);
  12751. }
  12752. // Find matching WebSocket handler
  12753. for (const auto &entry : websocket_handlers_) {
  12754. if (entry.matcher->match(req)) {
  12755. req.matched_route = entry.matcher->pattern();
  12756. if (pre_request_handler_ &&
  12757. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12758. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12759. return write_response_with_content(strm, close_after_response, req,
  12760. res);
  12761. }
  12762. // Compute accept key
  12763. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12764. auto accept_key = detail::websocket_accept_key(client_key);
  12765. // Negotiate subprotocol
  12766. std::string selected_subprotocol;
  12767. if (entry.sub_protocol_selector) {
  12768. auto protocol_header = detail::get_combined_header_value(
  12769. req.headers, "Sec-WebSocket-Protocol");
  12770. if (!protocol_header.empty()) {
  12771. std::vector<std::string> protocols;
  12772. detail::split(protocol_header.data(),
  12773. protocol_header.data() + protocol_header.size(), ',',
  12774. [&](const char *b, const char *e) {
  12775. protocols.emplace_back(b, e);
  12776. });
  12777. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12778. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12779. if (std::find(protocols.begin(), protocols.end(),
  12780. selected_subprotocol) == protocols.end()) {
  12781. selected_subprotocol.clear();
  12782. }
  12783. }
  12784. }
  12785. // Send 101 Switching Protocols
  12786. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12787. "Upgrade: websocket\r\n"
  12788. "Connection: Upgrade\r\n"
  12789. "Sec-WebSocket-Accept: " +
  12790. accept_key + "\r\n";
  12791. if (!selected_subprotocol.empty()) {
  12792. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12793. return false;
  12794. }
  12795. handshake_response +=
  12796. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12797. }
  12798. handshake_response += "\r\n";
  12799. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12800. 0) {
  12801. return false;
  12802. }
  12803. connection_closed = true;
  12804. if (websocket_upgraded) { *websocket_upgraded = true; }
  12805. {
  12806. #ifdef CPPHTTPLIB_SSL_ENABLED
  12807. if (req.ssl) {
  12808. // wss: the heartbeat ping thread and the read path enter the same
  12809. // TLS session from different threads. Hand the WebSocket a stream
  12810. // that serializes every TLS call, so the shared SSLSocketStream on
  12811. // the plain HTTP/HTTPS paths stays untouched.
  12812. auto ws_strm =
  12813. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12814. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12815. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12816. write_timeout_sec_, write_timeout_usec_));
  12817. ws::WebSocket ws(std::move(ws_strm), req, true,
  12818. websocket_ping_interval_sec_,
  12819. websocket_max_missed_pongs_);
  12820. entry.handler(req, ws);
  12821. return true;
  12822. }
  12823. #endif
  12824. // Use WebSocket-specific read timeout instead of HTTP timeout
  12825. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12826. 0);
  12827. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12828. websocket_max_missed_pongs_);
  12829. entry.handler(req, ws);
  12830. }
  12831. return true;
  12832. }
  12833. }
  12834. // No matching handler - fall through to 404
  12835. }
  12836. // Routing
  12837. auto routed = false;
  12838. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12839. routed = routing(req, res, strm);
  12840. #else
  12841. try {
  12842. routed = routing(req, res, strm);
  12843. } catch (std::exception &) {
  12844. if (exception_handler_) {
  12845. auto ep = std::current_exception();
  12846. exception_handler_(req, res, ep);
  12847. routed = true;
  12848. } else {
  12849. res.status = StatusCode::InternalServerError_500;
  12850. }
  12851. } catch (...) {
  12852. if (exception_handler_) {
  12853. auto ep = std::current_exception();
  12854. exception_handler_(req, res, ep);
  12855. routed = true;
  12856. } else {
  12857. res.status = StatusCode::InternalServerError_500;
  12858. }
  12859. }
  12860. #endif
  12861. auto ret = false;
  12862. if (routed) {
  12863. if (res.status == -1) {
  12864. res.status = req.ranges.empty() ? StatusCode::OK_200
  12865. : StatusCode::PartialContent_206;
  12866. }
  12867. // Before the Range checks below, so they see the body's own length.
  12868. detail::prefer_assigned_body(res);
  12869. // Serve file content by using a content provider
  12870. auto file_open_error = false;
  12871. if (!res.file_content_path_.empty()) {
  12872. const auto &path = res.file_content_path_;
  12873. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12874. if (!mm->is_open()) {
  12875. res.status = StatusCode::NotFound_404;
  12876. output_error_log(Error::OpenFile, &req);
  12877. file_open_error = true;
  12878. } else {
  12879. auto content_type = res.file_content_content_type_;
  12880. if (content_type.empty()) {
  12881. content_type = detail::find_content_type(
  12882. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12883. }
  12884. detail::set_file_content_provider(
  12885. res, mm, content_type,
  12886. static_file_encoding(req, res, content_type, mm->size()));
  12887. }
  12888. }
  12889. if (file_open_error) {
  12890. ret = write_response(strm, close_after_response, req, res);
  12891. } else if (detail::range_error(req, res)) {
  12892. detail::clear_content(res);
  12893. res.status = StatusCode::RangeNotSatisfiable_416;
  12894. ret = write_response(strm, close_after_response, req, res);
  12895. } else {
  12896. ret = write_response_with_content(strm, close_after_response, req, res);
  12897. }
  12898. } else {
  12899. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12900. ret = write_response(strm, close_after_response, req, res);
  12901. }
  12902. // Drain any unconsumed framed body to prevent request smuggling on
  12903. // keep-alive. Without framing there is no body to drain — reading would
  12904. // consume the next request (issue #2450). If the response has committed the
  12905. // connection to close, there is no next request to protect. A body read in
  12906. // part cannot be drained from where it stopped, so the connection closes.
  12907. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12908. !detail::has_header_token(res.headers, "Connection", "close")) {
  12909. int dummy_status;
  12910. if (req.body_read_started_ ||
  12911. !detail::read_content(
  12912. strm, req, payload_max_length_, dummy_status, nullptr,
  12913. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12914. connection_closed = true;
  12915. }
  12916. }
  12917. return ret;
  12918. }
  12919. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12920. inline bool Server::process_and_close_socket(socket_t sock) {
  12921. std::string remote_addr;
  12922. int remote_port = 0;
  12923. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12924. std::string local_addr;
  12925. int local_port = 0;
  12926. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12927. bool websocket_upgraded = false;
  12928. auto ret = serve_guarded([&]() {
  12929. return detail::process_server_socket(
  12930. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12931. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12932. write_timeout_usec_,
  12933. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12934. return process_request(strm, remote_addr, remote_port, local_addr,
  12935. local_port, close_connection,
  12936. connection_closed, nullptr,
  12937. &websocket_upgraded);
  12938. });
  12939. });
  12940. detail::drain_and_close_socket(sock);
  12941. return ret;
  12942. }
  12943. inline void Server::output_log(const Request &req, const Response &res) const {
  12944. if (logger_) {
  12945. std::lock_guard<std::mutex> guard(logger_mutex_);
  12946. logger_(req, res);
  12947. }
  12948. }
  12949. inline void Server::output_pre_compression_log(const Request &req,
  12950. const Response &res) const {
  12951. if (pre_compression_logger_) {
  12952. std::lock_guard<std::mutex> guard(logger_mutex_);
  12953. pre_compression_logger_(req, res);
  12954. }
  12955. }
  12956. inline void Server::output_error_log(const Error &err,
  12957. const Request *req) const {
  12958. if (error_logger_) {
  12959. std::lock_guard<std::mutex> guard(logger_mutex_);
  12960. error_logger_(err, req);
  12961. }
  12962. }
  12963. /*
  12964. * Group 5: ClientImpl and Client (Universal) implementation
  12965. */
  12966. // HTTP client implementation
  12967. inline ClientImpl::ClientImpl(const std::string &host)
  12968. : ClientImpl(host, 80, std::string(), std::string()) {}
  12969. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12970. : ClientImpl(host, port, std::string(), std::string()) {}
  12971. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12972. const std::string &client_cert_path,
  12973. const std::string &client_key_path)
  12974. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12975. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12976. inline ClientImpl::~ClientImpl() {
  12977. // Wait until all the requests in flight are handled.
  12978. size_t retry_count = 10;
  12979. while (retry_count-- > 0) {
  12980. {
  12981. std::lock_guard<std::mutex> guard(socket_mutex_);
  12982. if (socket_requests_in_flight_ == 0) { break; }
  12983. }
  12984. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12985. }
  12986. std::lock_guard<std::mutex> guard(socket_mutex_);
  12987. shutdown_socket(socket_);
  12988. close_socket(socket_);
  12989. }
  12990. inline bool ClientImpl::is_valid() const { return true; }
  12991. inline bool
  12992. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12993. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12994. if (no_proxy_entries_.empty()) { return true; }
  12995. // host_ is const so its normalized form is invariant; cache it. The
  12996. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12997. if (host == host_) {
  12998. if (!host_normalized_valid_) {
  12999. host_normalized_ = detail::normalize_target(host_);
  13000. host_normalized_valid_ = true;
  13001. }
  13002. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13003. }
  13004. auto target = detail::normalize_target(host);
  13005. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13006. }
  13007. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13008. if (is_proxy_enabled_for_host(host_)) {
  13009. return detail::create_client_socket(
  13010. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13011. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13012. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13013. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13014. }
  13015. // Check is custom IP or hostname specified for host_
  13016. std::string connect_host;
  13017. std::string ip;
  13018. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13019. return detail::create_client_socket(
  13020. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13021. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13022. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13023. write_timeout_usec_, interface_, error);
  13024. }
  13025. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13026. Error &error) {
  13027. auto sock = create_client_socket(error);
  13028. if (sock == INVALID_SOCKET) { return false; }
  13029. socket.sock = sock;
  13030. return true;
  13031. }
  13032. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13033. return create_and_connect_socket(socket, error);
  13034. }
  13035. inline bool ClientImpl::setup_proxy_connection(
  13036. Socket & /*socket*/,
  13037. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13038. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13039. return true;
  13040. }
  13041. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13042. bool /*shutdown_gracefully*/) {
  13043. // If there are any requests in flight from threads other than us, then it's
  13044. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13045. assert(socket_requests_in_flight_ == 0 ||
  13046. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13047. }
  13048. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13049. if (socket.sock == INVALID_SOCKET) { return; }
  13050. detail::shutdown_socket(socket.sock);
  13051. }
  13052. inline void ClientImpl::close_socket(Socket &socket) {
  13053. // If there are requests in flight in another thread, usually closing
  13054. // the socket will be fine and they will simply receive an error when
  13055. // using the closed socket, but it is still a bug since rarely the OS
  13056. // may reassign the socket id to be used for a new socket, and then
  13057. // suddenly they will be operating on a live socket that is different
  13058. // than the one they intended!
  13059. assert(socket_requests_in_flight_ == 0 ||
  13060. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13061. // It is also a bug if this happens while SSL is still active
  13062. #ifdef CPPHTTPLIB_SSL_ENABLED
  13063. assert(socket.ssl == nullptr);
  13064. #endif
  13065. if (socket.sock == INVALID_SOCKET) { return; }
  13066. detail::close_socket(socket.sock);
  13067. socket.sock = INVALID_SOCKET;
  13068. }
  13069. inline void ClientImpl::disconnect(bool gracefully) {
  13070. shutdown_ssl(socket_, gracefully);
  13071. shutdown_socket(socket_);
  13072. close_socket(socket_);
  13073. }
  13074. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13075. Response &res,
  13076. bool skip_100_continue) const {
  13077. std::array<char, 2048> buf{};
  13078. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13079. if (!line_reader.getline()) { return false; }
  13080. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13081. res.reason)) {
  13082. return req.method == "CONNECT";
  13083. }
  13084. // Skip interim (1xx) responses along with their header fields, except a 100
  13085. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13086. // HTTP on the connection, so it is final.
  13087. while (100 <= res.status && res.status < 200 &&
  13088. res.status != StatusCode::SwitchingProtocol_101 &&
  13089. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13090. Headers interim_headers;
  13091. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13092. if (!line_reader.getline()) { return false; } // next response line
  13093. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13094. res.reason)) {
  13095. return false;
  13096. }
  13097. }
  13098. return true;
  13099. }
  13100. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13101. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13102. auto ret = send_(req, res, error);
  13103. if (error == Error::SSLPeerCouldBeClosed_) {
  13104. assert(!ret);
  13105. ret = send_(req, res, error);
  13106. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13107. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13108. }
  13109. return ret;
  13110. }
  13111. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13112. {
  13113. std::lock_guard<std::mutex> guard(socket_mutex_);
  13114. // Set this to false immediately - if it ever gets set to true by the end
  13115. // of the request, we know another thread instructed us to close the
  13116. // socket.
  13117. socket_should_be_closed_when_request_is_done_ = false;
  13118. auto is_alive = false;
  13119. if (socket_.is_open()) {
  13120. is_alive = detail::is_socket_alive(socket_.sock);
  13121. #ifdef CPPHTTPLIB_SSL_ENABLED
  13122. if (is_alive && is_ssl()) {
  13123. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13124. is_alive = false;
  13125. }
  13126. }
  13127. #endif
  13128. if (!is_alive) {
  13129. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13130. disconnect(/*gracefully=*/false);
  13131. }
  13132. }
  13133. if (!is_alive) {
  13134. if (!ensure_socket_connection(socket_, error)) {
  13135. output_error_log(error, &req);
  13136. return false;
  13137. }
  13138. {
  13139. auto success = true;
  13140. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13141. error)) {
  13142. if (!success) { output_error_log(error, &req); }
  13143. return success;
  13144. }
  13145. }
  13146. }
  13147. // Mark the current socket as being in use so that it cannot be closed by
  13148. // anyone else while this request is ongoing, even though we will be
  13149. // releasing the mutex.
  13150. if (socket_requests_in_flight_ > 1) {
  13151. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13152. }
  13153. socket_requests_in_flight_ += 1;
  13154. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13155. }
  13156. for (const auto &header : default_headers_) {
  13157. if (req.headers.find(header.first) == req.headers.end()) {
  13158. req.headers.insert(header);
  13159. }
  13160. }
  13161. auto ret = false;
  13162. auto close_connection = !keep_alive_;
  13163. auto se = detail::scope_exit([&]() {
  13164. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13165. std::lock_guard<std::mutex> guard(socket_mutex_);
  13166. socket_requests_in_flight_ -= 1;
  13167. if (socket_requests_in_flight_ <= 0) {
  13168. assert(socket_requests_in_flight_ == 0);
  13169. socket_requests_are_from_thread_ = std::thread::id();
  13170. }
  13171. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13172. !ret) {
  13173. disconnect(/*gracefully=*/true);
  13174. }
  13175. });
  13176. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13177. return handle_request(strm, req, res, close_connection, error);
  13178. });
  13179. if (!ret) {
  13180. if (error == Error::Success) {
  13181. error = Error::Unknown;
  13182. output_error_log(error, &req);
  13183. }
  13184. }
  13185. return ret;
  13186. }
  13187. inline Result ClientImpl::send(const Request &req) {
  13188. auto req2 = req;
  13189. return send_(std::move(req2));
  13190. }
  13191. inline Result ClientImpl::send_(Request &&req) {
  13192. auto res = detail::make_unique<Response>();
  13193. auto error = Error::Success;
  13194. auto ret = send(req, *res, error);
  13195. #ifdef CPPHTTPLIB_SSL_ENABLED
  13196. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13197. last_ssl_error_, last_backend_error_};
  13198. #else
  13199. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13200. #endif
  13201. }
  13202. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13203. const std::string &ct) {
  13204. (void)for_stream;
  13205. // Default headers are meant for the origin and may carry its credentials, so
  13206. // keep them off the CONNECT request the proxy reads.
  13207. if (r.method != "CONNECT") {
  13208. for (const auto &header : default_headers_) {
  13209. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13210. }
  13211. }
  13212. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13213. // prepend it rather than appending it after the caller's own fields.
  13214. if (!r.has_header("Host")) {
  13215. r.headers.emplace_front(
  13216. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13217. address_family_));
  13218. }
  13219. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13220. if (!r.content_receiver) {
  13221. if (!r.has_header("Accept-Encoding")) {
  13222. std::string accept_encoding;
  13223. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13224. accept_encoding = "br";
  13225. #endif
  13226. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13227. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13228. accept_encoding += "gzip, deflate";
  13229. #endif
  13230. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13231. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13232. accept_encoding += "zstd";
  13233. #endif
  13234. r.set_header("Accept-Encoding", accept_encoding);
  13235. }
  13236. detail::add_default_user_agent_header(r);
  13237. }
  13238. if (!r.body.empty()) {
  13239. if (!ct.empty() && !r.has_header("Content-Type")) {
  13240. r.headers.emplace("Content-Type", ct);
  13241. }
  13242. if (!r.has_header("Content-Length")) {
  13243. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13244. }
  13245. }
  13246. }
  13247. inline ClientImpl::StreamHandle
  13248. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13249. const Params &params, const Headers &headers,
  13250. const std::string &body,
  13251. const std::string &content_type) {
  13252. StreamHandle handle;
  13253. handle.response = detail::make_unique<Response>();
  13254. handle.error = Error::Success;
  13255. // Encode the target exactly like the buffered send path does, so that the
  13256. // same `path` produces the same request line through either API.
  13257. auto raw_query_path =
  13258. params.empty() ? path : append_query_params(path, params);
  13259. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13260. handle.connection_ = detail::make_unique<ClientConnection>();
  13261. {
  13262. std::lock_guard<std::mutex> guard(socket_mutex_);
  13263. auto is_alive = false;
  13264. if (socket_.is_open()) {
  13265. is_alive = detail::is_socket_alive(socket_.sock);
  13266. #ifdef CPPHTTPLIB_SSL_ENABLED
  13267. if (is_alive && is_ssl()) {
  13268. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13269. is_alive = false;
  13270. }
  13271. }
  13272. #endif
  13273. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13274. }
  13275. if (!is_alive) {
  13276. if (!ensure_socket_connection(socket_, handle.error)) {
  13277. handle.response.reset();
  13278. return handle;
  13279. }
  13280. {
  13281. auto success = true;
  13282. auto start_time = std::chrono::steady_clock::now();
  13283. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13284. success, handle.error)) {
  13285. if (!success) { handle.response.reset(); }
  13286. return handle;
  13287. }
  13288. }
  13289. }
  13290. transfer_socket_ownership_to_handle(handle);
  13291. }
  13292. #ifdef CPPHTTPLIB_SSL_ENABLED
  13293. if (is_ssl() && handle.connection_->session) {
  13294. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13295. handle.connection_->sock, handle.connection_->session,
  13296. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13297. write_timeout_usec_);
  13298. } else {
  13299. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13300. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13301. write_timeout_sec_, write_timeout_usec_);
  13302. }
  13303. #else
  13304. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13305. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13306. write_timeout_sec_, write_timeout_usec_);
  13307. #endif
  13308. handle.stream_ = handle.socket_stream_.get();
  13309. Request req;
  13310. req.method = method;
  13311. req.path = query_path;
  13312. req.headers = headers;
  13313. req.body = body;
  13314. prepare_default_headers(req, true, content_type);
  13315. auto &strm = *handle.stream_;
  13316. // Build the request line and headers in memory first, like write_request()
  13317. // does, so that a rejected header leaves nothing on the wire.
  13318. {
  13319. detail::BufferStream bstrm;
  13320. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13321. handle.error = Error::Write;
  13322. handle.response.reset();
  13323. return handle;
  13324. }
  13325. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13326. handle.error)) {
  13327. handle.response.reset();
  13328. return handle;
  13329. }
  13330. const auto &data = bstrm.get_buffer();
  13331. if (!detail::write_data(strm, data.data(), data.size())) {
  13332. handle.error = Error::Write;
  13333. handle.response.reset();
  13334. return handle;
  13335. }
  13336. }
  13337. if (!body.empty()) {
  13338. if (strm.write(body.data(), body.size()) < 0) {
  13339. handle.error = Error::Write;
  13340. handle.response.reset();
  13341. return handle;
  13342. }
  13343. }
  13344. if (!read_response_line(strm, req, *handle.response) ||
  13345. !detail::read_headers(strm, handle.response->headers)) {
  13346. handle.error = Error::Read;
  13347. handle.response.reset();
  13348. return handle;
  13349. }
  13350. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13351. // (204/304) response legitimately carries framing headers with no body.
  13352. if (method != "HEAD" &&
  13353. handle.response->status != StatusCode::NoContent_204 &&
  13354. handle.response->status != StatusCode::NotModified_304 &&
  13355. detail::has_conflicting_content_length(handle.response->headers)) {
  13356. handle.error = Error::Read;
  13357. handle.response.reset();
  13358. return handle;
  13359. }
  13360. handle.body_reader_.stream = handle.stream_;
  13361. handle.body_reader_.payload_max_length = payload_max_length_;
  13362. if (handle.response->has_header("Content-Length")) {
  13363. bool is_invalid = false;
  13364. auto content_length = detail::get_header_value_u64(
  13365. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13366. if (is_invalid) {
  13367. handle.error = Error::Read;
  13368. handle.response.reset();
  13369. return handle;
  13370. }
  13371. handle.body_reader_.has_content_length = true;
  13372. handle.body_reader_.content_length = content_length;
  13373. }
  13374. handle.body_reader_.chunked =
  13375. detail::is_chunked_transfer_encoding(handle.response->headers);
  13376. auto content_encoding = detail::get_combined_header_value(
  13377. handle.response->headers, "Content-Encoding");
  13378. if (!content_encoding.empty()) {
  13379. // Same policy as prepare_content_receiver(): reject a coding we know about
  13380. // but were not built with, pass an unrecognized one through as-is.
  13381. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13382. if (!handle.decompressor_) {
  13383. if (detail::is_known_content_encoding(content_encoding)) {
  13384. handle.error = Error::UnsupportedContentEncoding;
  13385. handle.response.reset();
  13386. return handle;
  13387. }
  13388. } else if (!handle.decompressor_->is_valid()) {
  13389. handle.error = Error::Compression;
  13390. handle.response.reset();
  13391. return handle;
  13392. }
  13393. }
  13394. return handle;
  13395. }
  13396. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13397. if (!is_valid() || !response) { return -1; }
  13398. if (decompressor_) { return read_with_decompression(buf, len); }
  13399. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13400. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13401. trailers_parsed_ = true;
  13402. if (body_reader_.chunked_decoder) {
  13403. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13404. response->trailers, response->headers)) {
  13405. return n;
  13406. }
  13407. } else {
  13408. detail::ChunkedDecoder dec(*stream_);
  13409. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13410. return n;
  13411. }
  13412. }
  13413. }
  13414. return n;
  13415. }
  13416. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13417. size_t len) {
  13418. if (decompress_offset_ < decompress_buffer_.size()) {
  13419. auto available = decompress_buffer_.size() - decompress_offset_;
  13420. auto to_copy = (std::min)(len, available);
  13421. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13422. decompress_offset_ += to_copy;
  13423. decompressed_bytes_read_ += to_copy;
  13424. return static_cast<ssize_t>(to_copy);
  13425. }
  13426. decompress_buffer_.clear();
  13427. decompress_offset_ = 0;
  13428. constexpr size_t kDecompressionBufferSize = 8192;
  13429. char compressed_buf[kDecompressionBufferSize];
  13430. while (true) {
  13431. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13432. sizeof(compressed_buf));
  13433. if (n <= 0) { return n; }
  13434. auto exceeded = false;
  13435. bool decompress_ok = decompressor_->decompress(
  13436. compressed_buf, static_cast<size_t>(n),
  13437. [&](const char *data, size_t data_len) {
  13438. decompress_buffer_.append(data, data_len);
  13439. auto limit = body_reader_.payload_max_length;
  13440. exceeded =
  13441. limit > 0 &&
  13442. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13443. return !exceeded;
  13444. });
  13445. if (!decompress_ok) {
  13446. body_reader_.last_error =
  13447. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13448. return -1;
  13449. }
  13450. if (!decompress_buffer_.empty()) { break; }
  13451. }
  13452. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13453. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13454. decompress_offset_ = to_copy;
  13455. decompressed_bytes_read_ += to_copy;
  13456. return static_cast<ssize_t>(to_copy);
  13457. }
  13458. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13459. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13460. return;
  13461. }
  13462. trailers_parsed_ = true;
  13463. const auto bufsiz = 128;
  13464. char line_buf[bufsiz];
  13465. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13466. if (!line_reader.getline()) { return; }
  13467. if (!detail::parse_trailers(line_reader, response->trailers,
  13468. response->headers)) {
  13469. return;
  13470. }
  13471. }
  13472. namespace detail {
  13473. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13474. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13475. size_t &out_chunk_offset,
  13476. size_t &out_chunk_total) {
  13477. if (finished) { return 0; }
  13478. if (chunk_remaining == 0) {
  13479. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13480. if (!lr.getline()) { return -1; }
  13481. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13482. // the line terminator is never mistaken for line content.
  13483. const char *eol = lr.ptr() + lr.size();
  13484. if (lr.end_with_crlf()) {
  13485. eol -= 2;
  13486. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13487. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13488. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13489. // has to come off here or the check below would reject the line.
  13490. eol -= 1;
  13491. }
  13492. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13493. const char *p = lr.ptr();
  13494. int v = 0;
  13495. if (p == eol || !is_hex(*p, v)) { return -1; }
  13496. size_t chunk_len = 0;
  13497. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13498. for (; p < eol && is_hex(*p, v); ++p) {
  13499. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13500. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13501. }
  13502. while (p < eol && is_space_or_tab(*p)) {
  13503. ++p;
  13504. }
  13505. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13506. // terminator, and it is built from tokens and quoted-strings, so it never
  13507. // holds a CR, LF or any other control character. getline() reads up to the
  13508. // CRLF, so a bare LF left in here would be swallowed as extension text
  13509. // while an intermediary that ends the line on it delimits the chunks
  13510. // differently, and the two disagree on where the body ends (request
  13511. // smuggling).
  13512. if (p < eol && *p != ';') { return -1; }
  13513. for (; p < eol; ++p) {
  13514. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13515. }
  13516. if (chunk_len == 0) {
  13517. chunk_remaining = 0;
  13518. finished = true;
  13519. out_chunk_offset = 0;
  13520. out_chunk_total = 0;
  13521. return 0;
  13522. }
  13523. chunk_remaining = chunk_len;
  13524. last_chunk_total = chunk_remaining;
  13525. last_chunk_offset = 0;
  13526. }
  13527. auto to_read = (std::min)(chunk_remaining, len);
  13528. auto n = strm.read(buf, to_read);
  13529. if (n <= 0) { return -1; }
  13530. auto offset_before = last_chunk_offset;
  13531. last_chunk_offset += static_cast<size_t>(n);
  13532. chunk_remaining -= static_cast<size_t>(n);
  13533. out_chunk_offset = offset_before;
  13534. out_chunk_total = last_chunk_total;
  13535. if (chunk_remaining == 0) {
  13536. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13537. if (!lr.getline()) { return -1; }
  13538. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13539. }
  13540. return n;
  13541. }
  13542. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13543. const Headers &src_headers) {
  13544. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13545. if (!lr.getline()) { return false; }
  13546. return parse_trailers(lr, dest, src_headers);
  13547. }
  13548. } // namespace detail
  13549. inline void
  13550. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13551. handle.connection_->sock = socket_.sock;
  13552. #ifdef CPPHTTPLIB_SSL_ENABLED
  13553. handle.connection_->session = socket_.ssl;
  13554. socket_.ssl = nullptr;
  13555. #endif
  13556. socket_.sock = INVALID_SOCKET;
  13557. }
  13558. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13559. Response &res, bool close_connection,
  13560. Error &error) {
  13561. if (req.path.empty()) {
  13562. error = Error::Connection;
  13563. output_error_log(error, &req);
  13564. return false;
  13565. }
  13566. auto req_save = req;
  13567. bool ret;
  13568. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13569. auto req2 = req;
  13570. req2.path = "http://" +
  13571. detail::make_host_and_port_string(host_, port_, false) +
  13572. req.path;
  13573. ret = process_request(strm, req2, res, close_connection, error);
  13574. req = std::move(req2);
  13575. req.path = req_save.path;
  13576. } else {
  13577. ret = process_request(strm, req, res, close_connection, error);
  13578. }
  13579. if (!ret) { return false; }
  13580. {
  13581. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13582. // for this to be safe.
  13583. // This is safe to call because handle_request is only called by send_
  13584. // which locks the request mutex during the process. It would be a bug
  13585. // to call it from a different thread since it's a thread-safety issue
  13586. // to do these things to the socket if another thread is using the socket.
  13587. std::lock_guard<std::mutex> guard(socket_mutex_);
  13588. // Also when the request asked for it (e.g. a body that was never sent),
  13589. // so that a redirect or an auth retry below does not reuse the socket.
  13590. if (socket_should_be_closed_when_request_is_done_ ||
  13591. detail::has_header_token(res.headers, "Connection", "close") ||
  13592. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13593. disconnect(/*gracefully=*/true);
  13594. }
  13595. }
  13596. if (300 < res.status && res.status < 400 && follow_location_) {
  13597. req = std::move(req_save);
  13598. // The client that followed the redirect has answered any challenge it
  13599. // could. Retrying below would sign another host's challenge and send it
  13600. // here.
  13601. return redirect(req, res, error);
  13602. }
  13603. #ifdef CPPHTTPLIB_SSL_ENABLED
  13604. if ((res.status == StatusCode::Unauthorized_401 ||
  13605. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13606. req.authorization_count_ < 5) {
  13607. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13608. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13609. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13610. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13611. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13612. return ret;
  13613. }
  13614. const auto &username =
  13615. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13616. const auto &password =
  13617. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13618. if (!username.empty() && !password.empty()) {
  13619. std::map<std::string, std::string> auth;
  13620. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13621. Request new_req = req;
  13622. new_req.authorization_count_ += 1;
  13623. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13624. : "Authorization");
  13625. new_req.headers.insert(detail::make_digest_authentication_header(
  13626. req, auth, new_req.authorization_count_, detail::random_string(10),
  13627. username, password, is_proxy));
  13628. Response new_res;
  13629. ret = send(new_req, new_res, error);
  13630. if (ret) { res = std::move(new_res); }
  13631. }
  13632. }
  13633. }
  13634. #endif
  13635. return ret;
  13636. }
  13637. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13638. if (req.redirect_count_ == 0) {
  13639. error = Error::ExceedRedirectCount;
  13640. output_error_log(error, &req);
  13641. return false;
  13642. }
  13643. auto location = res.get_header_value("location");
  13644. if (location.empty()) { return false; }
  13645. detail::UrlComponents uc;
  13646. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13647. uc)) {
  13648. return false;
  13649. }
  13650. // Only follow http/https redirects
  13651. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13652. return false;
  13653. }
  13654. auto scheme = is_ssl() ? "https" : "http";
  13655. auto next_scheme = std::move(uc.scheme);
  13656. auto next_host = std::move(uc.host);
  13657. auto port_str = std::move(uc.port);
  13658. auto next_path = std::move(uc.path);
  13659. auto next_query = std::move(uc.query);
  13660. auto next_port = port_;
  13661. if (!port_str.empty()) {
  13662. if (!detail::parse_port(port_str, next_port)) { return false; }
  13663. } else if (!next_scheme.empty()) {
  13664. next_port = next_scheme == "https" ? 443 : 80;
  13665. }
  13666. if (next_scheme.empty()) { next_scheme = scheme; }
  13667. if (next_host.empty()) { next_host = host_; }
  13668. if (next_path.empty()) { next_path = "/"; }
  13669. auto path = std::move(next_path) + next_query;
  13670. // Same host redirect - use current client
  13671. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13672. return detail::redirect(*this, req, res, path, location, error);
  13673. }
  13674. // Cross-host/scheme redirect - create new client with robust setup
  13675. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13676. path, location, error);
  13677. }
  13678. // New method for robust redirect client creation
  13679. inline bool ClientImpl::create_redirect_client(
  13680. const std::string &scheme, const std::string &host, int port, Request &req,
  13681. Response &res, const std::string &path, const std::string &location,
  13682. Error &error) {
  13683. // Determine if we need SSL
  13684. auto need_ssl = (scheme == "https");
  13685. // Clean up request headers that are host/client specific
  13686. // Remove headers that should not be carried over to new host
  13687. auto headers_to_remove = std::vector<std::string>{
  13688. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13689. for (const auto &header_name : headers_to_remove) {
  13690. auto it = req.headers.find(header_name);
  13691. while (it != req.headers.end()) {
  13692. it = req.headers.erase(it);
  13693. it = req.headers.find(header_name);
  13694. }
  13695. }
  13696. // Create appropriate client type and handle redirect
  13697. if (need_ssl) {
  13698. #ifdef CPPHTTPLIB_SSL_ENABLED
  13699. // Create SSL client for HTTPS redirect
  13700. SSLClient redirect_client(host, port);
  13701. // Setup basic client configuration first
  13702. setup_redirect_client(redirect_client);
  13703. redirect_client.enable_server_certificate_verification(
  13704. server_certificate_verification_);
  13705. redirect_client.enable_server_hostname_verification(
  13706. server_hostname_verification_);
  13707. redirect_client.system_ca_mode_ = system_ca_mode_;
  13708. // Transfer CA certificate to redirect client
  13709. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13710. ca_cert_pem_.size());
  13711. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13712. if (is_ssl()) {
  13713. auto &self = static_cast<SSLClient &>(*this);
  13714. // A store given to set_ca_cert_store() lives only in this client's
  13715. // context, so pass on the CA certificates the context holds.
  13716. if (self.ca_cert_store_set_) {
  13717. auto pem = detail::ca_certs_to_pem(self.ctx_);
  13718. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13719. }
  13720. redirect_client.set_session_verifier(self.session_verifier_);
  13721. if (self.server_certificate_verifier_) {
  13722. redirect_client.set_server_certificate_verifier(
  13723. self.server_certificate_verifier_);
  13724. }
  13725. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13726. redirect_client.enable_windows_cert_verification_ =
  13727. self.enable_windows_cert_verification_;
  13728. #endif
  13729. }
  13730. // Client certificates are set through constructor for SSLClient
  13731. // NOTE: SSLClient constructor already takes client_cert_path and
  13732. // client_key_path so we need to create it properly if client certs are
  13733. // needed
  13734. // Execute the redirect
  13735. return detail::redirect(redirect_client, req, res, path, location, error);
  13736. #else
  13737. // SSL not supported - set appropriate error
  13738. error = Error::SSLConnection;
  13739. output_error_log(error, &req);
  13740. return false;
  13741. #endif
  13742. } else {
  13743. // HTTP redirect
  13744. ClientImpl redirect_client(host, port);
  13745. // Setup client with robust configuration
  13746. setup_redirect_client(redirect_client);
  13747. // Execute the redirect
  13748. return detail::redirect(redirect_client, req, res, path, location, error);
  13749. }
  13750. }
  13751. // New method for robust client setup (based on basic_manual_redirect.cpp
  13752. // logic)
  13753. template <typename ClientType>
  13754. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13755. // Copy basic settings first
  13756. client.set_connection_timeout(connection_timeout_sec_,
  13757. connection_timeout_usec_);
  13758. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13759. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13760. client.set_max_timeout(max_timeout_msec_);
  13761. if (has_payload_max_length_) {
  13762. client.set_payload_max_length(payload_max_length_);
  13763. }
  13764. client.set_keep_alive(keep_alive_);
  13765. client.set_follow_location(
  13766. true); // Enable redirects to handle multi-step redirects
  13767. client.set_path_encode(path_encode_);
  13768. client.set_compress(compress_);
  13769. client.set_decompress(decompress_);
  13770. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13771. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13772. // 15.4, credentials must not be forwarded when redirecting to a different
  13773. // host. This function is only called for cross-host redirects; same-host
  13774. // redirects are handled directly in ClientImpl::redirect().
  13775. // Copy the proxy configuration unconditionally; the per-target bypass is
  13776. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13777. // still use the proxy.
  13778. client.no_proxy_entries_ = no_proxy_entries_;
  13779. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13780. client.set_proxy(proxy_host_, proxy_port_);
  13781. if (!proxy_basic_auth_username_.empty() ||
  13782. !proxy_basic_auth_password_.empty()) {
  13783. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13784. proxy_basic_auth_password_);
  13785. }
  13786. if (!proxy_bearer_token_auth_token_.empty()) {
  13787. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13788. }
  13789. #ifdef CPPHTTPLIB_SSL_ENABLED
  13790. if (!proxy_digest_auth_username_.empty()) {
  13791. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13792. proxy_digest_auth_password_);
  13793. }
  13794. #endif
  13795. }
  13796. // Copy network and socket settings
  13797. client.addr_map_ = addr_map_;
  13798. client.set_address_family(address_family_);
  13799. client.set_tcp_nodelay(tcp_nodelay_);
  13800. client.set_ipv6_v6only(ipv6_v6only_);
  13801. if (socket_options_) { client.set_socket_options(socket_options_); }
  13802. if (!interface_.empty()) { client.set_interface(interface_); }
  13803. // Copy logging and headers
  13804. if (logger_) { client.set_logger(logger_); }
  13805. if (error_logger_) { client.set_error_logger(error_logger_); }
  13806. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13807. // Each new client should generate its own headers based on its target host
  13808. }
  13809. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13810. const Request &req,
  13811. Error &error) const {
  13812. auto is_shutting_down = []() { return false; };
  13813. if (req.is_chunked_content_provider_) {
  13814. auto compressor = compress_ ? detail::create_compressor().first
  13815. : std::unique_ptr<detail::compressor>();
  13816. if (!compressor) {
  13817. compressor = detail::make_unique<detail::nocompressor>();
  13818. }
  13819. return detail::write_content_chunked(strm, req.content_provider_,
  13820. is_shutting_down, *compressor, error);
  13821. } else {
  13822. return detail::write_content_with_progress(
  13823. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13824. req.upload_progress, error);
  13825. }
  13826. }
  13827. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13828. bool close_connection, Error &error,
  13829. bool skip_body, bool &rejected_locally) {
  13830. rejected_locally = false;
  13831. // Prepare additional headers
  13832. if (close_connection) {
  13833. if (!req.has_header("Connection")) {
  13834. req.set_header("Connection", "close");
  13835. }
  13836. }
  13837. std::string ct_for_defaults;
  13838. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13839. ct_for_defaults = "text/plain";
  13840. }
  13841. prepare_default_headers(req, false, ct_for_defaults);
  13842. if (req.body.empty()) {
  13843. if (req.content_provider_) {
  13844. if (!req.is_chunked_content_provider_) {
  13845. if (!req.has_header("Content-Length")) {
  13846. auto length = std::to_string(req.content_length_);
  13847. req.set_header("Content-Length", length);
  13848. }
  13849. }
  13850. } else {
  13851. if (req.method == "POST" || req.method == "PUT" ||
  13852. req.method == "PATCH") {
  13853. req.set_header("Content-Length", "0");
  13854. }
  13855. }
  13856. }
  13857. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13858. // it opens is read by the origin. Each credential goes only to its own hop.
  13859. auto is_connect = req.method == "CONNECT";
  13860. if (!is_connect && !req.has_header("Authorization")) {
  13861. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13862. req.headers.insert(make_basic_authentication_header(
  13863. basic_auth_username_, basic_auth_password_, false));
  13864. } else if (!bearer_token_auth_token_.empty()) {
  13865. req.headers.insert(make_bearer_token_authentication_header(
  13866. bearer_token_auth_token_, false));
  13867. }
  13868. }
  13869. // Proxy-Authorization is only sent when the proxy reads this message —
  13870. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13871. // would leak proxy credentials to the destination server.
  13872. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13873. if ((!proxy_basic_auth_username_.empty() ||
  13874. !proxy_basic_auth_password_.empty()) &&
  13875. !req.has_header("Proxy-Authorization")) {
  13876. req.headers.insert(make_basic_authentication_header(
  13877. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13878. }
  13879. if (!proxy_bearer_token_auth_token_.empty() &&
  13880. !req.has_header("Proxy-Authorization")) {
  13881. req.headers.insert(make_bearer_token_authentication_header(
  13882. proxy_bearer_token_auth_token_, true));
  13883. }
  13884. }
  13885. // Request line and headers
  13886. {
  13887. detail::BufferStream bstrm;
  13888. // Extract the query from req.path. The encoding itself is delegated to
  13889. // `encode_request_target`; the raw query is still needed here to decide
  13890. // between populating `req.params` from it and falling back to building a
  13891. // query out of caller-supplied `req.params`.
  13892. // The fragment, which is not sent, is not part of the query.
  13893. auto target = req.path.substr(0, req.path.find('#'));
  13894. auto query_pos = target.find('?');
  13895. auto query_part = query_pos == std::string::npos
  13896. ? std::string()
  13897. : target.substr(query_pos + 1);
  13898. auto path_with_query =
  13899. detail::encode_request_target(req.path, path_encode_);
  13900. if (!query_part.empty()) {
  13901. // The query already came in through `req.path`; still populate
  13902. // `req.params` for handlers/users who read them.
  13903. detail::parse_query_text(query_part, req.params);
  13904. } else if (!req.params.empty()) {
  13905. // No query in `req.path`; build one from `req.params` so existing
  13906. // callers that pass `Params` separately continue to work.
  13907. path_with_query = append_query_params(path_with_query, req.params);
  13908. }
  13909. // Write request line and headers
  13910. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13911. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13912. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13913. // fail the request cleanly instead of emitting a request-line-less,
  13914. // header-injecting request.
  13915. error = Error::Write;
  13916. rejected_locally = true;
  13917. output_error_log(error, &req);
  13918. return false;
  13919. }
  13920. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13921. error)) {
  13922. rejected_locally = true;
  13923. output_error_log(error, &req);
  13924. return false;
  13925. }
  13926. // Flush buffer
  13927. auto &data = bstrm.get_buffer();
  13928. if (!detail::write_data(strm, data.data(), data.size())) {
  13929. error = Error::Write;
  13930. output_error_log(error, &req);
  13931. return false;
  13932. }
  13933. }
  13934. // After sending request line and headers, wait briefly for an early server
  13935. // response (e.g. 4xx) and avoid sending a potentially large request body
  13936. // unnecessarily. This workaround is only enabled on Windows because Unix
  13937. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13938. // buffering can accept large writes even when the peer already responded.
  13939. // Check the stream first (which covers SSL via `is_readable()`), then
  13940. // fall back to select on the socket. Only perform the wait for very large
  13941. // request bodies to avoid interfering with normal small requests and
  13942. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13943. // response. Skip this check when using Expect: 100-continue, as the protocol
  13944. // handles early responses properly.
  13945. #if defined(_WIN32)
  13946. if (!skip_body &&
  13947. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13948. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13949. auto start = std::chrono::high_resolution_clock::now();
  13950. for (;;) {
  13951. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13952. // from SSL internals. If the underlying socket is readable, assume an
  13953. // early response may be present.
  13954. auto sock = strm.socket();
  13955. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13956. return false;
  13957. }
  13958. // Fallback to stream-level check for non-socket streams or when the
  13959. // socket isn't reporting readable. Avoid using `is_readable()` for
  13960. // SSL, since `SSL_pending()` may report buffered records that do not
  13961. // indicate a complete application-level response yet.
  13962. if (!is_ssl() && strm.is_readable()) { return false; }
  13963. auto now = std::chrono::high_resolution_clock::now();
  13964. auto elapsed =
  13965. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13966. .count();
  13967. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13968. break;
  13969. }
  13970. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13971. }
  13972. }
  13973. #endif
  13974. // Body
  13975. if (skip_body) { return true; }
  13976. return write_request_body(strm, req, error);
  13977. }
  13978. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13979. Error &error) {
  13980. if (req.body.empty()) {
  13981. return write_content_with_provider(strm, req, error);
  13982. }
  13983. if (req.upload_progress) {
  13984. auto body_size = req.body.size();
  13985. size_t written = 0;
  13986. auto data = req.body.data();
  13987. while (written < body_size) {
  13988. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13989. if (!detail::write_data(strm, data + written, to_write)) {
  13990. error = Error::Write;
  13991. output_error_log(error, &req);
  13992. return false;
  13993. }
  13994. written += to_write;
  13995. if (!req.upload_progress(written, body_size)) {
  13996. error = Error::Canceled;
  13997. output_error_log(error, &req);
  13998. return false;
  13999. }
  14000. }
  14001. } else {
  14002. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14003. error = Error::Write;
  14004. output_error_log(error, &req);
  14005. return false;
  14006. }
  14007. }
  14008. return true;
  14009. }
  14010. inline std::unique_ptr<Response>
  14011. ClientImpl::send_with_content_provider_and_receiver(
  14012. Request &req, const char *body, size_t content_length,
  14013. ContentProvider content_provider,
  14014. ContentProviderWithoutLength content_provider_without_length,
  14015. const std::string &content_type, ContentReceiver content_receiver,
  14016. Error &error) {
  14017. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14018. auto enc = compress_
  14019. ? detail::create_compressor()
  14020. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14021. nullptr, nullptr);
  14022. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14023. if (enc.first && !content_provider_without_length) {
  14024. auto &compressor = enc.first;
  14025. if (content_provider) {
  14026. auto ok = true;
  14027. auto finished = false;
  14028. size_t offset = 0;
  14029. DataSink data_sink;
  14030. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14031. if (ok) {
  14032. auto last = offset + data_len == content_length;
  14033. auto ret = compressor->compress(
  14034. data, data_len, last,
  14035. [&](const char *compressed_data, size_t compressed_data_len) {
  14036. req.body.append(compressed_data, compressed_data_len);
  14037. return true;
  14038. });
  14039. if (ret) {
  14040. offset += data_len;
  14041. } else {
  14042. ok = false;
  14043. }
  14044. }
  14045. return ok;
  14046. };
  14047. // As in detail::write_content_with_progress(): the body is framed by
  14048. // content_length, so a provider that finishes early has truncated it.
  14049. // Stop and report that instead of calling the provider forever.
  14050. data_sink.done = [&]() { finished = true; };
  14051. while (ok && !finished && offset < content_length) {
  14052. if (!content_provider(offset, content_length - offset, data_sink)) {
  14053. error = Error::Canceled;
  14054. output_error_log(error, &req);
  14055. return nullptr;
  14056. }
  14057. }
  14058. // A short body here means either the provider stopped early or the
  14059. // compressor gave up. The branch below reports a failing compressor as
  14060. // Error::Compression, so keep the two distinguishable.
  14061. if (offset < content_length) {
  14062. error = ok ? Error::Write : Error::Compression;
  14063. output_error_log(error, &req);
  14064. return nullptr;
  14065. }
  14066. } else {
  14067. if (!compressor->compress(body, content_length, true,
  14068. [&](const char *data, size_t data_len) {
  14069. req.body.append(data, data_len);
  14070. return true;
  14071. })) {
  14072. error = Error::Compression;
  14073. output_error_log(error, &req);
  14074. return nullptr;
  14075. }
  14076. }
  14077. } else {
  14078. if (content_provider) {
  14079. req.content_length_ = content_length;
  14080. req.content_provider_ = std::move(content_provider);
  14081. req.is_chunked_content_provider_ = false;
  14082. } else if (content_provider_without_length) {
  14083. req.content_length_ = 0;
  14084. req.content_provider_ = detail::ContentProviderAdapter(
  14085. std::move(content_provider_without_length));
  14086. req.is_chunked_content_provider_ = true;
  14087. req.set_header("Transfer-Encoding", "chunked");
  14088. } else {
  14089. req.body.assign(body, content_length);
  14090. }
  14091. }
  14092. if (content_receiver) {
  14093. req.content_receiver =
  14094. [content_receiver](const char *data, size_t data_length,
  14095. size_t /*offset*/, size_t /*total_length*/) {
  14096. return content_receiver(data, data_length);
  14097. };
  14098. }
  14099. auto res = detail::make_unique<Response>();
  14100. return send(req, *res, error) ? std::move(res) : nullptr;
  14101. }
  14102. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14103. const std::string &method, const std::string &path, const Headers &headers,
  14104. const char *body, size_t content_length, ContentProvider content_provider,
  14105. ContentProviderWithoutLength content_provider_without_length,
  14106. const std::string &content_type, ContentReceiver content_receiver,
  14107. UploadProgress progress) {
  14108. Request req;
  14109. req.method = method;
  14110. req.headers = headers;
  14111. req.path = path;
  14112. req.upload_progress = std::move(progress);
  14113. if (max_timeout_msec_ > 0) {
  14114. req.start_time_ = std::chrono::steady_clock::now();
  14115. }
  14116. auto error = Error::Success;
  14117. auto res = send_with_content_provider_and_receiver(
  14118. req, body, content_length, std::move(content_provider),
  14119. std::move(content_provider_without_length), content_type,
  14120. std::move(content_receiver), error);
  14121. #ifdef CPPHTTPLIB_SSL_ENABLED
  14122. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14123. last_backend_error_};
  14124. #else
  14125. return Result{std::move(res), error, std::move(req.headers)};
  14126. #endif
  14127. }
  14128. inline void ClientImpl::output_log(const Request &req,
  14129. const Response &res) const {
  14130. if (logger_) {
  14131. std::lock_guard<std::mutex> guard(logger_mutex_);
  14132. logger_(req, res);
  14133. }
  14134. }
  14135. inline void ClientImpl::output_error_log(const Error &err,
  14136. const Request *req) const {
  14137. if (error_logger_) {
  14138. std::lock_guard<std::mutex> guard(logger_mutex_);
  14139. error_logger_(err, req);
  14140. }
  14141. }
  14142. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14143. Response &res, bool close_connection,
  14144. Error &error) {
  14145. // Auto-add Expect: 100-continue for large bodies
  14146. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14147. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14148. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14149. req.set_header("Expect", "100-continue");
  14150. }
  14151. }
  14152. // Check for Expect: 100-continue
  14153. auto expect_100_continue =
  14154. detail::has_header_token(req.headers, "Expect", "100-continue");
  14155. // Send request (skip body if using Expect: 100-continue)
  14156. auto rejected_locally = false;
  14157. auto write_request_success =
  14158. write_request(strm, req, close_connection, error, expect_100_continue,
  14159. rejected_locally);
  14160. // A failed write normally still reads the response below, since the server
  14161. // may have answered early (e.g. 413/414) and closed while the body was being
  14162. // sent. A request rejected before any byte reached the socket gets no such
  14163. // response, and waiting for one would block until the read timeout.
  14164. if (rejected_locally) { return false; }
  14165. #ifdef CPPHTTPLIB_SSL_ENABLED
  14166. if (is_ssl() && !expect_100_continue) {
  14167. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14168. if (!is_proxy_enabled) {
  14169. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14170. error = Error::SSLPeerCouldBeClosed_;
  14171. output_error_log(error, &req);
  14172. return false;
  14173. }
  14174. }
  14175. }
  14176. #endif
  14177. // Handle Expect: 100-continue.
  14178. //
  14179. // Wait for an interim/early response by attempting to read the status line
  14180. // under a short timeout, instead of trusting raw socket readability. Over
  14181. // TLS, post-handshake records (e.g. session tickets) make the socket
  14182. // readable without any HTTP response being available; relying on
  14183. // `select_read` there caused the body to be withheld forever and the
  14184. // request to fail with `Read` (#2458). If no status line arrives within the
  14185. // timeout, send the body anyway (matching curl's behavior).
  14186. auto status_line_read = false;
  14187. if (expect_100_continue && write_request_success) {
  14188. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14189. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14190. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14191. strm.set_read_timeout(sec, usec);
  14192. status_line_read = read_response_line(strm, req, res, false);
  14193. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14194. }
  14195. if (!status_line_read) {
  14196. // No interim response within the timeout: send the body and handle the
  14197. // response as usual.
  14198. if (!write_request_body(strm, req, error)) { return false; }
  14199. expect_100_continue = false; // Switch to normal response handling
  14200. }
  14201. }
  14202. // Receive response and headers
  14203. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14204. if ((!status_line_read &&
  14205. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14206. !detail::read_headers(strm, res.headers)) {
  14207. if (write_request_success) { error = Error::Read; }
  14208. output_error_log(error, &req);
  14209. return false;
  14210. }
  14211. if (!write_request_success) { return false; }
  14212. // Handle Expect: 100-continue response
  14213. if (expect_100_continue) {
  14214. if (res.status == StatusCode::Continue_100) {
  14215. // Server accepted, send the body
  14216. if (!write_request_body(strm, req, error)) { return false; }
  14217. // Read the actual response
  14218. res.headers.clear();
  14219. res.body.clear();
  14220. if (!read_response_line(strm, req, res) ||
  14221. !detail::read_headers(strm, res.headers)) {
  14222. error = Error::Read;
  14223. output_error_log(error, &req);
  14224. return false;
  14225. }
  14226. } else {
  14227. // A final response came first, so the body this request declared was
  14228. // never sent, and the server may still be waiting for it. The
  14229. // connection cannot carry another request.
  14230. std::lock_guard<std::mutex> guard(socket_mutex_);
  14231. socket_should_be_closed_when_request_is_done_ = true;
  14232. }
  14233. }
  14234. // Body
  14235. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14236. req.method != "CONNECT") {
  14237. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14238. // whose final transfer coding is not chunked is not ambiguous: its body
  14239. // runs until the server closes the connection, so it is not rejected.
  14240. // HEAD/204 are excluded above and a 304 carries no body.
  14241. if (res.status != StatusCode::NotModified_304) {
  14242. if (detail::has_conflicting_content_length(res.headers)) {
  14243. error = Error::Read;
  14244. output_error_log(error, &req);
  14245. return false;
  14246. }
  14247. if (detail::has_faulty_transfer_encoding(res)) {
  14248. std::lock_guard<std::mutex> guard(socket_mutex_);
  14249. socket_should_be_closed_when_request_is_done_ = true;
  14250. }
  14251. }
  14252. auto redirect = 300 < res.status && res.status < 400 &&
  14253. res.status != StatusCode::NotModified_304 &&
  14254. follow_location_;
  14255. if (req.response_handler && !redirect) {
  14256. if (!req.response_handler(res)) {
  14257. error = Error::Canceled;
  14258. output_error_log(error, &req);
  14259. return false;
  14260. }
  14261. }
  14262. auto out =
  14263. req.content_receiver
  14264. ? static_cast<ContentReceiverWithProgress>(
  14265. [&](const char *buf, size_t n, size_t off, size_t len) {
  14266. if (redirect) { return true; }
  14267. auto ret = req.content_receiver(buf, n, off, len);
  14268. if (!ret) {
  14269. error = Error::Canceled;
  14270. output_error_log(error, &req);
  14271. }
  14272. return ret;
  14273. })
  14274. : static_cast<ContentReceiverWithProgress>(
  14275. [&](const char *buf, size_t n, size_t /*off*/,
  14276. size_t /*len*/) {
  14277. assert(res.body.size() + n <= res.body.max_size());
  14278. if (payload_max_length_ > 0 &&
  14279. (res.body.size() >= payload_max_length_ ||
  14280. n > payload_max_length_ - res.body.size())) {
  14281. return false;
  14282. }
  14283. res.body.append(buf, n);
  14284. return true;
  14285. });
  14286. auto progress = [&](size_t current, size_t total) {
  14287. if (!req.download_progress || redirect) { return true; }
  14288. auto ret = req.download_progress(current, total);
  14289. if (!ret) {
  14290. error = Error::Canceled;
  14291. output_error_log(error, &req);
  14292. }
  14293. return ret;
  14294. };
  14295. if (res.has_header("Content-Length")) {
  14296. if (!req.content_receiver) {
  14297. auto len = res.get_header_value_u64("Content-Length");
  14298. if (len > res.body.max_size()) {
  14299. error = Error::Read;
  14300. output_error_log(error, &req);
  14301. return false;
  14302. }
  14303. // Content-Length is only the server's claim, so reserve no more than
  14304. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14305. // body has arrived. A longer body grows as it is read.
  14306. auto reserve_len =
  14307. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14308. if (payload_max_length_ > 0) {
  14309. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14310. }
  14311. res.body.reserve(reserve_len);
  14312. }
  14313. }
  14314. if (res.status != StatusCode::NotModified_304) {
  14315. auto content_status = 0;
  14316. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14317. ? (std::numeric_limits<size_t>::max)()
  14318. : payload_max_length_;
  14319. if (!detail::read_content(strm, res, max_length, content_status,
  14320. std::move(progress), std::move(out),
  14321. decompress_)) {
  14322. if (error != Error::Canceled) {
  14323. // Tell the caller apart from a plain read failure when the body could
  14324. // not be decoded because of its Content-Encoding.
  14325. switch (content_status) {
  14326. case StatusCode::UnsupportedMediaType_415:
  14327. error = Error::UnsupportedContentEncoding;
  14328. break;
  14329. case StatusCode::InternalServerError_500:
  14330. error = Error::Compression;
  14331. break;
  14332. default: error = Error::Read; break;
  14333. }
  14334. }
  14335. output_error_log(error, &req);
  14336. return false;
  14337. }
  14338. }
  14339. }
  14340. // Log
  14341. output_log(req, res);
  14342. return true;
  14343. }
  14344. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14345. const std::string &boundary, const UploadFormDataItems &items,
  14346. const FormDataProviderItems &provider_items) const {
  14347. size_t cur_item = 0;
  14348. size_t cur_start = 0;
  14349. // cur_item and cur_start are copied to within the std::function and
  14350. // maintain state between successive calls
  14351. return [&, cur_item, cur_start](size_t offset,
  14352. DataSink &sink) mutable -> bool {
  14353. if (!offset && !items.empty()) {
  14354. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14355. return true;
  14356. } else if (cur_item < provider_items.size()) {
  14357. if (!cur_start) {
  14358. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14359. provider_items[cur_item], boundary);
  14360. offset += begin.size();
  14361. cur_start = offset;
  14362. sink.os << begin;
  14363. }
  14364. DataSink cur_sink;
  14365. auto has_data = true;
  14366. cur_sink.write = sink.write;
  14367. // Forward is_writable so a provider item asking whether it may keep
  14368. // going gets the outer sink's answer rather than the default `true`.
  14369. cur_sink.is_writable = sink.is_writable;
  14370. cur_sink.done = [&]() { has_data = false; };
  14371. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14372. return false;
  14373. }
  14374. if (!has_data) {
  14375. sink.os << detail::serialize_multipart_formdata_item_end();
  14376. cur_item++;
  14377. cur_start = 0;
  14378. }
  14379. return true;
  14380. } else {
  14381. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14382. sink.done();
  14383. return true;
  14384. }
  14385. };
  14386. }
  14387. inline bool ClientImpl::process_socket(
  14388. const Socket &socket,
  14389. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14390. std::function<bool(Stream &strm)> callback) {
  14391. return detail::process_client_socket(
  14392. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14393. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14394. }
  14395. inline bool ClientImpl::is_ssl() const { return false; }
  14396. inline Result ClientImpl::Get(const std::string &path,
  14397. DownloadProgress progress) {
  14398. return Get(path, Headers(), std::move(progress));
  14399. }
  14400. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14401. DownloadProgress progress) {
  14402. return Get(path, params, Headers(), std::move(progress));
  14403. }
  14404. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14405. const Headers &headers,
  14406. DownloadProgress progress) {
  14407. if (params.empty()) { return Get(path, headers); }
  14408. std::string path_with_query = append_query_params(path, params);
  14409. return Get(path_with_query, headers, std::move(progress));
  14410. }
  14411. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14412. DownloadProgress progress) {
  14413. Request req;
  14414. req.method = "GET";
  14415. req.path = path;
  14416. req.headers = headers;
  14417. req.download_progress = std::move(progress);
  14418. if (max_timeout_msec_ > 0) {
  14419. req.start_time_ = std::chrono::steady_clock::now();
  14420. }
  14421. return send_(std::move(req));
  14422. }
  14423. inline Result ClientImpl::Get(const std::string &path,
  14424. ContentReceiver content_receiver,
  14425. DownloadProgress progress) {
  14426. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14427. std::move(progress));
  14428. }
  14429. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14430. ContentReceiver content_receiver,
  14431. DownloadProgress progress) {
  14432. return Get(path, headers, nullptr, std::move(content_receiver),
  14433. std::move(progress));
  14434. }
  14435. inline Result ClientImpl::Get(const std::string &path,
  14436. ResponseHandler response_handler,
  14437. ContentReceiver content_receiver,
  14438. DownloadProgress progress) {
  14439. return Get(path, Headers(), std::move(response_handler),
  14440. std::move(content_receiver), std::move(progress));
  14441. }
  14442. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14443. ResponseHandler response_handler,
  14444. ContentReceiver content_receiver,
  14445. DownloadProgress progress) {
  14446. Request req;
  14447. req.method = "GET";
  14448. req.path = path;
  14449. req.headers = headers;
  14450. req.response_handler = std::move(response_handler);
  14451. req.content_receiver =
  14452. [content_receiver](const char *data, size_t data_length,
  14453. size_t /*offset*/, size_t /*total_length*/) {
  14454. return content_receiver(data, data_length);
  14455. };
  14456. req.download_progress = std::move(progress);
  14457. if (max_timeout_msec_ > 0) {
  14458. req.start_time_ = std::chrono::steady_clock::now();
  14459. }
  14460. return send_(std::move(req));
  14461. }
  14462. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14463. const Headers &headers,
  14464. ContentReceiver content_receiver,
  14465. DownloadProgress progress) {
  14466. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14467. std::move(progress));
  14468. }
  14469. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14470. const Headers &headers,
  14471. ResponseHandler response_handler,
  14472. ContentReceiver content_receiver,
  14473. DownloadProgress progress) {
  14474. if (params.empty()) {
  14475. return Get(path, headers, std::move(response_handler),
  14476. std::move(content_receiver), std::move(progress));
  14477. }
  14478. std::string path_with_query = append_query_params(path, params);
  14479. return Get(path_with_query, headers, std::move(response_handler),
  14480. std::move(content_receiver), std::move(progress));
  14481. }
  14482. inline Result ClientImpl::Head(const std::string &path) {
  14483. return Head(path, Headers());
  14484. }
  14485. inline Result ClientImpl::Head(const std::string &path,
  14486. const Headers &headers) {
  14487. Request req;
  14488. req.method = "HEAD";
  14489. req.headers = headers;
  14490. req.path = path;
  14491. if (max_timeout_msec_ > 0) {
  14492. req.start_time_ = std::chrono::steady_clock::now();
  14493. }
  14494. return send_(std::move(req));
  14495. }
  14496. inline Result ClientImpl::Post(const std::string &path) {
  14497. return Post(path, std::string(), std::string());
  14498. }
  14499. inline Result ClientImpl::Post(const std::string &path,
  14500. const Headers &headers) {
  14501. return Post(path, headers, nullptr, 0, std::string());
  14502. }
  14503. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14504. size_t content_length,
  14505. const std::string &content_type,
  14506. UploadProgress progress) {
  14507. return Post(path, Headers(), body, content_length, content_type, progress);
  14508. }
  14509. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14510. const std::string &content_type,
  14511. UploadProgress progress) {
  14512. return Post(path, Headers(), body, content_type, progress);
  14513. }
  14514. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14515. return Post(path, Headers(), params);
  14516. }
  14517. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14518. ContentProvider content_provider,
  14519. const std::string &content_type,
  14520. UploadProgress progress) {
  14521. return Post(path, Headers(), content_length, std::move(content_provider),
  14522. content_type, progress);
  14523. }
  14524. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14525. ContentProvider content_provider,
  14526. const std::string &content_type,
  14527. ContentReceiver content_receiver,
  14528. UploadProgress progress) {
  14529. return Post(path, Headers(), content_length, std::move(content_provider),
  14530. content_type, std::move(content_receiver), progress);
  14531. }
  14532. inline Result ClientImpl::Post(const std::string &path,
  14533. ContentProviderWithoutLength content_provider,
  14534. const std::string &content_type,
  14535. UploadProgress progress) {
  14536. return Post(path, Headers(), std::move(content_provider), content_type,
  14537. progress);
  14538. }
  14539. inline Result ClientImpl::Post(const std::string &path,
  14540. ContentProviderWithoutLength content_provider,
  14541. const std::string &content_type,
  14542. ContentReceiver content_receiver,
  14543. UploadProgress progress) {
  14544. return Post(path, Headers(), std::move(content_provider), content_type,
  14545. std::move(content_receiver), progress);
  14546. }
  14547. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14548. const Params &params) {
  14549. auto query = detail::params_to_query_str(params);
  14550. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14551. }
  14552. inline Result ClientImpl::Post(const std::string &path,
  14553. const UploadFormDataItems &items,
  14554. UploadProgress progress) {
  14555. return Post(path, Headers(), items, progress);
  14556. }
  14557. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14558. const UploadFormDataItems &items,
  14559. UploadProgress progress) {
  14560. const auto &boundary = detail::make_multipart_data_boundary();
  14561. const auto &content_type =
  14562. detail::serialize_multipart_formdata_get_content_type(boundary);
  14563. auto content_length = detail::get_multipart_content_length(items, boundary);
  14564. return Post(path, headers, content_length,
  14565. detail::make_multipart_content_provider(items, boundary),
  14566. content_type, progress);
  14567. }
  14568. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14569. const UploadFormDataItems &items,
  14570. const std::string &boundary,
  14571. UploadProgress progress) {
  14572. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14573. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14574. }
  14575. const auto &content_type =
  14576. detail::serialize_multipart_formdata_get_content_type(boundary);
  14577. auto content_length = detail::get_multipart_content_length(items, boundary);
  14578. return Post(path, headers, content_length,
  14579. detail::make_multipart_content_provider(items, boundary),
  14580. content_type, progress);
  14581. }
  14582. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14583. const char *body, size_t content_length,
  14584. const std::string &content_type,
  14585. UploadProgress progress) {
  14586. return send_with_content_provider_and_receiver(
  14587. "POST", path, headers, body, content_length, nullptr, nullptr,
  14588. content_type, nullptr, progress);
  14589. }
  14590. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14591. const std::string &body,
  14592. const std::string &content_type,
  14593. UploadProgress progress) {
  14594. return send_with_content_provider_and_receiver(
  14595. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14596. content_type, nullptr, progress);
  14597. }
  14598. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14599. size_t content_length,
  14600. ContentProvider content_provider,
  14601. const std::string &content_type,
  14602. UploadProgress progress) {
  14603. return send_with_content_provider_and_receiver(
  14604. "POST", path, headers, nullptr, content_length,
  14605. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14606. }
  14607. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14608. size_t content_length,
  14609. ContentProvider content_provider,
  14610. const std::string &content_type,
  14611. ContentReceiver content_receiver,
  14612. DownloadProgress progress) {
  14613. return send_with_content_provider_and_receiver(
  14614. "POST", path, headers, nullptr, content_length,
  14615. std::move(content_provider), nullptr, content_type,
  14616. std::move(content_receiver), std::move(progress));
  14617. }
  14618. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14619. ContentProviderWithoutLength content_provider,
  14620. const std::string &content_type,
  14621. UploadProgress progress) {
  14622. return send_with_content_provider_and_receiver(
  14623. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14624. content_type, nullptr, progress);
  14625. }
  14626. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14627. ContentProviderWithoutLength content_provider,
  14628. const std::string &content_type,
  14629. ContentReceiver content_receiver,
  14630. DownloadProgress progress) {
  14631. return send_with_content_provider_and_receiver(
  14632. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14633. content_type, std::move(content_receiver), std::move(progress));
  14634. }
  14635. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14636. const UploadFormDataItems &items,
  14637. const FormDataProviderItems &provider_items,
  14638. UploadProgress progress) {
  14639. const auto &boundary = detail::make_multipart_data_boundary();
  14640. const auto &content_type =
  14641. detail::serialize_multipart_formdata_get_content_type(boundary);
  14642. return send_with_content_provider_and_receiver(
  14643. "POST", path, headers, nullptr, 0, nullptr,
  14644. get_multipart_content_provider(boundary, items, provider_items),
  14645. content_type, nullptr, progress);
  14646. }
  14647. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14648. const std::string &body,
  14649. const std::string &content_type,
  14650. ContentReceiver content_receiver,
  14651. DownloadProgress progress) {
  14652. Request req;
  14653. req.method = "POST";
  14654. req.path = path;
  14655. req.headers = headers;
  14656. req.body = body;
  14657. req.content_receiver =
  14658. [content_receiver](const char *data, size_t data_length,
  14659. size_t /*offset*/, size_t /*total_length*/) {
  14660. return content_receiver(data, data_length);
  14661. };
  14662. req.download_progress = std::move(progress);
  14663. if (max_timeout_msec_ > 0) {
  14664. req.start_time_ = std::chrono::steady_clock::now();
  14665. }
  14666. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14667. return send_(std::move(req));
  14668. }
  14669. inline Result ClientImpl::Put(const std::string &path) {
  14670. return Put(path, std::string(), std::string());
  14671. }
  14672. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14673. return Put(path, headers, nullptr, 0, std::string());
  14674. }
  14675. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14676. size_t content_length,
  14677. const std::string &content_type,
  14678. UploadProgress progress) {
  14679. return Put(path, Headers(), body, content_length, content_type, progress);
  14680. }
  14681. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14682. const std::string &content_type,
  14683. UploadProgress progress) {
  14684. return Put(path, Headers(), body, content_type, progress);
  14685. }
  14686. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14687. return Put(path, Headers(), params);
  14688. }
  14689. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14690. ContentProvider content_provider,
  14691. const std::string &content_type,
  14692. UploadProgress progress) {
  14693. return Put(path, Headers(), content_length, std::move(content_provider),
  14694. content_type, progress);
  14695. }
  14696. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14697. ContentProvider content_provider,
  14698. const std::string &content_type,
  14699. ContentReceiver content_receiver,
  14700. UploadProgress progress) {
  14701. return Put(path, Headers(), content_length, std::move(content_provider),
  14702. content_type, std::move(content_receiver), progress);
  14703. }
  14704. inline Result ClientImpl::Put(const std::string &path,
  14705. ContentProviderWithoutLength content_provider,
  14706. const std::string &content_type,
  14707. UploadProgress progress) {
  14708. return Put(path, Headers(), std::move(content_provider), content_type,
  14709. progress);
  14710. }
  14711. inline Result ClientImpl::Put(const std::string &path,
  14712. ContentProviderWithoutLength content_provider,
  14713. const std::string &content_type,
  14714. ContentReceiver content_receiver,
  14715. UploadProgress progress) {
  14716. return Put(path, Headers(), std::move(content_provider), content_type,
  14717. std::move(content_receiver), progress);
  14718. }
  14719. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14720. const Params &params) {
  14721. auto query = detail::params_to_query_str(params);
  14722. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14723. }
  14724. inline Result ClientImpl::Put(const std::string &path,
  14725. const UploadFormDataItems &items,
  14726. UploadProgress progress) {
  14727. return Put(path, Headers(), items, progress);
  14728. }
  14729. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14730. const UploadFormDataItems &items,
  14731. UploadProgress progress) {
  14732. const auto &boundary = detail::make_multipart_data_boundary();
  14733. const auto &content_type =
  14734. detail::serialize_multipart_formdata_get_content_type(boundary);
  14735. auto content_length = detail::get_multipart_content_length(items, boundary);
  14736. return Put(path, headers, content_length,
  14737. detail::make_multipart_content_provider(items, boundary),
  14738. content_type, progress);
  14739. }
  14740. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14741. const UploadFormDataItems &items,
  14742. const std::string &boundary,
  14743. UploadProgress progress) {
  14744. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14745. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14746. }
  14747. const auto &content_type =
  14748. detail::serialize_multipart_formdata_get_content_type(boundary);
  14749. auto content_length = detail::get_multipart_content_length(items, boundary);
  14750. return Put(path, headers, content_length,
  14751. detail::make_multipart_content_provider(items, boundary),
  14752. content_type, progress);
  14753. }
  14754. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14755. const char *body, size_t content_length,
  14756. const std::string &content_type,
  14757. UploadProgress progress) {
  14758. return send_with_content_provider_and_receiver(
  14759. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14760. content_type, nullptr, progress);
  14761. }
  14762. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14763. const std::string &body,
  14764. const std::string &content_type,
  14765. UploadProgress progress) {
  14766. return send_with_content_provider_and_receiver(
  14767. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14768. content_type, nullptr, progress);
  14769. }
  14770. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14771. size_t content_length,
  14772. ContentProvider content_provider,
  14773. const std::string &content_type,
  14774. UploadProgress progress) {
  14775. return send_with_content_provider_and_receiver(
  14776. "PUT", path, headers, nullptr, content_length,
  14777. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14778. }
  14779. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14780. size_t content_length,
  14781. ContentProvider content_provider,
  14782. const std::string &content_type,
  14783. ContentReceiver content_receiver,
  14784. UploadProgress progress) {
  14785. return send_with_content_provider_and_receiver(
  14786. "PUT", path, headers, nullptr, content_length,
  14787. std::move(content_provider), nullptr, content_type,
  14788. std::move(content_receiver), progress);
  14789. }
  14790. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14791. ContentProviderWithoutLength content_provider,
  14792. const std::string &content_type,
  14793. UploadProgress progress) {
  14794. return send_with_content_provider_and_receiver(
  14795. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14796. content_type, nullptr, progress);
  14797. }
  14798. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14799. ContentProviderWithoutLength content_provider,
  14800. const std::string &content_type,
  14801. ContentReceiver content_receiver,
  14802. UploadProgress progress) {
  14803. return send_with_content_provider_and_receiver(
  14804. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14805. content_type, std::move(content_receiver), progress);
  14806. }
  14807. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14808. const UploadFormDataItems &items,
  14809. const FormDataProviderItems &provider_items,
  14810. UploadProgress progress) {
  14811. const auto &boundary = detail::make_multipart_data_boundary();
  14812. const auto &content_type =
  14813. detail::serialize_multipart_formdata_get_content_type(boundary);
  14814. return send_with_content_provider_and_receiver(
  14815. "PUT", path, headers, nullptr, 0, nullptr,
  14816. get_multipart_content_provider(boundary, items, provider_items),
  14817. content_type, nullptr, progress);
  14818. }
  14819. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14820. const std::string &body,
  14821. const std::string &content_type,
  14822. ContentReceiver content_receiver,
  14823. DownloadProgress progress) {
  14824. Request req;
  14825. req.method = "PUT";
  14826. req.path = path;
  14827. req.headers = headers;
  14828. req.body = body;
  14829. req.content_receiver =
  14830. [content_receiver](const char *data, size_t data_length,
  14831. size_t /*offset*/, size_t /*total_length*/) {
  14832. return content_receiver(data, data_length);
  14833. };
  14834. req.download_progress = std::move(progress);
  14835. if (max_timeout_msec_ > 0) {
  14836. req.start_time_ = std::chrono::steady_clock::now();
  14837. }
  14838. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14839. return send_(std::move(req));
  14840. }
  14841. inline Result ClientImpl::Patch(const std::string &path) {
  14842. return Patch(path, std::string(), std::string());
  14843. }
  14844. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14845. UploadProgress progress) {
  14846. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14847. }
  14848. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14849. size_t content_length,
  14850. const std::string &content_type,
  14851. UploadProgress progress) {
  14852. return Patch(path, Headers(), body, content_length, content_type, progress);
  14853. }
  14854. inline Result ClientImpl::Patch(const std::string &path,
  14855. const std::string &body,
  14856. const std::string &content_type,
  14857. UploadProgress progress) {
  14858. return Patch(path, Headers(), body, content_type, progress);
  14859. }
  14860. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14861. return Patch(path, Headers(), params);
  14862. }
  14863. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14864. ContentProvider content_provider,
  14865. const std::string &content_type,
  14866. UploadProgress progress) {
  14867. return Patch(path, Headers(), content_length, std::move(content_provider),
  14868. content_type, progress);
  14869. }
  14870. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14871. ContentProvider content_provider,
  14872. const std::string &content_type,
  14873. ContentReceiver content_receiver,
  14874. UploadProgress progress) {
  14875. return Patch(path, Headers(), content_length, std::move(content_provider),
  14876. content_type, std::move(content_receiver), progress);
  14877. }
  14878. inline Result ClientImpl::Patch(const std::string &path,
  14879. ContentProviderWithoutLength content_provider,
  14880. const std::string &content_type,
  14881. UploadProgress progress) {
  14882. return Patch(path, Headers(), std::move(content_provider), content_type,
  14883. progress);
  14884. }
  14885. inline Result ClientImpl::Patch(const std::string &path,
  14886. ContentProviderWithoutLength content_provider,
  14887. const std::string &content_type,
  14888. ContentReceiver content_receiver,
  14889. UploadProgress progress) {
  14890. return Patch(path, Headers(), std::move(content_provider), content_type,
  14891. std::move(content_receiver), progress);
  14892. }
  14893. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14894. const Params &params) {
  14895. auto query = detail::params_to_query_str(params);
  14896. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14897. }
  14898. inline Result ClientImpl::Patch(const std::string &path,
  14899. const UploadFormDataItems &items,
  14900. UploadProgress progress) {
  14901. return Patch(path, Headers(), items, progress);
  14902. }
  14903. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14904. const UploadFormDataItems &items,
  14905. UploadProgress progress) {
  14906. const auto &boundary = detail::make_multipart_data_boundary();
  14907. const auto &content_type =
  14908. detail::serialize_multipart_formdata_get_content_type(boundary);
  14909. auto content_length = detail::get_multipart_content_length(items, boundary);
  14910. return Patch(path, headers, content_length,
  14911. detail::make_multipart_content_provider(items, boundary),
  14912. content_type, progress);
  14913. }
  14914. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14915. const UploadFormDataItems &items,
  14916. const std::string &boundary,
  14917. UploadProgress progress) {
  14918. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14919. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14920. }
  14921. const auto &content_type =
  14922. detail::serialize_multipart_formdata_get_content_type(boundary);
  14923. auto content_length = detail::get_multipart_content_length(items, boundary);
  14924. return Patch(path, headers, content_length,
  14925. detail::make_multipart_content_provider(items, boundary),
  14926. content_type, progress);
  14927. }
  14928. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14929. const char *body, size_t content_length,
  14930. const std::string &content_type,
  14931. UploadProgress progress) {
  14932. return send_with_content_provider_and_receiver(
  14933. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14934. content_type, nullptr, progress);
  14935. }
  14936. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14937. const std::string &body,
  14938. const std::string &content_type,
  14939. UploadProgress progress) {
  14940. return send_with_content_provider_and_receiver(
  14941. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14942. content_type, nullptr, progress);
  14943. }
  14944. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14945. size_t content_length,
  14946. ContentProvider content_provider,
  14947. const std::string &content_type,
  14948. UploadProgress progress) {
  14949. return send_with_content_provider_and_receiver(
  14950. "PATCH", path, headers, nullptr, content_length,
  14951. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14952. }
  14953. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14954. size_t content_length,
  14955. ContentProvider content_provider,
  14956. const std::string &content_type,
  14957. ContentReceiver content_receiver,
  14958. UploadProgress progress) {
  14959. return send_with_content_provider_and_receiver(
  14960. "PATCH", path, headers, nullptr, content_length,
  14961. std::move(content_provider), nullptr, content_type,
  14962. std::move(content_receiver), progress);
  14963. }
  14964. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14965. ContentProviderWithoutLength content_provider,
  14966. const std::string &content_type,
  14967. UploadProgress progress) {
  14968. return send_with_content_provider_and_receiver(
  14969. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14970. content_type, nullptr, progress);
  14971. }
  14972. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14973. ContentProviderWithoutLength content_provider,
  14974. const std::string &content_type,
  14975. ContentReceiver content_receiver,
  14976. UploadProgress progress) {
  14977. return send_with_content_provider_and_receiver(
  14978. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14979. content_type, std::move(content_receiver), progress);
  14980. }
  14981. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14982. const UploadFormDataItems &items,
  14983. const FormDataProviderItems &provider_items,
  14984. UploadProgress progress) {
  14985. const auto &boundary = detail::make_multipart_data_boundary();
  14986. const auto &content_type =
  14987. detail::serialize_multipart_formdata_get_content_type(boundary);
  14988. return send_with_content_provider_and_receiver(
  14989. "PATCH", path, headers, nullptr, 0, nullptr,
  14990. get_multipart_content_provider(boundary, items, provider_items),
  14991. content_type, nullptr, progress);
  14992. }
  14993. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14994. const std::string &body,
  14995. const std::string &content_type,
  14996. ContentReceiver content_receiver,
  14997. DownloadProgress progress) {
  14998. Request req;
  14999. req.method = "PATCH";
  15000. req.path = path;
  15001. req.headers = headers;
  15002. req.body = body;
  15003. req.content_receiver =
  15004. [content_receiver](const char *data, size_t data_length,
  15005. size_t /*offset*/, size_t /*total_length*/) {
  15006. return content_receiver(data, data_length);
  15007. };
  15008. req.download_progress = std::move(progress);
  15009. if (max_timeout_msec_ > 0) {
  15010. req.start_time_ = std::chrono::steady_clock::now();
  15011. }
  15012. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15013. return send_(std::move(req));
  15014. }
  15015. inline Result ClientImpl::Delete(const std::string &path,
  15016. DownloadProgress progress) {
  15017. return Delete(path, Headers(), std::string(), std::string(), progress);
  15018. }
  15019. inline Result ClientImpl::Delete(const std::string &path,
  15020. const Headers &headers,
  15021. DownloadProgress progress) {
  15022. return Delete(path, headers, std::string(), std::string(), progress);
  15023. }
  15024. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15025. size_t content_length,
  15026. const std::string &content_type,
  15027. DownloadProgress progress) {
  15028. return Delete(path, Headers(), body, content_length, content_type, progress);
  15029. }
  15030. inline Result ClientImpl::Delete(const std::string &path,
  15031. const std::string &body,
  15032. const std::string &content_type,
  15033. DownloadProgress progress) {
  15034. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15035. progress);
  15036. }
  15037. inline Result ClientImpl::Delete(const std::string &path,
  15038. const Headers &headers,
  15039. const std::string &body,
  15040. const std::string &content_type,
  15041. DownloadProgress progress) {
  15042. return Delete(path, headers, body.data(), body.size(), content_type,
  15043. progress);
  15044. }
  15045. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15046. DownloadProgress progress) {
  15047. return Delete(path, Headers(), params, progress);
  15048. }
  15049. inline Result ClientImpl::Delete(const std::string &path,
  15050. const Headers &headers, const Params &params,
  15051. DownloadProgress progress) {
  15052. auto query = detail::params_to_query_str(params);
  15053. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15054. progress);
  15055. }
  15056. inline Result ClientImpl::Delete(const std::string &path,
  15057. const Headers &headers, const char *body,
  15058. size_t content_length,
  15059. const std::string &content_type,
  15060. DownloadProgress progress) {
  15061. Request req;
  15062. req.method = "DELETE";
  15063. req.headers = headers;
  15064. req.path = path;
  15065. req.download_progress = std::move(progress);
  15066. if (max_timeout_msec_ > 0) {
  15067. req.start_time_ = std::chrono::steady_clock::now();
  15068. }
  15069. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15070. req.body.assign(body, content_length);
  15071. return send_(std::move(req));
  15072. }
  15073. inline Result ClientImpl::Options(const std::string &path) {
  15074. return Options(path, Headers());
  15075. }
  15076. inline Result ClientImpl::Options(const std::string &path,
  15077. const Headers &headers) {
  15078. Request req;
  15079. req.method = "OPTIONS";
  15080. req.headers = headers;
  15081. req.path = path;
  15082. if (max_timeout_msec_ > 0) {
  15083. req.start_time_ = std::chrono::steady_clock::now();
  15084. }
  15085. return send_(std::move(req));
  15086. }
  15087. inline void ClientImpl::stop() {
  15088. std::lock_guard<std::mutex> guard(socket_mutex_);
  15089. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15090. // do is to shutdown_socket, so that threads using this socket suddenly
  15091. // discover they can't read/write any more and error out. Everything else
  15092. // (closing the socket, shutting ssl down) is unsafe because these actions
  15093. // are not thread-safe.
  15094. if (socket_requests_in_flight_ > 0) {
  15095. shutdown_socket(socket_);
  15096. // Aside from that, we set a flag for the socket to be closed when we're
  15097. // done.
  15098. socket_should_be_closed_when_request_is_done_ = true;
  15099. return;
  15100. }
  15101. disconnect(/*gracefully=*/true);
  15102. }
  15103. inline std::string ClientImpl::host() const { return host_; }
  15104. inline int ClientImpl::port() const { return port_; }
  15105. inline size_t ClientImpl::is_socket_open() const {
  15106. std::lock_guard<std::mutex> guard(socket_mutex_);
  15107. return socket_.is_open();
  15108. }
  15109. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15110. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15111. connection_timeout_sec_ = sec;
  15112. connection_timeout_usec_ = usec;
  15113. }
  15114. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15115. read_timeout_sec_ = sec;
  15116. read_timeout_usec_ = usec;
  15117. }
  15118. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15119. write_timeout_sec_ = sec;
  15120. write_timeout_usec_ = usec;
  15121. }
  15122. inline void ClientImpl::set_max_timeout(time_t msec) {
  15123. max_timeout_msec_ = msec;
  15124. }
  15125. inline void ClientImpl::set_basic_auth(const std::string &username,
  15126. const std::string &password) {
  15127. basic_auth_username_ = username;
  15128. basic_auth_password_ = password;
  15129. }
  15130. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15131. bearer_token_auth_token_ = token;
  15132. }
  15133. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15134. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15135. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15136. inline void
  15137. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15138. addr_map_ = std::move(addr_map);
  15139. }
  15140. inline void ClientImpl::set_default_headers(Headers headers) {
  15141. default_headers_ = std::move(headers);
  15142. }
  15143. inline void ClientImpl::set_header_writer(
  15144. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15145. header_writer_ = writer;
  15146. }
  15147. inline void ClientImpl::set_address_family(int family) {
  15148. address_family_ = family;
  15149. }
  15150. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15151. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15152. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15153. socket_options_ = std::move(socket_options);
  15154. }
  15155. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15156. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15157. inline void ClientImpl::set_payload_max_length(size_t length) {
  15158. payload_max_length_ = length;
  15159. has_payload_max_length_ = true;
  15160. }
  15161. inline void ClientImpl::set_interface(const std::string &intf) {
  15162. interface_ = intf;
  15163. }
  15164. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15165. proxy_host_ = host;
  15166. proxy_port_ = port;
  15167. std::lock_guard<std::mutex> guard(socket_mutex_);
  15168. disconnect(/*gracefully=*/true);
  15169. }
  15170. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15171. const std::string &password) {
  15172. proxy_basic_auth_username_ = username;
  15173. proxy_basic_auth_password_ = password;
  15174. }
  15175. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15176. proxy_bearer_token_auth_token_ = token;
  15177. }
  15178. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15179. std::vector<detail::NoProxyEntry> parsed;
  15180. parsed.reserve(patterns.size());
  15181. for (const auto &p : patterns) {
  15182. auto trimmed = detail::trim_copy(p);
  15183. if (trimmed.empty()) { continue; }
  15184. detail::NoProxyEntry entry;
  15185. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  15186. parsed.push_back(std::move(entry));
  15187. }
  15188. }
  15189. no_proxy_entries_ = std::move(parsed);
  15190. std::lock_guard<std::mutex> guard(socket_mutex_);
  15191. disconnect(/*gracefully=*/true);
  15192. }
  15193. #ifdef CPPHTTPLIB_SSL_ENABLED
  15194. inline void ClientImpl::set_digest_auth(const std::string &username,
  15195. const std::string &password) {
  15196. digest_auth_username_ = username;
  15197. digest_auth_password_ = password;
  15198. }
  15199. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15200. const std::string &ca_cert_dir_path) {
  15201. ca_cert_file_path_ = ca_cert_file_path;
  15202. ca_cert_dir_path_ = ca_cert_dir_path;
  15203. }
  15204. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15205. const std::string &password) {
  15206. proxy_digest_auth_username_ = username;
  15207. proxy_digest_auth_password_ = password;
  15208. }
  15209. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15210. server_certificate_verification_ = enabled;
  15211. }
  15212. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15213. server_hostname_verification_ = enabled;
  15214. }
  15215. inline void ClientImpl::enable_system_ca(bool enabled) {
  15216. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15217. }
  15218. #endif
  15219. inline void ClientImpl::set_logger(Logger logger) {
  15220. logger_ = std::move(logger);
  15221. }
  15222. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15223. error_logger_ = std::move(error_logger);
  15224. }
  15225. /*
  15226. * SSL/TLS Common Implementation
  15227. */
  15228. inline ClientConnection::~ClientConnection() {
  15229. #ifdef CPPHTTPLIB_SSL_ENABLED
  15230. if (session) {
  15231. tls::shutdown(session, true);
  15232. tls::free_session(session);
  15233. session = nullptr;
  15234. }
  15235. #endif
  15236. if (sock != INVALID_SOCKET) {
  15237. detail::close_socket(sock);
  15238. sock = INVALID_SOCKET;
  15239. }
  15240. }
  15241. // Universal client implementation
  15242. inline Client::Client(const std::string &scheme_host_port)
  15243. : Client(scheme_host_port, std::string(), std::string()) {}
  15244. inline Client::Client(const std::string &scheme_host_port,
  15245. const std::string &client_cert_path,
  15246. const std::string &client_key_path) {
  15247. detail::UrlComponents uc;
  15248. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15249. auto &scheme = uc.scheme;
  15250. #ifdef CPPHTTPLIB_SSL_ENABLED
  15251. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15252. #else
  15253. if (!scheme.empty() && scheme != "http") {
  15254. #endif
  15255. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15256. std::string msg = "'" + scheme + "' scheme is not supported.";
  15257. throw std::invalid_argument(msg);
  15258. #endif
  15259. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15260. return;
  15261. }
  15262. auto is_ssl = scheme == "https";
  15263. auto host = std::move(uc.host);
  15264. auto port = is_ssl ? 443 : 80;
  15265. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15266. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15267. return;
  15268. }
  15269. if (is_ssl) {
  15270. #ifdef CPPHTTPLIB_SSL_ENABLED
  15271. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15272. client_key_path);
  15273. is_ssl_ = is_ssl;
  15274. #endif
  15275. } else {
  15276. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15277. client_key_path);
  15278. }
  15279. } else if (scheme_host_port.find("//") != std::string::npos) {
  15280. // A URL, but not one this client can use, such as one with userinfo
  15281. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15282. } else {
  15283. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15284. // if port param below changes.
  15285. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15286. client_cert_path, client_key_path);
  15287. }
  15288. }
  15289. inline Client::Client(const std::string &host, int port)
  15290. : Client(host, port, std::string(), std::string()) {}
  15291. inline Client::Client(const std::string &host, int port,
  15292. const std::string &client_cert_path,
  15293. const std::string &client_key_path)
  15294. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15295. client_key_path)) {}
  15296. inline Client::~Client() = default;
  15297. inline bool Client::is_valid() const {
  15298. return cli_ != nullptr && cli_->is_valid();
  15299. }
  15300. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15301. return cli_->Get(path, std::move(progress));
  15302. }
  15303. inline Result Client::Get(const std::string &path, const Headers &headers,
  15304. DownloadProgress progress) {
  15305. return cli_->Get(path, headers, std::move(progress));
  15306. }
  15307. inline Result Client::Get(const std::string &path,
  15308. ContentReceiver content_receiver,
  15309. DownloadProgress progress) {
  15310. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15311. }
  15312. inline Result Client::Get(const std::string &path, const Headers &headers,
  15313. ContentReceiver content_receiver,
  15314. DownloadProgress progress) {
  15315. return cli_->Get(path, headers, std::move(content_receiver),
  15316. std::move(progress));
  15317. }
  15318. inline Result Client::Get(const std::string &path,
  15319. ResponseHandler response_handler,
  15320. ContentReceiver content_receiver,
  15321. DownloadProgress progress) {
  15322. return cli_->Get(path, std::move(response_handler),
  15323. std::move(content_receiver), std::move(progress));
  15324. }
  15325. inline Result Client::Get(const std::string &path, const Headers &headers,
  15326. ResponseHandler response_handler,
  15327. ContentReceiver content_receiver,
  15328. DownloadProgress progress) {
  15329. return cli_->Get(path, headers, std::move(response_handler),
  15330. std::move(content_receiver), std::move(progress));
  15331. }
  15332. inline Result Client::Get(const std::string &path, const Params &params,
  15333. DownloadProgress progress) {
  15334. return cli_->Get(path, params, std::move(progress));
  15335. }
  15336. inline Result Client::Get(const std::string &path, const Params &params,
  15337. const Headers &headers, DownloadProgress progress) {
  15338. return cli_->Get(path, params, headers, std::move(progress));
  15339. }
  15340. inline Result Client::Get(const std::string &path, const Params &params,
  15341. const Headers &headers,
  15342. ContentReceiver content_receiver,
  15343. DownloadProgress progress) {
  15344. return cli_->Get(path, params, headers, std::move(content_receiver),
  15345. std::move(progress));
  15346. }
  15347. inline Result Client::Get(const std::string &path, const Params &params,
  15348. const Headers &headers,
  15349. ResponseHandler response_handler,
  15350. ContentReceiver content_receiver,
  15351. DownloadProgress progress) {
  15352. return cli_->Get(path, params, headers, std::move(response_handler),
  15353. std::move(content_receiver), std::move(progress));
  15354. }
  15355. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15356. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15357. return cli_->Head(path, headers);
  15358. }
  15359. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15360. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15361. return cli_->Post(path, headers);
  15362. }
  15363. inline Result Client::Post(const std::string &path, const char *body,
  15364. size_t content_length,
  15365. const std::string &content_type,
  15366. UploadProgress progress) {
  15367. return cli_->Post(path, body, content_length, content_type, progress);
  15368. }
  15369. inline Result Client::Post(const std::string &path, const Headers &headers,
  15370. const char *body, size_t content_length,
  15371. const std::string &content_type,
  15372. UploadProgress progress) {
  15373. return cli_->Post(path, headers, body, content_length, content_type,
  15374. progress);
  15375. }
  15376. inline Result Client::Post(const std::string &path, const std::string &body,
  15377. const std::string &content_type,
  15378. UploadProgress progress) {
  15379. return cli_->Post(path, body, content_type, progress);
  15380. }
  15381. inline Result Client::Post(const std::string &path, const Headers &headers,
  15382. const std::string &body,
  15383. const std::string &content_type,
  15384. UploadProgress progress) {
  15385. return cli_->Post(path, headers, body, content_type, progress);
  15386. }
  15387. inline Result Client::Post(const std::string &path, size_t content_length,
  15388. ContentProvider content_provider,
  15389. const std::string &content_type,
  15390. UploadProgress progress) {
  15391. return cli_->Post(path, content_length, std::move(content_provider),
  15392. content_type, progress);
  15393. }
  15394. inline Result Client::Post(const std::string &path, size_t content_length,
  15395. ContentProvider content_provider,
  15396. const std::string &content_type,
  15397. ContentReceiver content_receiver,
  15398. UploadProgress progress) {
  15399. return cli_->Post(path, content_length, std::move(content_provider),
  15400. content_type, std::move(content_receiver), progress);
  15401. }
  15402. inline Result Client::Post(const std::string &path,
  15403. ContentProviderWithoutLength content_provider,
  15404. const std::string &content_type,
  15405. UploadProgress progress) {
  15406. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15407. }
  15408. inline Result Client::Post(const std::string &path,
  15409. ContentProviderWithoutLength content_provider,
  15410. const std::string &content_type,
  15411. ContentReceiver content_receiver,
  15412. UploadProgress progress) {
  15413. return cli_->Post(path, std::move(content_provider), content_type,
  15414. std::move(content_receiver), progress);
  15415. }
  15416. inline Result Client::Post(const std::string &path, const Headers &headers,
  15417. size_t content_length,
  15418. ContentProvider content_provider,
  15419. const std::string &content_type,
  15420. UploadProgress progress) {
  15421. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15422. content_type, progress);
  15423. }
  15424. inline Result Client::Post(const std::string &path, const Headers &headers,
  15425. size_t content_length,
  15426. ContentProvider content_provider,
  15427. const std::string &content_type,
  15428. ContentReceiver content_receiver,
  15429. DownloadProgress progress) {
  15430. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15431. content_type, std::move(content_receiver), progress);
  15432. }
  15433. inline Result Client::Post(const std::string &path, const Headers &headers,
  15434. ContentProviderWithoutLength content_provider,
  15435. const std::string &content_type,
  15436. UploadProgress progress) {
  15437. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15438. progress);
  15439. }
  15440. inline Result Client::Post(const std::string &path, const Headers &headers,
  15441. ContentProviderWithoutLength content_provider,
  15442. const std::string &content_type,
  15443. ContentReceiver content_receiver,
  15444. DownloadProgress progress) {
  15445. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15446. std::move(content_receiver), progress);
  15447. }
  15448. inline Result Client::Post(const std::string &path, const Params &params) {
  15449. return cli_->Post(path, params);
  15450. }
  15451. inline Result Client::Post(const std::string &path, const Headers &headers,
  15452. const Params &params) {
  15453. return cli_->Post(path, headers, params);
  15454. }
  15455. inline Result Client::Post(const std::string &path,
  15456. const UploadFormDataItems &items,
  15457. UploadProgress progress) {
  15458. return cli_->Post(path, items, progress);
  15459. }
  15460. inline Result Client::Post(const std::string &path, const Headers &headers,
  15461. const UploadFormDataItems &items,
  15462. UploadProgress progress) {
  15463. return cli_->Post(path, headers, items, progress);
  15464. }
  15465. inline Result Client::Post(const std::string &path, const Headers &headers,
  15466. const UploadFormDataItems &items,
  15467. const std::string &boundary,
  15468. UploadProgress progress) {
  15469. return cli_->Post(path, headers, items, boundary, progress);
  15470. }
  15471. inline Result Client::Post(const std::string &path, const Headers &headers,
  15472. const UploadFormDataItems &items,
  15473. const FormDataProviderItems &provider_items,
  15474. UploadProgress progress) {
  15475. return cli_->Post(path, headers, items, provider_items, progress);
  15476. }
  15477. inline Result Client::Post(const std::string &path, const Headers &headers,
  15478. const std::string &body,
  15479. const std::string &content_type,
  15480. ContentReceiver content_receiver,
  15481. DownloadProgress progress) {
  15482. return cli_->Post(path, headers, body, content_type,
  15483. std::move(content_receiver), progress);
  15484. }
  15485. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15486. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15487. return cli_->Put(path, headers);
  15488. }
  15489. inline Result Client::Put(const std::string &path, const char *body,
  15490. size_t content_length,
  15491. const std::string &content_type,
  15492. UploadProgress progress) {
  15493. return cli_->Put(path, body, content_length, content_type, progress);
  15494. }
  15495. inline Result Client::Put(const std::string &path, const Headers &headers,
  15496. const char *body, size_t content_length,
  15497. const std::string &content_type,
  15498. UploadProgress progress) {
  15499. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15500. }
  15501. inline Result Client::Put(const std::string &path, const std::string &body,
  15502. const std::string &content_type,
  15503. UploadProgress progress) {
  15504. return cli_->Put(path, body, content_type, progress);
  15505. }
  15506. inline Result Client::Put(const std::string &path, const Headers &headers,
  15507. const std::string &body,
  15508. const std::string &content_type,
  15509. UploadProgress progress) {
  15510. return cli_->Put(path, headers, body, content_type, progress);
  15511. }
  15512. inline Result Client::Put(const std::string &path, size_t content_length,
  15513. ContentProvider content_provider,
  15514. const std::string &content_type,
  15515. UploadProgress progress) {
  15516. return cli_->Put(path, content_length, std::move(content_provider),
  15517. content_type, progress);
  15518. }
  15519. inline Result Client::Put(const std::string &path, size_t content_length,
  15520. ContentProvider content_provider,
  15521. const std::string &content_type,
  15522. ContentReceiver content_receiver,
  15523. UploadProgress progress) {
  15524. return cli_->Put(path, content_length, std::move(content_provider),
  15525. content_type, std::move(content_receiver), progress);
  15526. }
  15527. inline Result Client::Put(const std::string &path,
  15528. ContentProviderWithoutLength content_provider,
  15529. const std::string &content_type,
  15530. UploadProgress progress) {
  15531. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15532. }
  15533. inline Result Client::Put(const std::string &path,
  15534. ContentProviderWithoutLength content_provider,
  15535. const std::string &content_type,
  15536. ContentReceiver content_receiver,
  15537. UploadProgress progress) {
  15538. return cli_->Put(path, std::move(content_provider), content_type,
  15539. std::move(content_receiver), progress);
  15540. }
  15541. inline Result Client::Put(const std::string &path, const Headers &headers,
  15542. size_t content_length,
  15543. ContentProvider content_provider,
  15544. const std::string &content_type,
  15545. UploadProgress progress) {
  15546. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15547. content_type, progress);
  15548. }
  15549. inline Result Client::Put(const std::string &path, const Headers &headers,
  15550. size_t content_length,
  15551. ContentProvider content_provider,
  15552. const std::string &content_type,
  15553. ContentReceiver content_receiver,
  15554. UploadProgress progress) {
  15555. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15556. content_type, std::move(content_receiver), progress);
  15557. }
  15558. inline Result Client::Put(const std::string &path, const Headers &headers,
  15559. ContentProviderWithoutLength content_provider,
  15560. const std::string &content_type,
  15561. UploadProgress progress) {
  15562. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15563. progress);
  15564. }
  15565. inline Result Client::Put(const std::string &path, const Headers &headers,
  15566. ContentProviderWithoutLength content_provider,
  15567. const std::string &content_type,
  15568. ContentReceiver content_receiver,
  15569. UploadProgress progress) {
  15570. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15571. std::move(content_receiver), progress);
  15572. }
  15573. inline Result Client::Put(const std::string &path, const Params &params) {
  15574. return cli_->Put(path, params);
  15575. }
  15576. inline Result Client::Put(const std::string &path, const Headers &headers,
  15577. const Params &params) {
  15578. return cli_->Put(path, headers, params);
  15579. }
  15580. inline Result Client::Put(const std::string &path,
  15581. const UploadFormDataItems &items,
  15582. UploadProgress progress) {
  15583. return cli_->Put(path, items, progress);
  15584. }
  15585. inline Result Client::Put(const std::string &path, const Headers &headers,
  15586. const UploadFormDataItems &items,
  15587. UploadProgress progress) {
  15588. return cli_->Put(path, headers, items, progress);
  15589. }
  15590. inline Result Client::Put(const std::string &path, const Headers &headers,
  15591. const UploadFormDataItems &items,
  15592. const std::string &boundary,
  15593. UploadProgress progress) {
  15594. return cli_->Put(path, headers, items, boundary, progress);
  15595. }
  15596. inline Result Client::Put(const std::string &path, const Headers &headers,
  15597. const UploadFormDataItems &items,
  15598. const FormDataProviderItems &provider_items,
  15599. UploadProgress progress) {
  15600. return cli_->Put(path, headers, items, provider_items, progress);
  15601. }
  15602. inline Result Client::Put(const std::string &path, const Headers &headers,
  15603. const std::string &body,
  15604. const std::string &content_type,
  15605. ContentReceiver content_receiver,
  15606. DownloadProgress progress) {
  15607. return cli_->Put(path, headers, body, content_type, content_receiver,
  15608. progress);
  15609. }
  15610. inline Result Client::Patch(const std::string &path) {
  15611. return cli_->Patch(path);
  15612. }
  15613. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15614. return cli_->Patch(path, headers);
  15615. }
  15616. inline Result Client::Patch(const std::string &path, const char *body,
  15617. size_t content_length,
  15618. const std::string &content_type,
  15619. UploadProgress progress) {
  15620. return cli_->Patch(path, body, content_length, content_type, progress);
  15621. }
  15622. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15623. const char *body, size_t content_length,
  15624. const std::string &content_type,
  15625. UploadProgress progress) {
  15626. return cli_->Patch(path, headers, body, content_length, content_type,
  15627. progress);
  15628. }
  15629. inline Result Client::Patch(const std::string &path, const std::string &body,
  15630. const std::string &content_type,
  15631. UploadProgress progress) {
  15632. return cli_->Patch(path, body, content_type, progress);
  15633. }
  15634. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15635. const std::string &body,
  15636. const std::string &content_type,
  15637. UploadProgress progress) {
  15638. return cli_->Patch(path, headers, body, content_type, progress);
  15639. }
  15640. inline Result Client::Patch(const std::string &path, size_t content_length,
  15641. ContentProvider content_provider,
  15642. const std::string &content_type,
  15643. UploadProgress progress) {
  15644. return cli_->Patch(path, content_length, std::move(content_provider),
  15645. content_type, progress);
  15646. }
  15647. inline Result Client::Patch(const std::string &path, size_t content_length,
  15648. ContentProvider content_provider,
  15649. const std::string &content_type,
  15650. ContentReceiver content_receiver,
  15651. UploadProgress progress) {
  15652. return cli_->Patch(path, content_length, std::move(content_provider),
  15653. content_type, std::move(content_receiver), progress);
  15654. }
  15655. inline Result Client::Patch(const std::string &path,
  15656. ContentProviderWithoutLength content_provider,
  15657. const std::string &content_type,
  15658. UploadProgress progress) {
  15659. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15660. }
  15661. inline Result Client::Patch(const std::string &path,
  15662. ContentProviderWithoutLength content_provider,
  15663. const std::string &content_type,
  15664. ContentReceiver content_receiver,
  15665. UploadProgress progress) {
  15666. return cli_->Patch(path, std::move(content_provider), content_type,
  15667. std::move(content_receiver), progress);
  15668. }
  15669. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15670. size_t content_length,
  15671. ContentProvider content_provider,
  15672. const std::string &content_type,
  15673. UploadProgress progress) {
  15674. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15675. content_type, progress);
  15676. }
  15677. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15678. size_t content_length,
  15679. ContentProvider content_provider,
  15680. const std::string &content_type,
  15681. ContentReceiver content_receiver,
  15682. UploadProgress progress) {
  15683. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15684. content_type, std::move(content_receiver), progress);
  15685. }
  15686. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15687. ContentProviderWithoutLength content_provider,
  15688. const std::string &content_type,
  15689. UploadProgress progress) {
  15690. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15691. progress);
  15692. }
  15693. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15694. ContentProviderWithoutLength content_provider,
  15695. const std::string &content_type,
  15696. ContentReceiver content_receiver,
  15697. UploadProgress progress) {
  15698. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15699. std::move(content_receiver), progress);
  15700. }
  15701. inline Result Client::Patch(const std::string &path, const Params &params) {
  15702. return cli_->Patch(path, params);
  15703. }
  15704. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15705. const Params &params) {
  15706. return cli_->Patch(path, headers, params);
  15707. }
  15708. inline Result Client::Patch(const std::string &path,
  15709. const UploadFormDataItems &items,
  15710. UploadProgress progress) {
  15711. return cli_->Patch(path, items, progress);
  15712. }
  15713. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15714. const UploadFormDataItems &items,
  15715. UploadProgress progress) {
  15716. return cli_->Patch(path, headers, items, progress);
  15717. }
  15718. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15719. const UploadFormDataItems &items,
  15720. const std::string &boundary,
  15721. UploadProgress progress) {
  15722. return cli_->Patch(path, headers, items, boundary, progress);
  15723. }
  15724. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15725. const UploadFormDataItems &items,
  15726. const FormDataProviderItems &provider_items,
  15727. UploadProgress progress) {
  15728. return cli_->Patch(path, headers, items, provider_items, progress);
  15729. }
  15730. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15731. const std::string &body,
  15732. const std::string &content_type,
  15733. ContentReceiver content_receiver,
  15734. DownloadProgress progress) {
  15735. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15736. progress);
  15737. }
  15738. inline Result Client::Delete(const std::string &path,
  15739. DownloadProgress progress) {
  15740. return cli_->Delete(path, progress);
  15741. }
  15742. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15743. DownloadProgress progress) {
  15744. return cli_->Delete(path, headers, progress);
  15745. }
  15746. inline Result Client::Delete(const std::string &path, const char *body,
  15747. size_t content_length,
  15748. const std::string &content_type,
  15749. DownloadProgress progress) {
  15750. return cli_->Delete(path, body, content_length, content_type, progress);
  15751. }
  15752. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15753. const char *body, size_t content_length,
  15754. const std::string &content_type,
  15755. DownloadProgress progress) {
  15756. return cli_->Delete(path, headers, body, content_length, content_type,
  15757. progress);
  15758. }
  15759. inline Result Client::Delete(const std::string &path, const std::string &body,
  15760. const std::string &content_type,
  15761. DownloadProgress progress) {
  15762. return cli_->Delete(path, body, content_type, progress);
  15763. }
  15764. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15765. const std::string &body,
  15766. const std::string &content_type,
  15767. DownloadProgress progress) {
  15768. return cli_->Delete(path, headers, body, content_type, progress);
  15769. }
  15770. inline Result Client::Delete(const std::string &path, const Params &params,
  15771. DownloadProgress progress) {
  15772. return cli_->Delete(path, params, progress);
  15773. }
  15774. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15775. const Params &params, DownloadProgress progress) {
  15776. return cli_->Delete(path, headers, params, progress);
  15777. }
  15778. inline Result Client::Options(const std::string &path) {
  15779. return cli_->Options(path);
  15780. }
  15781. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15782. return cli_->Options(path, headers);
  15783. }
  15784. inline ClientImpl::StreamHandle
  15785. Client::open_stream(const std::string &method, const std::string &path,
  15786. const Params &params, const Headers &headers,
  15787. const std::string &body, const std::string &content_type) {
  15788. return cli_->open_stream(method, path, params, headers, body, content_type);
  15789. }
  15790. inline bool Client::send(Request &req, Response &res, Error &error) {
  15791. return cli_->send(req, res, error);
  15792. }
  15793. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15794. inline void Client::stop() { cli_->stop(); }
  15795. inline std::string Client::host() const { return cli_->host(); }
  15796. inline int Client::port() const { return cli_->port(); }
  15797. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15798. inline socket_t Client::socket() const { return cli_->socket(); }
  15799. inline void
  15800. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15801. cli_->set_hostname_addr_map(std::move(addr_map));
  15802. }
  15803. inline void Client::set_default_headers(Headers headers) {
  15804. cli_->set_default_headers(std::move(headers));
  15805. }
  15806. inline void Client::set_header_writer(
  15807. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15808. cli_->set_header_writer(writer);
  15809. }
  15810. inline void Client::set_address_family(int family) {
  15811. cli_->set_address_family(family);
  15812. }
  15813. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15814. inline void Client::set_socket_options(SocketOptions socket_options) {
  15815. cli_->set_socket_options(std::move(socket_options));
  15816. }
  15817. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15818. cli_->set_connection_timeout(sec, usec);
  15819. }
  15820. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15821. cli_->set_read_timeout(sec, usec);
  15822. }
  15823. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15824. cli_->set_write_timeout(sec, usec);
  15825. }
  15826. inline void Client::set_basic_auth(const std::string &username,
  15827. const std::string &password) {
  15828. cli_->set_basic_auth(username, password);
  15829. }
  15830. inline void Client::set_bearer_token_auth(const std::string &token) {
  15831. cli_->set_bearer_token_auth(token);
  15832. }
  15833. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15834. inline void Client::set_follow_location(bool on) {
  15835. cli_->set_follow_location(on);
  15836. }
  15837. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15838. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15839. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15840. inline void Client::set_payload_max_length(size_t length) {
  15841. cli_->set_payload_max_length(length);
  15842. }
  15843. inline void Client::set_interface(const std::string &intf) {
  15844. cli_->set_interface(intf);
  15845. }
  15846. inline void Client::set_proxy(const std::string &host, int port) {
  15847. cli_->set_proxy(host, port);
  15848. }
  15849. inline void Client::set_proxy_basic_auth(const std::string &username,
  15850. const std::string &password) {
  15851. cli_->set_proxy_basic_auth(username, password);
  15852. }
  15853. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15854. cli_->set_proxy_bearer_token_auth(token);
  15855. }
  15856. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15857. cli_->set_no_proxy(patterns);
  15858. }
  15859. inline void Client::set_logger(Logger logger) {
  15860. cli_->set_logger(std::move(logger));
  15861. }
  15862. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15863. cli_->set_error_logger(std::move(error_logger));
  15864. }
  15865. /*
  15866. * Group 6: SSL Server and Client implementation
  15867. */
  15868. #ifdef CPPHTTPLIB_SSL_ENABLED
  15869. // SSL HTTP server implementation
  15870. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15871. const char *client_ca_cert_file_path,
  15872. const char *client_ca_cert_dir_path,
  15873. const char *private_key_password) {
  15874. using namespace tls;
  15875. ctx_ = create_server_context();
  15876. if (!ctx_) { return; }
  15877. // Load server certificate and private key
  15878. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15879. private_key_password)) {
  15880. last_ssl_error_ = static_cast<int>(get_error());
  15881. free_context(ctx_);
  15882. ctx_ = nullptr;
  15883. return;
  15884. }
  15885. // Load client CA certificates for client authentication
  15886. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15887. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15888. client_ca_cert_dir_path)) {
  15889. last_ssl_error_ = static_cast<int>(get_error());
  15890. free_context(ctx_);
  15891. ctx_ = nullptr;
  15892. return;
  15893. }
  15894. // Enable client certificate verification
  15895. set_verify_client(ctx_, true);
  15896. }
  15897. }
  15898. inline SSLServer::SSLServer(const PemMemory &pem) {
  15899. using namespace tls;
  15900. ctx_ = create_server_context();
  15901. if (ctx_) {
  15902. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15903. pem.private_key_password)) {
  15904. last_ssl_error_ = static_cast<int>(get_error());
  15905. free_context(ctx_);
  15906. ctx_ = nullptr;
  15907. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15908. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15909. last_ssl_error_ = static_cast<int>(get_error());
  15910. free_context(ctx_);
  15911. ctx_ = nullptr;
  15912. } else {
  15913. set_verify_client(ctx_, true);
  15914. }
  15915. }
  15916. }
  15917. }
  15918. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15919. using namespace tls;
  15920. ctx_ = create_server_context();
  15921. if (ctx_) {
  15922. if (!setup_callback(ctx_)) {
  15923. free_context(ctx_);
  15924. ctx_ = nullptr;
  15925. }
  15926. }
  15927. }
  15928. inline SSLServer::~SSLServer() {
  15929. if (ctx_) { tls::free_context(ctx_); }
  15930. }
  15931. inline bool SSLServer::is_valid() const {
  15932. return ctx_ != nullptr && Server::is_valid();
  15933. }
  15934. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15935. using namespace tls;
  15936. session_t session = nullptr;
  15937. {
  15938. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15939. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  15940. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15941. if (session) { handshakes_in_progress_++; }
  15942. }
  15943. if (!session) {
  15944. last_ssl_error_ = static_cast<int>(get_error());
  15945. detail::shutdown_socket(sock);
  15946. detail::close_socket(sock);
  15947. return false;
  15948. }
  15949. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15950. bool handshake_done = false;
  15951. bool ret = false;
  15952. bool websocket_upgraded = false;
  15953. auto cleanup = detail::scope_exit([&] {
  15954. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15955. free_session(session);
  15956. detail::shutdown_socket(sock);
  15957. detail::close_socket(sock);
  15958. });
  15959. // Perform TLS accept handshake with timeout
  15960. TlsError tls_err;
  15961. auto accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  15962. read_timeout_usec_, &tls_err);
  15963. {
  15964. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15965. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  15966. }
  15967. if (!accepted) {
  15968. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15969. // Map TlsError to legacy ssl_error for backward compatibility
  15970. if (tls_err.code == ErrorCode::WantRead) {
  15971. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15972. } else if (tls_err.code == ErrorCode::WantWrite) {
  15973. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15974. } else {
  15975. last_ssl_error_ = SSL_ERROR_SSL;
  15976. }
  15977. #else
  15978. last_ssl_error_ = static_cast<int>(get_error());
  15979. #endif
  15980. return false;
  15981. }
  15982. handshake_done = true;
  15983. std::string remote_addr;
  15984. int remote_port = 0;
  15985. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15986. std::string local_addr;
  15987. int local_port = 0;
  15988. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15989. ret = serve_guarded([&]() {
  15990. return detail::process_server_socket_ssl(
  15991. svr_sock_, session, sock, keep_alive_max_count_,
  15992. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15993. write_timeout_sec_, write_timeout_usec_,
  15994. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15995. return process_request(
  15996. strm, remote_addr, remote_port, local_addr, local_port,
  15997. close_connection, connection_closed,
  15998. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15999. });
  16000. });
  16001. return ret;
  16002. }
  16003. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16004. const char *key_pem,
  16005. const char *client_ca_pem,
  16006. const char *password) {
  16007. if (!ctx_) { return false; }
  16008. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16009. updates_pending_++;
  16010. auto se = detail::scope_exit([&] {
  16011. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16012. });
  16013. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16014. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16015. return false;
  16016. }
  16017. if (client_ca_pem) {
  16018. return tls::update_server_client_ca(ctx_, client_ca_pem);
  16019. }
  16020. return true;
  16021. }
  16022. // SSL HTTP client implementation
  16023. inline SSLClient::~SSLClient() {
  16024. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16025. // base function rather than the derived function once we get to the
  16026. // base class destructor, and won't free the SSL (causing a leak).
  16027. // This must happen before the context is freed below: some backends
  16028. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16029. // context, so freeing the context first leaves close_notify reading
  16030. // freed memory.
  16031. shutdown_ssl_impl(socket_, true);
  16032. if (ctx_) {
  16033. tls::free_context(ctx_);
  16034. ctx_ = nullptr;
  16035. }
  16036. }
  16037. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16038. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16039. shutdown_ssl_impl(socket, shutdown_gracefully);
  16040. }
  16041. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16042. bool shutdown_gracefully) {
  16043. if (socket.sock == INVALID_SOCKET) {
  16044. assert(socket.ssl == nullptr);
  16045. return;
  16046. }
  16047. if (socket.ssl) {
  16048. tls::shutdown(socket.ssl, shutdown_gracefully);
  16049. {
  16050. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16051. tls::free_session(socket.ssl);
  16052. }
  16053. socket.ssl = nullptr;
  16054. }
  16055. assert(socket.ssl == nullptr);
  16056. }
  16057. inline bool SSLClient::process_socket(
  16058. const Socket &socket,
  16059. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16060. std::function<bool(Stream &strm)> callback) {
  16061. assert(socket.ssl);
  16062. return detail::process_client_socket_ssl(
  16063. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16064. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16065. std::move(callback));
  16066. }
  16067. inline bool SSLClient::is_ssl() const { return true; }
  16068. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16069. if (!is_valid()) {
  16070. error = Error::SSLConnection;
  16071. return false;
  16072. }
  16073. return ClientImpl::create_and_connect_socket(socket, error);
  16074. }
  16075. inline bool SSLClient::setup_proxy_connection(
  16076. Socket &socket,
  16077. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16078. Response &res, bool &success, Error &error) {
  16079. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16080. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16081. return false;
  16082. }
  16083. if (!initialize_ssl(socket, error)) {
  16084. success = false;
  16085. return false;
  16086. }
  16087. return true;
  16088. }
  16089. // Assumes that socket_mutex_ is locked and that there are no requests in
  16090. // flight
  16091. inline bool SSLClient::connect_with_proxy(
  16092. Socket &socket,
  16093. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16094. Response &res, bool &success, Error &error) {
  16095. success = true;
  16096. Response proxy_res;
  16097. if (!detail::process_client_socket(
  16098. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16099. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16100. start_time, [&](Stream &strm) {
  16101. Request req2;
  16102. req2.method = "CONNECT";
  16103. req2.path =
  16104. detail::make_host_and_port_string_always_port(host_, port_);
  16105. if (max_timeout_msec_ > 0) {
  16106. req2.start_time_ = std::chrono::steady_clock::now();
  16107. }
  16108. return process_request(strm, req2, proxy_res, false, error);
  16109. })) {
  16110. // Thread-safe to close everything because we are assuming there are no
  16111. // requests in flight
  16112. shutdown_ssl(socket, true);
  16113. shutdown_socket(socket);
  16114. close_socket(socket);
  16115. success = false;
  16116. return false;
  16117. }
  16118. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16119. if (!proxy_digest_auth_username_.empty() &&
  16120. !proxy_digest_auth_password_.empty()) {
  16121. std::map<std::string, std::string> auth;
  16122. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16123. // Close the current socket and create a new one for the authenticated
  16124. // request
  16125. shutdown_ssl(socket, true);
  16126. shutdown_socket(socket);
  16127. close_socket(socket);
  16128. // Create a new socket for the authenticated CONNECT request
  16129. if (!ensure_socket_connection(socket, error)) {
  16130. success = false;
  16131. output_error_log(error, nullptr);
  16132. return false;
  16133. }
  16134. proxy_res = Response();
  16135. if (!detail::process_client_socket(
  16136. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16137. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16138. start_time, [&](Stream &strm) {
  16139. Request req3;
  16140. req3.method = "CONNECT";
  16141. req3.path = detail::make_host_and_port_string_always_port(
  16142. host_, port_);
  16143. req3.headers.insert(detail::make_digest_authentication_header(
  16144. req3, auth, 1, detail::random_string(10),
  16145. proxy_digest_auth_username_, proxy_digest_auth_password_,
  16146. true));
  16147. if (max_timeout_msec_ > 0) {
  16148. req3.start_time_ = std::chrono::steady_clock::now();
  16149. }
  16150. return process_request(strm, req3, proxy_res, false, error);
  16151. })) {
  16152. // Thread-safe to close everything because we are assuming there are
  16153. // no requests in flight
  16154. shutdown_ssl(socket, true);
  16155. shutdown_socket(socket);
  16156. close_socket(socket);
  16157. success = false;
  16158. return false;
  16159. }
  16160. }
  16161. }
  16162. }
  16163. // If status code is not 200, proxy request is failed.
  16164. // Set error to ProxyConnection. A 407 is returned as the response of the
  16165. // request, so the caller sees the proxy asks for credentials; any other
  16166. // status would read as the answer of the origin, which it never reached.
  16167. if (proxy_res.status != StatusCode::OK_200) {
  16168. error = Error::ProxyConnection;
  16169. output_error_log(error, nullptr);
  16170. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16171. res = std::move(proxy_res);
  16172. } else {
  16173. success = false;
  16174. }
  16175. // Thread-safe to close everything because we are assuming there are
  16176. // no requests in flight
  16177. shutdown_ssl(socket, true);
  16178. shutdown_socket(socket);
  16179. close_socket(socket);
  16180. return false;
  16181. }
  16182. return true;
  16183. }
  16184. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16185. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16186. if (is_proxy_enabled_for_host(host_)) { return true; }
  16187. if (!initialize_ssl(socket, error)) {
  16188. shutdown_socket(socket);
  16189. close_socket(socket);
  16190. return false;
  16191. }
  16192. return true;
  16193. }
  16194. // SSL HTTP client implementation
  16195. inline SSLClient::SSLClient(const std::string &host)
  16196. : SSLClient(host, 443, std::string(), std::string()) {}
  16197. inline SSLClient::SSLClient(const std::string &host, int port)
  16198. : SSLClient(host, port, std::string(), std::string()) {}
  16199. inline void SSLClient::init_ctx() {
  16200. ctx_ = tls::create_client_context();
  16201. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16202. }
  16203. inline void SSLClient::reset_ctx_on_error() {
  16204. last_backend_error_ = tls::get_error();
  16205. tls::free_context(ctx_);
  16206. ctx_ = nullptr;
  16207. }
  16208. inline SSLClient::SSLClient(const std::string &host, int port,
  16209. const std::string &client_cert_path,
  16210. const std::string &client_key_path,
  16211. const std::string &private_key_password)
  16212. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16213. init_ctx();
  16214. if (!ctx_) { return; }
  16215. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16216. const char *password =
  16217. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16218. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16219. client_key_path.c_str(), password)) {
  16220. reset_ctx_on_error();
  16221. }
  16222. }
  16223. }
  16224. inline SSLClient::SSLClient(const std::string &host, int port,
  16225. const PemMemory &pem)
  16226. : ClientImpl(host, port) {
  16227. init_ctx();
  16228. if (!ctx_) { return; }
  16229. if (pem.cert_pem && pem.key_pem) {
  16230. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  16231. pem.private_key_password)) {
  16232. reset_ctx_on_error();
  16233. }
  16234. }
  16235. }
  16236. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16237. if (ca_cert_store && ctx_) {
  16238. // set_ca_store takes ownership of ca_cert_store
  16239. tls::set_ca_store(ctx_, ca_cert_store);
  16240. ca_cert_store_set_ = true;
  16241. } else if (ca_cert_store) {
  16242. tls::free_ca_store(ca_cert_store);
  16243. }
  16244. }
  16245. inline void
  16246. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16247. if (!ctx_) { return; }
  16248. server_certificate_verifier_ = verifier;
  16249. tls::set_verify_callback(ctx_, std::move(verifier));
  16250. }
  16251. inline void SSLClient::set_session_verifier(
  16252. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16253. session_verifier_ = std::move(verifier);
  16254. }
  16255. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16256. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16257. enable_windows_cert_verification_ = enabled;
  16258. }
  16259. #endif
  16260. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16261. std::size_t size) {
  16262. if (ctx_ && ca_cert && size > 0) {
  16263. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  16264. tls::load_ca_pem(ctx_, ca_cert, size);
  16265. }
  16266. }
  16267. inline bool SSLClient::load_certs() {
  16268. auto ret = true;
  16269. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16270. // one client is shared across concurrent requests here.
  16271. std::call_once(initialize_cert_, [&]() {
  16272. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16273. ret = detail::load_client_ca_config(
  16274. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16275. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16276. last_backend_error_);
  16277. });
  16278. return ret;
  16279. }
  16280. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16281. // Load CA certificates if server verification is enabled
  16282. if (server_certificate_verification_) {
  16283. if (!load_certs()) {
  16284. error = Error::SSLLoadingCerts;
  16285. output_error_log(error, nullptr);
  16286. return false;
  16287. }
  16288. }
  16289. detail::ClientTlsSessionOptions options;
  16290. options.server_hostname_verification = server_hostname_verification_;
  16291. options.session_verifier = session_verifier_;
  16292. options.ctx_mutex = &ctx_mutex_;
  16293. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16294. // Skip Schannel when a custom CA cert is specified, as the Windows
  16295. // certificate store would not know about user-provided CA certificates.
  16296. // Also skip when system CA trust is explicitly disabled.
  16297. options.windows_cert_verification =
  16298. enable_windows_cert_verification_ &&
  16299. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16300. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16301. // Only a verifier set through set_server_certificate_verifier() is seen
  16302. // here, not one installed with tls::set_verify_callback() directly.
  16303. options.server_certificate_verifier_set =
  16304. static_cast<bool>(server_certificate_verifier_);
  16305. #endif
  16306. tls::session_t session = nullptr;
  16307. // Use scope_exit to ensure session is freed on error paths
  16308. bool success = false;
  16309. auto session_guard = detail::scope_exit([&] {
  16310. if (!success) { tls::free_session(session); }
  16311. });
  16312. detail::ClientTlsSessionError tls_error;
  16313. if (!detail::setup_client_tls_session(
  16314. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16315. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16316. options)) {
  16317. error = tls_error.error;
  16318. last_ssl_error_ = tls_error.ssl_error;
  16319. last_backend_error_ = tls_error.backend_error;
  16320. output_error_log(error, nullptr);
  16321. return false;
  16322. }
  16323. success = true;
  16324. socket.ssl = session;
  16325. return true;
  16326. }
  16327. inline void Client::set_digest_auth(const std::string &username,
  16328. const std::string &password) {
  16329. cli_->set_digest_auth(username, password);
  16330. }
  16331. inline void Client::set_proxy_digest_auth(const std::string &username,
  16332. const std::string &password) {
  16333. cli_->set_proxy_digest_auth(username, password);
  16334. }
  16335. inline void Client::enable_server_certificate_verification(bool enabled) {
  16336. cli_->enable_server_certificate_verification(enabled);
  16337. }
  16338. inline void Client::enable_server_hostname_verification(bool enabled) {
  16339. cli_->enable_server_hostname_verification(enabled);
  16340. }
  16341. inline void Client::enable_system_ca(bool enabled) {
  16342. cli_->enable_system_ca(enabled);
  16343. }
  16344. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16345. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16346. if (is_ssl_) {
  16347. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16348. enabled);
  16349. }
  16350. }
  16351. #endif
  16352. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16353. const std::string &ca_cert_dir_path) {
  16354. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16355. }
  16356. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16357. if (is_ssl_) {
  16358. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16359. } else if (ca_cert_store) {
  16360. tls::free_ca_store(ca_cert_store);
  16361. }
  16362. }
  16363. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16364. if (is_ssl_) {
  16365. // Use the PEM-based path so the CA data is retained for redirect transfer
  16366. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16367. }
  16368. }
  16369. inline void
  16370. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16371. if (is_ssl_) {
  16372. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16373. std::move(verifier));
  16374. }
  16375. }
  16376. inline void Client::set_session_verifier(
  16377. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16378. if (is_ssl_) {
  16379. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16380. }
  16381. }
  16382. inline tls::ctx_t Client::tls_context() const {
  16383. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16384. return nullptr;
  16385. }
  16386. #endif // CPPHTTPLIB_SSL_ENABLED
  16387. /*
  16388. * Group 7: TLS abstraction layer - Common API
  16389. */
  16390. #ifdef CPPHTTPLIB_SSL_ENABLED
  16391. namespace tls {
  16392. // Helper for PeerCert construction
  16393. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16394. return PeerCert(get_peer_cert(session));
  16395. }
  16396. namespace impl {
  16397. // Check if a string is an IPv4 address
  16398. inline bool is_ipv4_address(const std::string &str) {
  16399. int dots = 0;
  16400. for (char c : str) {
  16401. if (c == '.') {
  16402. dots++;
  16403. } else if (!detail::is_ascii_digit(c)) {
  16404. return false;
  16405. }
  16406. }
  16407. return dots == 3;
  16408. }
  16409. // Parse IPv4 address string to bytes
  16410. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16411. const char *p = str.c_str();
  16412. for (int i = 0; i < 4; i++) {
  16413. if (i > 0) {
  16414. if (*p != '.') { return false; }
  16415. p++;
  16416. }
  16417. int val = 0;
  16418. int digits = 0;
  16419. while (detail::is_ascii_digit(*p)) {
  16420. val = val * 10 + (*p - '0');
  16421. if (val > 255) { return false; }
  16422. p++;
  16423. digits++;
  16424. }
  16425. if (digits == 0) { return false; }
  16426. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16427. if (digits > 1 && *(p - digits) == '0') { return false; }
  16428. out[i] = static_cast<unsigned char>(val);
  16429. }
  16430. return *p == '\0';
  16431. }
  16432. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16433. // `out` must have room for at least 16 bytes. Returns the address length
  16434. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16435. // literal. Used to match a host against iPAddress SANs the same way the
  16436. // OpenSSL backend does via X509_check_ip.
  16437. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16438. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16439. struct in6_addr addr6 = {};
  16440. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16441. memcpy(out, &addr6, 16);
  16442. return 16;
  16443. }
  16444. return 0;
  16445. }
  16446. #ifdef _WIN32
  16447. // Enumerate Windows system certificates and call callback with DER data
  16448. template <typename Callback>
  16449. inline bool enumerate_windows_system_certs(Callback cb) {
  16450. bool loaded = false;
  16451. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16452. for (auto store_name : store_names) {
  16453. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16454. if (hStore) {
  16455. PCCERT_CONTEXT pContext = nullptr;
  16456. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16457. nullptr) {
  16458. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16459. loaded = true;
  16460. }
  16461. }
  16462. CertCloseStore(hStore, 0);
  16463. }
  16464. }
  16465. return loaded;
  16466. }
  16467. #endif
  16468. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16469. // Enumerate macOS Keychain certificates and call callback with DER data
  16470. template <typename Callback>
  16471. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16472. bool loaded = false;
  16473. const SecTrustSettingsDomain domains[] = {
  16474. kSecTrustSettingsDomainSystem,
  16475. kSecTrustSettingsDomainAdmin,
  16476. kSecTrustSettingsDomainUser,
  16477. };
  16478. for (auto domain : domains) {
  16479. CFArrayRef certs = nullptr;
  16480. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16481. if (status != errSecSuccess || !certs) {
  16482. if (certs) CFRelease(certs);
  16483. continue;
  16484. }
  16485. CFIndex count = CFArrayGetCount(certs);
  16486. for (CFIndex i = 0; i < count; i++) {
  16487. SecCertificateRef cert =
  16488. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16489. CFDataRef data = SecCertificateCopyData(cert);
  16490. if (data) {
  16491. if (cb(CFDataGetBytePtr(data),
  16492. static_cast<size_t>(CFDataGetLength(data)))) {
  16493. loaded = true;
  16494. }
  16495. CFRelease(data);
  16496. }
  16497. }
  16498. CFRelease(certs);
  16499. }
  16500. return loaded;
  16501. }
  16502. #endif
  16503. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16504. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16505. // Common CA certificate file paths on Linux/Unix
  16506. inline const char **system_ca_paths() {
  16507. static const char *paths[] = {
  16508. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16509. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16510. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16511. "/etc/pki/tls/cacert.pem", // OpenELEC
  16512. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16513. nullptr};
  16514. return paths;
  16515. }
  16516. // Common CA certificate directory paths on Linux/Unix
  16517. inline const char **system_ca_dirs() {
  16518. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16519. "/etc/pki/tls/certs", // RHEL/CentOS
  16520. "/usr/share/ca-certificates", // Other
  16521. nullptr};
  16522. return dirs;
  16523. }
  16524. #endif
  16525. } // namespace impl
  16526. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16527. const char *ca_dir) {
  16528. if (!ctx) { return false; }
  16529. bool success = true;
  16530. if (ca_file && *ca_file) {
  16531. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16532. }
  16533. if (ca_dir && *ca_dir) {
  16534. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16535. }
  16536. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16537. // Set CA list for client certificate request (CertificateRequest message)
  16538. if (ca_file && *ca_file) {
  16539. auto list = SSL_load_client_CA_file(ca_file);
  16540. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16541. }
  16542. #endif
  16543. return success;
  16544. }
  16545. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16546. const char *password) {
  16547. return set_client_cert_pem(ctx, cert, key, password);
  16548. }
  16549. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16550. const char *key_path, const char *password) {
  16551. return set_client_cert_file(ctx, cert_path, key_path, password);
  16552. }
  16553. // PeerCert implementation
  16554. inline PeerCert::PeerCert() = default;
  16555. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16556. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16557. other.cert_ = nullptr;
  16558. }
  16559. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16560. if (this != &other) {
  16561. if (cert_) { free_cert(cert_); }
  16562. cert_ = other.cert_;
  16563. other.cert_ = nullptr;
  16564. }
  16565. return *this;
  16566. }
  16567. inline PeerCert::~PeerCert() {
  16568. if (cert_) { free_cert(cert_); }
  16569. }
  16570. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16571. inline std::string PeerCert::subject_cn() const {
  16572. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16573. }
  16574. inline std::string PeerCert::issuer_name() const {
  16575. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16576. }
  16577. inline bool PeerCert::check_hostname(const char *hostname) const {
  16578. return cert_ ? verify_hostname(cert_, hostname) : false;
  16579. }
  16580. inline std::vector<SanEntry> PeerCert::sans() const {
  16581. std::vector<SanEntry> result;
  16582. if (cert_) { get_cert_sans(cert_, result); }
  16583. return result;
  16584. }
  16585. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16586. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16587. }
  16588. inline std::string PeerCert::serial() const {
  16589. return cert_ ? get_cert_serial(cert_) : std::string();
  16590. }
  16591. // VerifyContext method implementations
  16592. inline std::string VerifyContext::subject_cn() const {
  16593. return cert ? get_cert_subject_cn(cert) : std::string();
  16594. }
  16595. inline std::string VerifyContext::issuer_name() const {
  16596. return cert ? get_cert_issuer_name(cert) : std::string();
  16597. }
  16598. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16599. return cert ? verify_hostname(cert, hostname) : false;
  16600. }
  16601. inline std::vector<SanEntry> VerifyContext::sans() const {
  16602. std::vector<SanEntry> result;
  16603. if (cert) { get_cert_sans(cert, result); }
  16604. return result;
  16605. }
  16606. inline bool VerifyContext::validity(time_t &not_before,
  16607. time_t &not_after) const {
  16608. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16609. }
  16610. inline std::string VerifyContext::serial() const {
  16611. return cert ? get_cert_serial(cert) : std::string();
  16612. }
  16613. // TlsError static method implementation
  16614. inline std::string TlsError::verify_error_to_string(long error_code) {
  16615. return verify_error_string(error_code);
  16616. }
  16617. } // namespace tls
  16618. // Request::peer_cert() implementation
  16619. inline tls::PeerCert Request::peer_cert() const {
  16620. return tls::get_peer_cert_from_session(ssl);
  16621. }
  16622. // Request::sni() implementation
  16623. inline std::string Request::sni() const {
  16624. if (!ssl) { return std::string(); }
  16625. const char *s = tls::get_sni(ssl);
  16626. return s ? std::string(s) : std::string();
  16627. }
  16628. #endif // CPPHTTPLIB_SSL_ENABLED
  16629. /*
  16630. * Group 8: TLS abstraction layer - OpenSSL backend
  16631. */
  16632. /*
  16633. * OpenSSL Backend Implementation
  16634. */
  16635. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16636. namespace tls {
  16637. namespace impl {
  16638. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16639. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16640. switch (ssl_error) {
  16641. case SSL_ERROR_NONE: return ErrorCode::Success;
  16642. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16643. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16644. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16645. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16646. case SSL_ERROR_SSL:
  16647. default: return ErrorCode::Fatal;
  16648. }
  16649. }
  16650. // Helper: Create client CA list from PEM string
  16651. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16652. // Caller takes ownership of returned list
  16653. inline STACK_OF(X509_NAME) *
  16654. create_client_ca_list_from_pem(const char *ca_pem) {
  16655. if (!ca_pem) { return nullptr; }
  16656. auto ca_list = sk_X509_NAME_new_null();
  16657. if (!ca_list) { return nullptr; }
  16658. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16659. if (!bio) {
  16660. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16661. return nullptr;
  16662. }
  16663. X509 *cert = nullptr;
  16664. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16665. nullptr) {
  16666. const X509_NAME *name = X509_get_subject_name(cert);
  16667. if (name) {
  16668. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16669. }
  16670. X509_free(cert);
  16671. }
  16672. BIO_free(bio);
  16673. return ca_list;
  16674. }
  16675. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16676. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16677. long /*argl*/, void * /*argp*/) {
  16678. delete static_cast<VerifyCallback *>(ptr);
  16679. }
  16680. // The SSL_CTX owns its verify callback, so each client or server sees only
  16681. // its own, on whichever thread runs the handshake.
  16682. inline int verify_callback_index() {
  16683. static const auto index = SSL_CTX_get_ex_new_index(
  16684. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16685. return index;
  16686. }
  16687. // OpenSSL verify callback wrapper
  16688. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16689. // Get SSL object from X509_STORE_CTX
  16690. auto ssl = static_cast<SSL *>(
  16691. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16692. if (!ssl) { return preverify_ok; }
  16693. auto callback = static_cast<VerifyCallback *>(
  16694. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16695. if (!callback) { return preverify_ok; }
  16696. // Get current certificate and depth
  16697. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16698. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16699. int error = X509_STORE_CTX_get_error(ctx);
  16700. // Build context
  16701. VerifyContext verify_ctx;
  16702. verify_ctx.session = static_cast<session_t>(ssl);
  16703. verify_ctx.cert = static_cast<cert_t>(cert);
  16704. verify_ctx.depth = depth;
  16705. verify_ctx.preverify_ok = (preverify_ok != 0);
  16706. verify_ctx.error_code = error;
  16707. verify_ctx.error_string =
  16708. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16709. return (*callback)(verify_ctx) ? 1 : 0;
  16710. }
  16711. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16712. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16713. // that must be released with release_store_objects
  16714. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16715. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16716. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16717. #endif
  16718. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16719. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16720. return X509_STORE_get1_objects(store);
  16721. #else
  16722. return X509_STORE_get0_objects(store);
  16723. #endif
  16724. }
  16725. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16726. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16727. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16728. #else
  16729. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16730. #endif
  16731. }
  16732. } // namespace impl
  16733. inline ctx_t create_client_context() {
  16734. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16735. if (ctx) {
  16736. // Disable auto-retry to properly handle non-blocking I/O
  16737. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16738. // Set minimum TLS version
  16739. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16740. }
  16741. return static_cast<ctx_t>(ctx);
  16742. }
  16743. inline void free_context(ctx_t ctx) {
  16744. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16745. }
  16746. inline bool set_min_version(ctx_t ctx, Version version) {
  16747. if (!ctx) return false;
  16748. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16749. static_cast<int>(version)) == 1;
  16750. }
  16751. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16752. if (!ctx || !pem || len == 0) return false;
  16753. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16754. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16755. if (!store) return false;
  16756. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16757. if (!bio) return false;
  16758. bool ok = true;
  16759. X509 *cert = nullptr;
  16760. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16761. nullptr) {
  16762. if (X509_STORE_add_cert(store, cert) != 1) {
  16763. // Ignore duplicate errors
  16764. auto err = ERR_peek_last_error();
  16765. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16766. ok = false;
  16767. }
  16768. }
  16769. X509_free(cert);
  16770. if (!ok) break;
  16771. }
  16772. BIO_free(bio);
  16773. // Clear any "no more certificates" errors
  16774. ERR_clear_error();
  16775. return ok;
  16776. }
  16777. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16778. if (!ctx || !file_path) return false;
  16779. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16780. nullptr) == 1;
  16781. }
  16782. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16783. if (!ctx || !dir_path) return false;
  16784. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16785. dir_path) == 1;
  16786. }
  16787. inline bool load_system_certs(ctx_t ctx) {
  16788. if (!ctx) return false;
  16789. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16790. #ifdef _WIN32
  16791. // Windows: Load from system certificate store (ROOT and CA)
  16792. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16793. if (!store) return false;
  16794. bool loaded_any = false;
  16795. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16796. for (auto store_name : store_names) {
  16797. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16798. if (!hStore) continue;
  16799. PCCERT_CONTEXT pContext = nullptr;
  16800. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16801. nullptr) {
  16802. const unsigned char *data = pContext->pbCertEncoded;
  16803. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16804. if (x509) {
  16805. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16806. X509_free(x509);
  16807. }
  16808. }
  16809. CertCloseStore(hStore, 0);
  16810. }
  16811. return loaded_any;
  16812. #elif defined(__APPLE__)
  16813. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16814. // macOS: Load from Keychain
  16815. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16816. if (!store) return false;
  16817. bool loaded_any = false;
  16818. const SecTrustSettingsDomain domains[] = {
  16819. kSecTrustSettingsDomainSystem,
  16820. kSecTrustSettingsDomainAdmin,
  16821. kSecTrustSettingsDomainUser,
  16822. };
  16823. for (auto domain : domains) {
  16824. CFArrayRef certs = nullptr;
  16825. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16826. !certs) {
  16827. if (certs) CFRelease(certs);
  16828. continue;
  16829. }
  16830. auto count = CFArrayGetCount(certs);
  16831. for (CFIndex i = 0; i < count; i++) {
  16832. auto cert = reinterpret_cast<SecCertificateRef>(
  16833. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16834. CFDataRef der = SecCertificateCopyData(cert);
  16835. if (der) {
  16836. const unsigned char *data = CFDataGetBytePtr(der);
  16837. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16838. if (x509) {
  16839. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16840. X509_free(x509);
  16841. }
  16842. CFRelease(der);
  16843. }
  16844. }
  16845. CFRelease(certs);
  16846. }
  16847. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16848. #else
  16849. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16850. #endif
  16851. #else
  16852. // Other Unix: use default verify paths
  16853. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16854. #endif
  16855. }
  16856. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16857. const char *password) {
  16858. if (!ctx || !cert || !key) return false;
  16859. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16860. // Load certificate
  16861. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16862. if (!cert_bio) return false;
  16863. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16864. BIO_free(cert_bio);
  16865. if (!x509) return false;
  16866. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16867. X509_free(x509);
  16868. if (!cert_ok) return false;
  16869. // Load private key
  16870. auto key_bio = BIO_new_mem_buf(key, -1);
  16871. if (!key_bio) return false;
  16872. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16873. password ? const_cast<char *>(password)
  16874. : nullptr);
  16875. BIO_free(key_bio);
  16876. if (!pkey) return false;
  16877. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16878. EVP_PKEY_free(pkey);
  16879. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16880. }
  16881. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16882. const char *key_path, const char *password) {
  16883. if (!ctx || !cert_path || !key_path) return false;
  16884. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16885. if (password && password[0] != '\0') {
  16886. SSL_CTX_set_default_passwd_cb_userdata(
  16887. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16888. }
  16889. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16890. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16891. }
  16892. inline ctx_t create_server_context() {
  16893. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16894. if (ctx) {
  16895. // No renegotiation, as on the other backends: it would run a handshake
  16896. // that SSLServer::update_certs_pem() does not wait for
  16897. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16898. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  16899. SSL_OP_NO_RENEGOTIATION);
  16900. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16901. }
  16902. return static_cast<ctx_t>(ctx);
  16903. }
  16904. inline void set_verify_client(ctx_t ctx, bool require) {
  16905. if (!ctx) return;
  16906. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16907. require
  16908. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16909. : SSL_VERIFY_NONE,
  16910. nullptr);
  16911. }
  16912. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16913. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16914. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16915. SSL *ssl = SSL_new(ssl_ctx);
  16916. if (!ssl) return nullptr;
  16917. // Disable auto-retry for proper non-blocking I/O handling
  16918. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16919. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16920. if (!bio) {
  16921. SSL_free(ssl);
  16922. return nullptr;
  16923. }
  16924. SSL_set_bio(ssl, bio, bio);
  16925. return static_cast<session_t>(ssl);
  16926. }
  16927. inline void free_session(session_t session) {
  16928. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16929. }
  16930. inline bool set_sni(session_t session, const char *hostname,
  16931. bool /*verify_hostname*/) {
  16932. if (!session || !hostname) return false;
  16933. auto ssl = static_cast<SSL *>(session);
  16934. // Set SNI (Server Name Indication) only - does not enable verification.
  16935. // OpenSSL never binds identity checking to SNI (that happens post-
  16936. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16937. #if defined(OPENSSL_IS_BORINGSSL)
  16938. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16939. #else
  16940. // Direct call instead of macro to suppress -Wold-style-cast warning
  16941. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16942. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16943. #endif
  16944. }
  16945. inline TlsError connect(session_t session) {
  16946. if (!session) { return TlsError(); }
  16947. auto ssl = static_cast<SSL *>(session);
  16948. auto ret = SSL_connect(ssl);
  16949. TlsError err;
  16950. if (ret == 1) {
  16951. err.code = ErrorCode::Success;
  16952. } else {
  16953. auto ssl_err = SSL_get_error(ssl, ret);
  16954. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16955. err.backend_code = ERR_get_error();
  16956. }
  16957. return err;
  16958. }
  16959. inline TlsError accept(session_t session) {
  16960. if (!session) { return TlsError(); }
  16961. auto ssl = static_cast<SSL *>(session);
  16962. auto ret = SSL_accept(ssl);
  16963. TlsError err;
  16964. if (ret == 1) {
  16965. err.code = ErrorCode::Success;
  16966. } else {
  16967. auto ssl_err = SSL_get_error(ssl, ret);
  16968. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16969. err.backend_code = ERR_get_error();
  16970. }
  16971. return err;
  16972. }
  16973. inline bool connect_nonblocking(session_t session, socket_t sock,
  16974. time_t timeout_sec, time_t timeout_usec,
  16975. TlsError *err) {
  16976. if (!session) {
  16977. if (err) { err->code = ErrorCode::Fatal; }
  16978. return false;
  16979. }
  16980. auto ssl = static_cast<SSL *>(session);
  16981. auto bio = SSL_get_rbio(ssl);
  16982. // Set non-blocking mode for handshake
  16983. detail::set_nonblocking(sock, true);
  16984. if (bio) { BIO_set_nbio(bio, 1); }
  16985. auto cleanup = detail::scope_exit([&]() {
  16986. // Restore blocking mode after handshake
  16987. if (bio) { BIO_set_nbio(bio, 0); }
  16988. detail::set_nonblocking(sock, false);
  16989. });
  16990. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16991. auto res = 0;
  16992. while ((res = SSL_connect(ssl)) != 1) {
  16993. auto ssl_err = SSL_get_error(ssl, res);
  16994. switch (ssl_err) {
  16995. case SSL_ERROR_WANT_READ:
  16996. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  16997. break;
  16998. case SSL_ERROR_WANT_WRITE:
  16999. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17000. break;
  17001. default: break;
  17002. }
  17003. if (err) {
  17004. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17005. err->backend_code = ERR_get_error();
  17006. }
  17007. return false;
  17008. }
  17009. if (err) { err->code = ErrorCode::Success; }
  17010. return true;
  17011. }
  17012. inline bool accept_nonblocking(session_t session, socket_t sock,
  17013. time_t timeout_sec, time_t timeout_usec,
  17014. TlsError *err) {
  17015. if (!session) {
  17016. if (err) { err->code = ErrorCode::Fatal; }
  17017. return false;
  17018. }
  17019. auto ssl = static_cast<SSL *>(session);
  17020. auto bio = SSL_get_rbio(ssl);
  17021. // Set non-blocking mode for handshake
  17022. detail::set_nonblocking(sock, true);
  17023. if (bio) { BIO_set_nbio(bio, 1); }
  17024. auto cleanup = detail::scope_exit([&]() {
  17025. // Restore blocking mode after handshake
  17026. if (bio) { BIO_set_nbio(bio, 0); }
  17027. detail::set_nonblocking(sock, false);
  17028. });
  17029. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17030. auto res = 0;
  17031. while ((res = SSL_accept(ssl)) != 1) {
  17032. auto ssl_err = SSL_get_error(ssl, res);
  17033. switch (ssl_err) {
  17034. case SSL_ERROR_WANT_READ:
  17035. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17036. break;
  17037. case SSL_ERROR_WANT_WRITE:
  17038. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17039. break;
  17040. default: break;
  17041. }
  17042. if (err) {
  17043. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17044. err->backend_code = ERR_get_error();
  17045. }
  17046. return false;
  17047. }
  17048. if (err) { err->code = ErrorCode::Success; }
  17049. return true;
  17050. }
  17051. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17052. if (!session || !buf) {
  17053. err.code = ErrorCode::Fatal;
  17054. return -1;
  17055. }
  17056. auto ssl = static_cast<SSL *>(session);
  17057. constexpr auto max_len =
  17058. static_cast<size_t>((std::numeric_limits<int>::max)());
  17059. if (len > max_len) { len = max_len; }
  17060. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17061. if (ret > 0) {
  17062. err.code = ErrorCode::Success;
  17063. return ret;
  17064. }
  17065. auto ssl_err = SSL_get_error(ssl, ret);
  17066. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17067. if (err.code == ErrorCode::PeerClosed) {
  17068. return 0;
  17069. } // Gracefully handle the peer closed state.
  17070. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17071. return -1;
  17072. }
  17073. inline ssize_t write(session_t session, const void *buf, size_t len,
  17074. TlsError &err) {
  17075. if (!session || !buf) {
  17076. err.code = ErrorCode::Fatal;
  17077. return -1;
  17078. }
  17079. auto ssl = static_cast<SSL *>(session);
  17080. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17081. if (ret > 0) {
  17082. err.code = ErrorCode::Success;
  17083. return ret;
  17084. }
  17085. auto ssl_err = SSL_get_error(ssl, ret);
  17086. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17087. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17088. return -1;
  17089. }
  17090. inline int pending(const_session_t session) {
  17091. if (!session) return 0;
  17092. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17093. }
  17094. inline void shutdown(session_t session, bool graceful) {
  17095. if (!session) return;
  17096. auto ssl = static_cast<SSL *>(session);
  17097. if (graceful) {
  17098. // Send close_notify without waiting for the peer's. The connection is
  17099. // closed right after this, so a unidirectional shutdown is enough, and an
  17100. // idle peer that never answers would otherwise hold this thread until the
  17101. // read timeout. The other backends do not wait either.
  17102. SSL_shutdown(ssl);
  17103. }
  17104. }
  17105. inline bool is_peer_closed(session_t session, socket_t sock) {
  17106. if (!session) return true;
  17107. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17108. detail::set_nonblocking(sock, true);
  17109. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17110. auto ssl = static_cast<SSL *>(session);
  17111. char buf;
  17112. auto ret = SSL_peek(ssl, &buf, 1);
  17113. if (ret > 0) return false;
  17114. auto err = SSL_get_error(ssl, ret);
  17115. return err == SSL_ERROR_ZERO_RETURN;
  17116. }
  17117. inline cert_t get_peer_cert(const_session_t session) {
  17118. if (!session) return nullptr;
  17119. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17120. static_cast<SSL *>(const_cast<void *>(session))));
  17121. }
  17122. inline size_t get_peer_certs(const_session_t session,
  17123. std::vector<cert_t> &certs) {
  17124. certs.clear();
  17125. if (!session) { return 0; }
  17126. auto ssl = static_cast<const SSL *>(session);
  17127. // On the server side, the chain leaves out the peer's own certificate
  17128. if (SSL_is_server(ssl)) {
  17129. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17130. }
  17131. auto sk = SSL_get_peer_cert_chain(ssl);
  17132. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  17133. auto x509 = sk_X509_value(sk, i);
  17134. X509_up_ref(x509);
  17135. certs.push_back(static_cast<cert_t>(x509));
  17136. }
  17137. return certs.size();
  17138. }
  17139. inline void free_cert(cert_t cert) {
  17140. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17141. }
  17142. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17143. if (!cert || !hostname) return false;
  17144. auto x509 = static_cast<X509 *>(cert);
  17145. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17146. if (detail::is_ip_address(hostname)) {
  17147. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17148. }
  17149. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17150. }
  17151. inline uint64_t hostname_mismatch_code() {
  17152. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17153. }
  17154. inline long get_verify_result(const_session_t session) {
  17155. if (!session) return X509_V_ERR_UNSPECIFIED;
  17156. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17157. }
  17158. inline std::string get_cert_subject_cn(cert_t cert) {
  17159. if (!cert) return "";
  17160. auto x509 = static_cast<X509 *>(cert);
  17161. auto subject_name = X509_get_subject_name(x509);
  17162. if (!subject_name) return "";
  17163. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17164. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17165. if (idx < 0) return "";
  17166. auto entry = X509_NAME_get_entry(subject_name, idx);
  17167. if (!entry) return "";
  17168. auto data = X509_NAME_ENTRY_get_data(entry);
  17169. if (!data) return "";
  17170. return std::string(
  17171. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17172. static_cast<size_t>(ASN1_STRING_length(data)));
  17173. }
  17174. inline std::string get_cert_issuer_name(cert_t cert) {
  17175. if (!cert) return "";
  17176. auto x509 = static_cast<X509 *>(cert);
  17177. auto issuer_name = X509_get_issuer_name(x509);
  17178. if (!issuer_name) return "";
  17179. char buf[256];
  17180. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17181. return std::string(buf);
  17182. }
  17183. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17184. sans.clear();
  17185. if (!cert) return false;
  17186. auto x509 = static_cast<X509 *>(cert);
  17187. auto names = static_cast<GENERAL_NAMES *>(
  17188. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17189. if (!names) return true; // No SANs is valid
  17190. auto count = sk_GENERAL_NAME_num(names);
  17191. for (decltype(count) i = 0; i < count; i++) {
  17192. auto gen = sk_GENERAL_NAME_value(names, i);
  17193. if (!gen) continue;
  17194. SanEntry entry;
  17195. switch (gen->type) {
  17196. case GEN_DNS:
  17197. entry.type = SanType::DNS;
  17198. if (gen->d.dNSName) {
  17199. entry.value = std::string(
  17200. reinterpret_cast<const char *>(
  17201. ASN1_STRING_get0_data(gen->d.dNSName)),
  17202. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17203. }
  17204. break;
  17205. case GEN_IPADD:
  17206. entry.type = SanType::IP;
  17207. if (gen->d.iPAddress) {
  17208. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17209. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17210. if (len == 4) {
  17211. // IPv4
  17212. char buf[INET_ADDRSTRLEN];
  17213. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17214. entry.value = buf;
  17215. } else if (len == 16) {
  17216. // IPv6
  17217. char buf[INET6_ADDRSTRLEN];
  17218. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17219. entry.value = buf;
  17220. }
  17221. }
  17222. break;
  17223. case GEN_EMAIL:
  17224. entry.type = SanType::EMAIL;
  17225. if (gen->d.rfc822Name) {
  17226. entry.value = std::string(
  17227. reinterpret_cast<const char *>(
  17228. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17229. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17230. }
  17231. break;
  17232. case GEN_URI:
  17233. entry.type = SanType::URI;
  17234. if (gen->d.uniformResourceIdentifier) {
  17235. entry.value = std::string(
  17236. reinterpret_cast<const char *>(
  17237. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17238. static_cast<size_t>(
  17239. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17240. }
  17241. break;
  17242. default: entry.type = SanType::OTHER; break;
  17243. }
  17244. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17245. }
  17246. GENERAL_NAMES_free(names);
  17247. return true;
  17248. }
  17249. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17250. time_t &not_after) {
  17251. if (!cert) return false;
  17252. auto x509 = static_cast<X509 *>(cert);
  17253. auto nb = X509_get0_notBefore(x509);
  17254. auto na = X509_get0_notAfter(x509);
  17255. if (!nb || !na) return false;
  17256. ASN1_TIME *epoch = ASN1_TIME_new();
  17257. if (!epoch) return false;
  17258. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17259. if (!ASN1_TIME_set(epoch, 0)) return false;
  17260. int pday, psec;
  17261. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17262. not_before = 86400 * (time_t)pday + psec;
  17263. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17264. not_after = 86400 * (time_t)pday + psec;
  17265. return true;
  17266. }
  17267. inline std::string get_cert_serial(cert_t cert) {
  17268. if (!cert) return "";
  17269. auto x509 = static_cast<X509 *>(cert);
  17270. auto serial = X509_get_serialNumber(x509);
  17271. if (!serial) return "";
  17272. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17273. if (!bn) return "";
  17274. auto hex = BN_bn2hex(bn);
  17275. BN_free(bn);
  17276. if (!hex) return "";
  17277. std::string result(hex);
  17278. OPENSSL_free(hex);
  17279. return result;
  17280. }
  17281. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17282. if (!cert) return false;
  17283. auto x509 = static_cast<X509 *>(cert);
  17284. auto len = i2d_X509(x509, nullptr);
  17285. if (len < 0) return false;
  17286. der.resize(static_cast<size_t>(len));
  17287. auto p = der.data();
  17288. i2d_X509(x509, &p);
  17289. return true;
  17290. }
  17291. inline const char *get_sni(const_session_t session) {
  17292. if (!session) return nullptr;
  17293. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17294. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17295. }
  17296. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17297. inline uint64_t get_error() { return ERR_get_error(); }
  17298. inline std::string error_string(uint64_t code) {
  17299. char buf[256];
  17300. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17301. return std::string(buf);
  17302. }
  17303. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17304. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17305. if (!mem) { return nullptr; }
  17306. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17307. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17308. if (!inf) { return nullptr; }
  17309. auto store = X509_STORE_new();
  17310. if (store) {
  17311. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17312. auto itmp = sk_X509_INFO_value(inf, i);
  17313. if (!itmp) { continue; }
  17314. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17315. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17316. }
  17317. }
  17318. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17319. return static_cast<ca_store_t>(store);
  17320. }
  17321. inline void free_ca_store(ca_store_t store) {
  17322. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17323. }
  17324. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17325. if (!ctx || !store) { return false; }
  17326. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17327. auto x509_store = static_cast<X509_STORE *>(store);
  17328. // Check if same store is already set
  17329. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17330. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17331. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17332. return true;
  17333. }
  17334. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17335. certs.clear();
  17336. if (!ctx) { return 0; }
  17337. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17338. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17339. if (!store) { return 0; }
  17340. auto objs = impl::get_store_objects(store);
  17341. if (!objs) { return 0; }
  17342. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17343. auto count = sk_X509_OBJECT_num(objs);
  17344. for (decltype(count) i = 0; i < count; i++) {
  17345. auto obj = sk_X509_OBJECT_value(objs, i);
  17346. if (!obj) { continue; }
  17347. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17348. auto x509 = X509_OBJECT_get0_X509(obj);
  17349. if (x509) {
  17350. // Increment reference count so caller can free it
  17351. X509_up_ref(x509);
  17352. certs.push_back(static_cast<cert_t>(x509));
  17353. }
  17354. }
  17355. }
  17356. return certs.size();
  17357. }
  17358. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17359. std::vector<std::string> names;
  17360. if (!ctx) { return names; }
  17361. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17362. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17363. if (!store) { return names; }
  17364. auto objs = impl::get_store_objects(store);
  17365. if (!objs) { return names; }
  17366. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17367. auto count = sk_X509_OBJECT_num(objs);
  17368. for (decltype(count) i = 0; i < count; i++) {
  17369. auto obj = sk_X509_OBJECT_value(objs, i);
  17370. if (!obj) { continue; }
  17371. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17372. auto x509 = X509_OBJECT_get0_X509(obj);
  17373. if (x509) {
  17374. auto subject = X509_get_subject_name(x509);
  17375. if (subject) {
  17376. char buf[512];
  17377. X509_NAME_oneline(subject, buf, sizeof(buf));
  17378. names.push_back(buf);
  17379. }
  17380. }
  17381. }
  17382. }
  17383. return names;
  17384. }
  17385. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17386. const char *key_pem, const char *password) {
  17387. if (!ctx || !cert_pem || !key_pem) { return false; }
  17388. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17389. // Load certificate from PEM
  17390. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17391. if (!cert_bio) { return false; }
  17392. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17393. BIO_free(cert_bio);
  17394. if (!cert) { return false; }
  17395. // Load private key from PEM
  17396. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17397. if (!key_bio) {
  17398. X509_free(cert);
  17399. return false;
  17400. }
  17401. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17402. password ? const_cast<char *>(password)
  17403. : nullptr);
  17404. BIO_free(key_bio);
  17405. if (!key) {
  17406. X509_free(cert);
  17407. return false;
  17408. }
  17409. // Update certificate and key
  17410. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17411. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17412. X509_free(cert);
  17413. EVP_PKEY_free(key);
  17414. return ret;
  17415. }
  17416. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17417. if (!ctx || !ca_pem) { return false; }
  17418. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17419. // Create new X509_STORE from PEM
  17420. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17421. if (!store) { return false; }
  17422. // SSL_CTX_set_cert_store takes ownership
  17423. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17424. // Set client CA list for client certificate request
  17425. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17426. if (ca_list) {
  17427. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17428. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17429. }
  17430. // A resumed session is not verified again, so forget the sessions and the
  17431. // ticket keys from before, or a client verified under the old CAs could go
  17432. // on resuming.
  17433. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17434. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17435. #else
  17436. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17437. #endif
  17438. unsigned char ticket_keys[80];
  17439. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) == 1) {
  17440. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys, sizeof(ticket_keys));
  17441. }
  17442. return true;
  17443. }
  17444. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17445. if (!ctx) { return false; }
  17446. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17447. auto index = impl::verify_callback_index();
  17448. if (index < 0) { return false; }
  17449. auto stored = callback ? new VerifyCallback(std::move(callback)) : nullptr;
  17450. delete static_cast<VerifyCallback *>(SSL_CTX_get_ex_data(ssl_ctx, index));
  17451. SSL_CTX_set_ex_data(ssl_ctx, index, stored);
  17452. if (stored) {
  17453. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17454. } else {
  17455. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17456. }
  17457. return true;
  17458. }
  17459. inline long get_verify_error(const_session_t session) {
  17460. if (!session) { return -1; }
  17461. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17462. return SSL_get_verify_result(ssl);
  17463. }
  17464. inline std::string verify_error_string(long error_code) {
  17465. if (error_code == X509_V_OK) { return ""; }
  17466. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17467. return str ? str : "unknown error";
  17468. }
  17469. } // namespace tls
  17470. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17471. /*
  17472. * Group 9: TLS abstraction layer - Mbed TLS backend
  17473. */
  17474. /*
  17475. * Mbed TLS Backend Implementation
  17476. */
  17477. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17478. namespace tls {
  17479. namespace impl {
  17480. // Mbed TLS session wrapper
  17481. struct MbedTlsSession {
  17482. mbedtls_ssl_context ssl;
  17483. socket_t sock = INVALID_SOCKET;
  17484. std::string hostname; // For client: set via set_sni
  17485. std::string sni_hostname; // For server: received from client via SNI callback
  17486. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17487. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17488. // (e.g. a response that arrived while this side was still in its post-write
  17489. // check), the byte is pushed back here and served by the next read().
  17490. unsigned char peeked_byte = 0;
  17491. bool has_peeked_byte = false;
  17492. // Set by set_sni() when the caller disabled hostname verification, so the
  17493. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17494. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17495. // OpenSSL and wolfSSL keep them independent).
  17496. bool suppress_hostname_mismatch = false;
  17497. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17498. // ever runs the callback of its own context.
  17499. VerifyCallback verify_callback;
  17500. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17501. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17502. MbedTlsSession(const MbedTlsSession &) = delete;
  17503. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17504. };
  17505. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17506. // queue)
  17507. inline int &mbedtls_last_error() {
  17508. static thread_local int err = 0;
  17509. return err;
  17510. }
  17511. // Helper to map Mbed TLS error to ErrorCode
  17512. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17513. uint32_t verify_flags) {
  17514. if (ret == 0) { return ErrorCode::Success; }
  17515. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17516. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17517. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17518. return ErrorCode::PeerClosed;
  17519. }
  17520. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17521. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17522. out_errno = errno;
  17523. return ErrorCode::SyscallError;
  17524. }
  17525. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17526. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17527. // the handshake's chain verification (see set_sni()); a mismatch there
  17528. // is reported the same way as any other verify_flags bit. Report it as
  17529. // HostnameMismatch, matching the other backends and the post-handshake
  17530. // identity check below, but only when naming is the sole problem -
  17531. // if the chain itself is also untrusted/expired/etc., that takes
  17532. // priority over the naming detail.
  17533. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17534. return ErrorCode::HostnameMismatch;
  17535. }
  17536. return ErrorCode::CertVerifyFailed;
  17537. }
  17538. return ErrorCode::Fatal;
  17539. }
  17540. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17541. // return value, including the verify-flags-dependent HostnameMismatch
  17542. // mapping; shared by connect() and connect_nonblocking() so the
  17543. // backend_code policy for that mapping only lives in one place.
  17544. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17545. int ret) {
  17546. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17547. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17548. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17549. ? static_cast<uint64_t>(verify_flags)
  17550. : static_cast<uint64_t>(-ret);
  17551. }
  17552. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17553. // non-fatal notification delivered between records, not an error and not
  17554. // application data, so I/O calls that see it should just be retried. Kept in
  17555. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17556. // splitting the closing brace across an #if.
  17557. inline bool mbedtls_is_session_ticket(int ret) {
  17558. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17559. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17560. #else
  17561. (void)ret;
  17562. return false;
  17563. #endif
  17564. }
  17565. // BIO-like send callback for Mbed TLS
  17566. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17567. size_t len) {
  17568. auto sock = *static_cast<socket_t *>(ctx);
  17569. #ifdef _WIN32
  17570. auto ret =
  17571. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17572. if (ret == SOCKET_ERROR) {
  17573. int err = WSAGetLastError();
  17574. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17575. return MBEDTLS_ERR_NET_SEND_FAILED;
  17576. }
  17577. #else
  17578. auto ret = send(sock, buf, len, 0);
  17579. if (ret < 0) {
  17580. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17581. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17582. }
  17583. return MBEDTLS_ERR_NET_SEND_FAILED;
  17584. }
  17585. #endif
  17586. return static_cast<int>(ret);
  17587. }
  17588. // BIO-like recv callback for Mbed TLS
  17589. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17590. auto sock = *static_cast<socket_t *>(ctx);
  17591. #ifdef _WIN32
  17592. auto ret =
  17593. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17594. if (ret == SOCKET_ERROR) {
  17595. int err = WSAGetLastError();
  17596. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17597. return MBEDTLS_ERR_NET_RECV_FAILED;
  17598. }
  17599. #else
  17600. auto ret = recv(sock, buf, len, 0);
  17601. if (ret < 0) {
  17602. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17603. return MBEDTLS_ERR_SSL_WANT_READ;
  17604. }
  17605. return MBEDTLS_ERR_NET_RECV_FAILED;
  17606. }
  17607. #endif
  17608. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17609. return static_cast<int>(ret);
  17610. }
  17611. // MbedTlsContext constructor/destructor implementations
  17612. inline MbedTlsContext::MbedTlsContext() {
  17613. mbedtls_ssl_config_init(&conf);
  17614. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17615. mbedtls_entropy_init(&entropy);
  17616. mbedtls_ctr_drbg_init(&ctr_drbg);
  17617. #endif
  17618. mbedtls_x509_crt_init(&ca_chain);
  17619. mbedtls_x509_crt_init(&own_cert);
  17620. mbedtls_pk_init(&own_key);
  17621. }
  17622. inline MbedTlsContext::~MbedTlsContext() {
  17623. mbedtls_pk_free(&own_key);
  17624. mbedtls_x509_crt_free(&own_cert);
  17625. mbedtls_x509_crt_free(&ca_chain);
  17626. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17627. mbedtls_ctr_drbg_free(&ctr_drbg);
  17628. mbedtls_entropy_free(&entropy);
  17629. #endif
  17630. mbedtls_ssl_config_free(&conf);
  17631. }
  17632. // Thread-local storage for SNI captured during handshake
  17633. // This is needed because the SNI callback doesn't have a way to pass
  17634. // session-specific data before the session is fully set up
  17635. inline std::string &mbedpending_sni() {
  17636. static thread_local std::string sni;
  17637. return sni;
  17638. }
  17639. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17640. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17641. const unsigned char *name, size_t name_len) {
  17642. (void)p_ctx;
  17643. (void)ssl;
  17644. // Store SNI name in thread-local storage
  17645. // It will be retrieved and stored in the session after handshake
  17646. if (name && name_len > 0) {
  17647. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17648. } else {
  17649. mbedpending_sni().clear();
  17650. }
  17651. return 0; // Accept any SNI
  17652. }
  17653. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17654. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17655. }
  17656. // Verify callback used when hostname verification is disabled for a session
  17657. // that has no user-supplied verify callback of its own.
  17658. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17659. mbedtls_x509_crt *, int,
  17660. uint32_t *flags) {
  17661. (void)data;
  17662. mbedtls_clear_cn_mismatch(flags);
  17663. return 0;
  17664. }
  17665. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17666. int cert_depth, uint32_t *flags);
  17667. // MbedTLS verify callback wrapper
  17668. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17669. int cert_depth, uint32_t *flags) {
  17670. // data points to the MbedTlsSession
  17671. auto *session = static_cast<MbedTlsSession *>(data);
  17672. // set_sni() disabled hostname verification for this session: drop the
  17673. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17674. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17675. // SNI. The final pass/fail decision still comes from the remaining flags
  17676. // (or, below, from the user's own verify callback).
  17677. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17678. // Build context
  17679. VerifyContext verify_ctx;
  17680. verify_ctx.session = static_cast<session_t>(session);
  17681. verify_ctx.cert = static_cast<cert_t>(crt);
  17682. verify_ctx.depth = cert_depth;
  17683. verify_ctx.preverify_ok = (*flags == 0);
  17684. verify_ctx.error_code = static_cast<long>(*flags);
  17685. // Convert Mbed TLS flags to error string
  17686. static thread_local char error_buf[256];
  17687. if (*flags != 0) {
  17688. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17689. verify_ctx.error_string = error_buf;
  17690. } else {
  17691. verify_ctx.error_string = nullptr;
  17692. }
  17693. bool accepted = session->verify_callback(verify_ctx);
  17694. if (accepted) {
  17695. *flags = 0; // Clear all error flags
  17696. return 0;
  17697. }
  17698. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17699. }
  17700. } // namespace impl
  17701. inline ctx_t create_client_context() {
  17702. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17703. if (!ctx) { return nullptr; }
  17704. ctx->is_server = false;
  17705. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17706. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17707. if (!detail::ensure_mbedtls_psa_crypto()) {
  17708. delete ctx;
  17709. return nullptr;
  17710. }
  17711. int ret;
  17712. #else
  17713. // Seed the random number generator
  17714. const char *pers = "httplib_client";
  17715. int ret = mbedtls_ctr_drbg_seed(
  17716. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17717. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17718. if (ret != 0) {
  17719. impl::mbedtls_last_error() = ret;
  17720. delete ctx;
  17721. return nullptr;
  17722. }
  17723. #endif
  17724. // Set up SSL config for client
  17725. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17726. MBEDTLS_SSL_TRANSPORT_STREAM,
  17727. MBEDTLS_SSL_PRESET_DEFAULT);
  17728. if (ret != 0) {
  17729. impl::mbedtls_last_error() = ret;
  17730. delete ctx;
  17731. return nullptr;
  17732. }
  17733. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17734. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17735. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17736. #endif
  17737. // Default: verify peer certificate
  17738. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17739. // Set minimum TLS version to 1.2
  17740. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17741. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17742. #else
  17743. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17744. MBEDTLS_SSL_MINOR_VERSION_3);
  17745. #endif
  17746. return static_cast<ctx_t>(ctx);
  17747. }
  17748. inline ctx_t create_server_context() {
  17749. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17750. if (!ctx) { return nullptr; }
  17751. ctx->is_server = true;
  17752. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17753. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17754. if (!detail::ensure_mbedtls_psa_crypto()) {
  17755. delete ctx;
  17756. return nullptr;
  17757. }
  17758. int ret;
  17759. #else
  17760. // Seed the random number generator
  17761. const char *pers = "httplib_server";
  17762. int ret = mbedtls_ctr_drbg_seed(
  17763. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17764. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17765. if (ret != 0) {
  17766. impl::mbedtls_last_error() = ret;
  17767. delete ctx;
  17768. return nullptr;
  17769. }
  17770. #endif
  17771. // Set up SSL config for server
  17772. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17773. MBEDTLS_SSL_TRANSPORT_STREAM,
  17774. MBEDTLS_SSL_PRESET_DEFAULT);
  17775. if (ret != 0) {
  17776. impl::mbedtls_last_error() = ret;
  17777. delete ctx;
  17778. return nullptr;
  17779. }
  17780. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17781. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17782. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17783. #endif
  17784. // Default: don't verify client
  17785. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17786. // Set minimum TLS version to 1.2
  17787. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17788. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17789. #else
  17790. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17791. MBEDTLS_SSL_MINOR_VERSION_3);
  17792. #endif
  17793. // Set SNI callback to capture client's SNI hostname
  17794. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17795. return static_cast<ctx_t>(ctx);
  17796. }
  17797. inline void free_context(ctx_t ctx) {
  17798. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17799. }
  17800. inline bool set_min_version(ctx_t ctx, Version version) {
  17801. if (!ctx) { return false; }
  17802. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17803. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17804. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17805. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17806. if (version >= Version::TLS1_3) {
  17807. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17808. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17809. #endif
  17810. }
  17811. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17812. #else
  17813. // Mbed TLS 2.x uses major/minor version numbers
  17814. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17815. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17816. if (version >= Version::TLS1_3) {
  17817. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17818. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17819. #else
  17820. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17821. #endif
  17822. }
  17823. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17824. #endif
  17825. return true;
  17826. }
  17827. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17828. if (!ctx || !pem) { return false; }
  17829. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17830. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17831. // Add null terminator if not present
  17832. std::string pem_str(pem, len);
  17833. int ret = mbedtls_x509_crt_parse(
  17834. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17835. pem_str.size() + 1);
  17836. if (ret != 0) {
  17837. impl::mbedtls_last_error() = ret;
  17838. return false;
  17839. }
  17840. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17841. return true;
  17842. }
  17843. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17844. if (!ctx || !file_path) { return false; }
  17845. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17846. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17847. if (ret != 0) {
  17848. impl::mbedtls_last_error() = ret;
  17849. return false;
  17850. }
  17851. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17852. return true;
  17853. }
  17854. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17855. if (!ctx || !dir_path) { return false; }
  17856. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17857. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17858. if (ret < 0) { // Returns number of certs on success, negative on error
  17859. impl::mbedtls_last_error() = ret;
  17860. return false;
  17861. }
  17862. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17863. return true;
  17864. }
  17865. inline bool load_system_certs(ctx_t ctx) {
  17866. if (!ctx) { return false; }
  17867. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17868. bool loaded = false;
  17869. #ifdef _WIN32
  17870. loaded = impl::enumerate_windows_system_certs(
  17871. [&](const unsigned char *data, size_t len) {
  17872. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17873. });
  17874. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17875. loaded = impl::enumerate_macos_keychain_certs(
  17876. [&](const unsigned char *data, size_t len) {
  17877. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17878. });
  17879. #else
  17880. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17881. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17882. loaded = true;
  17883. break;
  17884. }
  17885. }
  17886. if (!loaded) {
  17887. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17888. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17889. loaded = true;
  17890. break;
  17891. }
  17892. }
  17893. }
  17894. #endif
  17895. if (loaded) {
  17896. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17897. }
  17898. return loaded;
  17899. }
  17900. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17901. const char *password) {
  17902. if (!ctx || !cert || !key) { return false; }
  17903. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17904. // Parse certificate
  17905. std::string cert_str(cert);
  17906. int ret = mbedtls_x509_crt_parse(
  17907. &mctx->own_cert,
  17908. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17909. cert_str.size() + 1);
  17910. if (ret != 0) {
  17911. impl::mbedtls_last_error() = ret;
  17912. return false;
  17913. }
  17914. // Parse private key
  17915. std::string key_str(key);
  17916. const unsigned char *pwd =
  17917. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17918. size_t pwd_len = password ? strlen(password) : 0;
  17919. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17920. ret = mbedtls_pk_parse_key(
  17921. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17922. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17923. &mctx->ctr_drbg);
  17924. #else
  17925. ret = mbedtls_pk_parse_key(
  17926. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17927. key_str.size() + 1, pwd, pwd_len);
  17928. #endif
  17929. if (ret != 0) {
  17930. impl::mbedtls_last_error() = ret;
  17931. return false;
  17932. }
  17933. // Verify that the certificate and private key match.
  17934. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17935. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17936. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17937. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17938. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17939. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17940. #else
  17941. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17942. #endif
  17943. if (ret != 0) {
  17944. impl::mbedtls_last_error() = ret;
  17945. return false;
  17946. }
  17947. #endif
  17948. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17949. if (ret != 0) {
  17950. impl::mbedtls_last_error() = ret;
  17951. return false;
  17952. }
  17953. return true;
  17954. }
  17955. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17956. const char *key_path, const char *password) {
  17957. if (!ctx || !cert_path || !key_path) { return false; }
  17958. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17959. // Parse certificate file
  17960. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17961. if (ret != 0) {
  17962. impl::mbedtls_last_error() = ret;
  17963. return false;
  17964. }
  17965. // Parse private key file
  17966. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17967. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17968. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17969. #else
  17970. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17971. #endif
  17972. if (ret != 0) {
  17973. impl::mbedtls_last_error() = ret;
  17974. return false;
  17975. }
  17976. // Verify that the certificate and private key match.
  17977. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17978. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17979. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17980. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17981. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17982. #else
  17983. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17984. #endif
  17985. if (ret != 0) {
  17986. impl::mbedtls_last_error() = ret;
  17987. return false;
  17988. }
  17989. #endif
  17990. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17991. if (ret != 0) {
  17992. impl::mbedtls_last_error() = ret;
  17993. return false;
  17994. }
  17995. return true;
  17996. }
  17997. inline void set_verify_client(ctx_t ctx, bool require) {
  17998. if (!ctx) { return; }
  17999. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18000. mctx->verify_client = require;
  18001. if (require) {
  18002. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  18003. } else {
  18004. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  18005. // is called (matching OpenSSL behavior). Otherwise use NONE.
  18006. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->verify_callback
  18007. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  18008. : MBEDTLS_SSL_VERIFY_NONE);
  18009. }
  18010. }
  18011. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18012. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18013. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18014. auto session = new (std::nothrow) impl::MbedTlsSession();
  18015. if (!session) { return nullptr; }
  18016. session->sock = sock;
  18017. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18018. if (ret != 0) {
  18019. impl::mbedtls_last_error() = ret;
  18020. delete session;
  18021. return nullptr;
  18022. }
  18023. // Explicitly opt out of in-handshake hostname verification by default;
  18024. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18025. // fails outright when no hostname was set. set_sni() installs the real
  18026. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18027. // caller verifies the certificate identity post-handshake via
  18028. // verify_hostname().
  18029. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18030. // Set BIO callbacks
  18031. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18032. impl::mbedtls_net_recv_cb, nullptr);
  18033. // Set per-session verify callback with session pointer if callback is
  18034. // registered
  18035. session->verify_callback = mctx->verify_callback;
  18036. if (session->verify_callback) {
  18037. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  18038. session);
  18039. }
  18040. return static_cast<session_t>(session);
  18041. }
  18042. inline void free_session(session_t session) {
  18043. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18044. }
  18045. inline bool set_sni(session_t session, const char *hostname,
  18046. bool verify_hostname) {
  18047. if (!session || !hostname) { return false; }
  18048. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18049. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18050. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18051. // independently, so a disabled hostname check is handled below by masking
  18052. // the resulting mismatch flag instead of skipping this call.
  18053. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18054. if (ret != 0) {
  18055. impl::mbedtls_last_error() = ret;
  18056. return false;
  18057. }
  18058. msession->hostname = hostname;
  18059. if (!verify_hostname) {
  18060. msession->suppress_hostname_mismatch = true;
  18061. // If a user verify callback is already wired for this session,
  18062. // mbedtls_verify_callback() masks the mismatch flag itself before
  18063. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  18064. // here would be redundant. Otherwise install the masking callback alone.
  18065. if (!msession->verify_callback) {
  18066. mbedtls_ssl_set_verify(&msession->ssl,
  18067. impl::mbedtls_mask_hostname_mismatch_callback,
  18068. msession);
  18069. }
  18070. }
  18071. return true;
  18072. }
  18073. inline TlsError connect(session_t session) {
  18074. TlsError err;
  18075. if (!session) {
  18076. err.code = ErrorCode::Fatal;
  18077. return err;
  18078. }
  18079. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18080. int ret;
  18081. do {
  18082. ret = mbedtls_ssl_handshake(&msession->ssl);
  18083. } while (impl::mbedtls_is_session_ticket(ret));
  18084. if (ret == 0) {
  18085. err.code = ErrorCode::Success;
  18086. } else {
  18087. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18088. impl::mbedtls_last_error() = ret;
  18089. }
  18090. return err;
  18091. }
  18092. inline TlsError accept(session_t session) {
  18093. // Same as connect for Mbed TLS - handshake works for both client and server
  18094. auto result = connect(session);
  18095. // After successful handshake, capture SNI from thread-local storage
  18096. if (result.code == ErrorCode::Success && session) {
  18097. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18098. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18099. impl::mbedpending_sni().clear();
  18100. }
  18101. return result;
  18102. }
  18103. inline bool connect_nonblocking(session_t session, socket_t sock,
  18104. time_t timeout_sec, time_t timeout_usec,
  18105. TlsError *err) {
  18106. if (!session) {
  18107. if (err) { err->code = ErrorCode::Fatal; }
  18108. return false;
  18109. }
  18110. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18111. // Set socket to non-blocking mode
  18112. detail::set_nonblocking(sock, true);
  18113. auto cleanup =
  18114. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18115. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18116. int ret;
  18117. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18118. // Non-fatal TLS 1.3 ticket; retry immediately.
  18119. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18120. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18121. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18122. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18123. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18124. }
  18125. // TlsError or timeout
  18126. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18127. impl::mbedtls_last_error() = ret;
  18128. return false;
  18129. }
  18130. if (err) { err->code = ErrorCode::Success; }
  18131. return true;
  18132. }
  18133. inline bool accept_nonblocking(session_t session, socket_t sock,
  18134. time_t timeout_sec, time_t timeout_usec,
  18135. TlsError *err) {
  18136. // Same implementation as connect for Mbed TLS
  18137. bool result =
  18138. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18139. // After successful handshake, capture SNI from thread-local storage
  18140. if (result && session) {
  18141. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18142. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18143. impl::mbedpending_sni().clear();
  18144. }
  18145. return result;
  18146. }
  18147. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18148. if (!session || !buf) {
  18149. err.code = ErrorCode::Fatal;
  18150. return -1;
  18151. }
  18152. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18153. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18154. if (msession->has_peeked_byte) {
  18155. if (len == 0) { return 0; }
  18156. auto p = static_cast<unsigned char *>(buf);
  18157. p[0] = msession->peeked_byte;
  18158. msession->has_peeked_byte = false;
  18159. size_t n = 1;
  18160. // Top up with any already-decrypted bytes without risking a block.
  18161. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18162. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18163. if (extra > 0) { n += static_cast<size_t>(extra); }
  18164. }
  18165. err.code = ErrorCode::Success;
  18166. return static_cast<ssize_t>(n);
  18167. }
  18168. int ret;
  18169. do {
  18170. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18171. len);
  18172. } while (impl::mbedtls_is_session_ticket(ret));
  18173. if (ret > 0) {
  18174. err.code = ErrorCode::Success;
  18175. return static_cast<ssize_t>(ret);
  18176. }
  18177. if (ret == 0) {
  18178. err.code = ErrorCode::PeerClosed;
  18179. return 0;
  18180. }
  18181. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18182. err.backend_code = static_cast<uint64_t>(-ret);
  18183. impl::mbedtls_last_error() = ret;
  18184. // mbedTLS signals a clean close_notify via a negative error code rather
  18185. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18186. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18187. return -1;
  18188. }
  18189. inline ssize_t write(session_t session, const void *buf, size_t len,
  18190. TlsError &err) {
  18191. if (!session || !buf) {
  18192. err.code = ErrorCode::Fatal;
  18193. return -1;
  18194. }
  18195. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18196. int ret;
  18197. do {
  18198. ret = mbedtls_ssl_write(&msession->ssl,
  18199. static_cast<const unsigned char *>(buf), len);
  18200. } while (impl::mbedtls_is_session_ticket(ret));
  18201. if (ret > 0) {
  18202. err.code = ErrorCode::Success;
  18203. return static_cast<ssize_t>(ret);
  18204. }
  18205. if (ret == 0) {
  18206. err.code = ErrorCode::PeerClosed;
  18207. return 0;
  18208. }
  18209. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18210. err.backend_code = static_cast<uint64_t>(-ret);
  18211. impl::mbedtls_last_error() = ret;
  18212. return -1;
  18213. }
  18214. inline int pending(const_session_t session) {
  18215. if (!session) { return 0; }
  18216. auto msession =
  18217. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18218. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18219. (msession->has_peeked_byte ? 1 : 0);
  18220. }
  18221. inline void shutdown(session_t session, bool graceful) {
  18222. if (!session) { return; }
  18223. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18224. if (graceful) {
  18225. // Try to send close_notify, but don't block forever
  18226. int ret;
  18227. int attempts = 0;
  18228. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18229. attempts < 3) {
  18230. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18231. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18232. break;
  18233. }
  18234. attempts++;
  18235. }
  18236. }
  18237. }
  18238. inline bool is_peer_closed(session_t session, socket_t sock) {
  18239. if (!session || sock == INVALID_SOCKET) { return true; }
  18240. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18241. // Check if there's already decrypted or pushed-back data available.
  18242. // If so, the connection is definitely alive.
  18243. if (msession->has_peeked_byte ||
  18244. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18245. return false;
  18246. }
  18247. // Set socket to non-blocking to avoid blocking on read
  18248. detail::set_nonblocking(sock, true);
  18249. auto cleanup =
  18250. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18251. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18252. // on application data — e.g. a response that already arrived — push the
  18253. // byte back so the next read() delivers it instead of losing it.
  18254. unsigned char buf;
  18255. int ret;
  18256. do {
  18257. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18258. } while (impl::mbedtls_is_session_ticket(ret));
  18259. // If we got data or WANT_READ (would block), connection is alive
  18260. if (ret > 0) {
  18261. msession->peeked_byte = buf;
  18262. msession->has_peeked_byte = true;
  18263. return false;
  18264. }
  18265. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18266. // If we get a peer close notify or a connection reset, the peer is closed
  18267. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18268. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18269. }
  18270. inline cert_t get_peer_cert(const_session_t session) {
  18271. if (!session) { return nullptr; }
  18272. auto msession =
  18273. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18274. // Mbed TLS returns a pointer to the internal peer cert chain.
  18275. // WARNING: This pointer is only valid while the session is active.
  18276. // Do not use the certificate after calling free_session().
  18277. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18278. return const_cast<mbedtls_x509_crt *>(cert);
  18279. }
  18280. inline size_t get_peer_certs(const_session_t session,
  18281. std::vector<cert_t> &certs) {
  18282. certs.clear();
  18283. // Mbed TLS parses the whole received chain into a list headed by the peer
  18284. // certificate, owned by the session like get_peer_cert()'s result
  18285. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18286. crt && crt->raw.len > 0; crt = crt->next) {
  18287. certs.push_back(static_cast<cert_t>(crt));
  18288. }
  18289. return certs.size();
  18290. }
  18291. inline void free_cert(cert_t cert) {
  18292. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18293. // chain, so there is nothing to free. Callers still call this for the other
  18294. // backends.
  18295. (void)cert;
  18296. }
  18297. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18298. if (!cert || !hostname) { return false; }
  18299. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18300. std::string host_str(hostname);
  18301. // Check if hostname is an IP address (IPv4 or IPv6)
  18302. unsigned char ip_bytes[16];
  18303. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18304. auto is_ip = ip_len > 0;
  18305. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18306. // in buf.tag and the raw value in buf.p / buf.len.
  18307. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18308. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18309. const unsigned char *p = san->buf.p;
  18310. size_t len = san->buf.len;
  18311. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18312. if (is_ip) {
  18313. // For an IP host, only a matching iPAddress SAN of the same family
  18314. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18315. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18316. memcmp(p, ip_bytes, ip_len) == 0) {
  18317. return true;
  18318. }
  18319. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18320. std::string san_name(reinterpret_cast<const char *>(p), len);
  18321. if (detail::match_hostname(san_name, host_str)) { return true; }
  18322. }
  18323. san = san->next;
  18324. }
  18325. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18326. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18327. // the OpenSSL backend's X509_check_ip behaves the same way).
  18328. if (!is_ip) {
  18329. char cn[256];
  18330. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18331. if (ret > 0) {
  18332. std::string cn_str(cn);
  18333. // Look for "CN=" in the DN string
  18334. size_t cn_pos = cn_str.find("CN=");
  18335. if (cn_pos != std::string::npos) {
  18336. size_t start = cn_pos + 3;
  18337. size_t end = cn_str.find(',', start);
  18338. std::string cn_value =
  18339. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18340. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18341. }
  18342. }
  18343. }
  18344. return false;
  18345. }
  18346. inline uint64_t hostname_mismatch_code() {
  18347. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18348. }
  18349. inline long get_verify_result(const_session_t session) {
  18350. if (!session) { return -1; }
  18351. auto msession =
  18352. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18353. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18354. // Return 0 (X509_V_OK equivalent) if verification passed
  18355. return flags == 0 ? 0 : static_cast<long>(flags);
  18356. }
  18357. inline std::string get_cert_subject_cn(cert_t cert) {
  18358. if (!cert) return "";
  18359. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18360. // Find the CN in the subject
  18361. const mbedtls_x509_name *name = &x509->subject;
  18362. while (name != nullptr) {
  18363. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18364. return std::string(reinterpret_cast<const char *>(name->val.p),
  18365. name->val.len);
  18366. }
  18367. name = name->next;
  18368. }
  18369. return "";
  18370. }
  18371. inline std::string get_cert_issuer_name(cert_t cert) {
  18372. if (!cert) return "";
  18373. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18374. // Build a human-readable issuer name string
  18375. char buf[512];
  18376. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18377. if (ret < 0) return "";
  18378. return std::string(buf);
  18379. }
  18380. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18381. sans.clear();
  18382. if (!cert) return false;
  18383. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18384. // Parse the Subject Alternative Name extension
  18385. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18386. while (cur != nullptr) {
  18387. if (cur->buf.len > 0) {
  18388. const unsigned char *p = cur->buf.p;
  18389. size_t value_len = cur->buf.len;
  18390. SanEntry entry;
  18391. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18392. case MBEDTLS_X509_SAN_DNS_NAME:
  18393. entry.type = SanType::DNS;
  18394. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18395. break;
  18396. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18397. entry.type = SanType::IP;
  18398. if (value_len == 4) {
  18399. // IPv4
  18400. char buf[16];
  18401. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18402. entry.value = buf;
  18403. } else if (value_len == 16) {
  18404. // IPv6
  18405. char buf[64];
  18406. snprintf(buf, sizeof(buf),
  18407. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18408. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18409. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18410. p[10], p[11], p[12], p[13], p[14], p[15]);
  18411. entry.value = buf;
  18412. }
  18413. break;
  18414. case MBEDTLS_X509_SAN_RFC822_NAME:
  18415. entry.type = SanType::EMAIL;
  18416. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18417. break;
  18418. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18419. entry.type = SanType::URI;
  18420. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18421. break;
  18422. default: entry.type = SanType::OTHER; break;
  18423. }
  18424. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18425. }
  18426. cur = cur->next;
  18427. }
  18428. return true;
  18429. }
  18430. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18431. time_t &not_after) {
  18432. if (!cert) return false;
  18433. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18434. // Convert mbedtls_x509_time to time_t
  18435. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18436. struct tm tm_time = {};
  18437. tm_time.tm_year = t.year - 1900;
  18438. tm_time.tm_mon = t.mon - 1;
  18439. tm_time.tm_mday = t.day;
  18440. tm_time.tm_hour = t.hour;
  18441. tm_time.tm_min = t.min;
  18442. tm_time.tm_sec = t.sec;
  18443. #ifdef _WIN32
  18444. return _mkgmtime(&tm_time);
  18445. #else
  18446. return timegm(&tm_time);
  18447. #endif
  18448. };
  18449. not_before = to_time_t(x509->valid_from);
  18450. not_after = to_time_t(x509->valid_to);
  18451. return true;
  18452. }
  18453. inline std::string get_cert_serial(cert_t cert) {
  18454. if (!cert) return "";
  18455. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18456. // Convert serial number to hex string
  18457. std::string result;
  18458. result.reserve(x509->serial.len * 2);
  18459. for (size_t i = 0; i < x509->serial.len; i++) {
  18460. char hex[3];
  18461. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18462. result += hex;
  18463. }
  18464. return result;
  18465. }
  18466. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18467. if (!cert) return false;
  18468. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18469. if (!crt->raw.p || crt->raw.len == 0) return false;
  18470. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18471. return true;
  18472. }
  18473. inline const char *get_sni(const_session_t session) {
  18474. if (!session) return nullptr;
  18475. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18476. // For server: return SNI received from client during handshake
  18477. if (!msession->sni_hostname.empty()) {
  18478. return msession->sni_hostname.c_str();
  18479. }
  18480. // For client: return the hostname set via set_sni
  18481. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18482. return nullptr;
  18483. }
  18484. inline uint64_t peek_error() {
  18485. // Mbed TLS doesn't have an error queue, return the last error
  18486. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18487. }
  18488. inline uint64_t get_error() {
  18489. // Mbed TLS doesn't have an error queue, return and clear the last error
  18490. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18491. impl::mbedtls_last_error() = 0;
  18492. return err;
  18493. }
  18494. inline std::string error_string(uint64_t code) {
  18495. char buf[256];
  18496. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18497. return std::string(buf);
  18498. }
  18499. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18500. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18501. if (!ca_chain) { return nullptr; }
  18502. mbedtls_x509_crt_init(ca_chain);
  18503. // mbedtls_x509_crt_parse expects null-terminated PEM
  18504. int ret = mbedtls_x509_crt_parse(ca_chain,
  18505. reinterpret_cast<const unsigned char *>(pem),
  18506. len + 1); // +1 for null terminator
  18507. if (ret != 0) {
  18508. // Try without +1 in case PEM is already null-terminated
  18509. ret = mbedtls_x509_crt_parse(
  18510. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18511. if (ret != 0) {
  18512. mbedtls_x509_crt_free(ca_chain);
  18513. delete ca_chain;
  18514. return nullptr;
  18515. }
  18516. }
  18517. return static_cast<ca_store_t>(ca_chain);
  18518. }
  18519. inline void free_ca_store(ca_store_t store) {
  18520. if (store) {
  18521. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18522. mbedtls_x509_crt_free(ca_chain);
  18523. delete ca_chain;
  18524. }
  18525. }
  18526. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18527. if (!ctx || !store) { return false; }
  18528. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18529. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18530. // Free existing CA chain
  18531. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18532. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18533. // Copy the CA chain (deep copy)
  18534. // Parse from the raw data of the source cert
  18535. mbedtls_x509_crt *src = ca_chain;
  18536. while (src != nullptr) {
  18537. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18538. src->raw.len);
  18539. if (ret != 0) {
  18540. free_ca_store(store);
  18541. return false;
  18542. }
  18543. src = src->next;
  18544. }
  18545. // This function takes ownership of the store; the chain was deep-copied
  18546. // above, so release the source
  18547. free_ca_store(store);
  18548. // Update the SSL config to use the new CA chain
  18549. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18550. return true;
  18551. }
  18552. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18553. certs.clear();
  18554. if (!ctx) { return 0; }
  18555. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18556. // Owned by the context; see free_cert()
  18557. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18558. cert = cert->next) {
  18559. certs.push_back(static_cast<cert_t>(cert));
  18560. }
  18561. return certs.size();
  18562. }
  18563. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18564. std::vector<std::string> names;
  18565. if (!ctx) { return names; }
  18566. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18567. // Iterate through the CA chain
  18568. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18569. while (cert != nullptr && cert->raw.len > 0) {
  18570. char buf[512];
  18571. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18572. if (ret > 0) { names.push_back(buf); }
  18573. cert = cert->next;
  18574. }
  18575. return names;
  18576. }
  18577. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18578. const char *key_pem, const char *password) {
  18579. if (!ctx || !cert_pem || !key_pem) { return false; }
  18580. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18581. // Parse into new objects first, so that a bad pair leaves the old one in
  18582. // place, and swap them in after; the old ones are freed on the way out.
  18583. mbedtls_x509_crt cert;
  18584. mbedtls_pk_context key;
  18585. mbedtls_x509_crt_init(&cert);
  18586. mbedtls_pk_init(&key);
  18587. auto se = detail::scope_exit([&] {
  18588. mbedtls_x509_crt_free(&cert);
  18589. mbedtls_pk_free(&key);
  18590. });
  18591. // Parse certificate PEM
  18592. int ret = mbedtls_x509_crt_parse(
  18593. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18594. strlen(cert_pem) + 1);
  18595. if (ret != 0) {
  18596. impl::mbedtls_last_error() = ret;
  18597. return false;
  18598. }
  18599. // Parse private key PEM
  18600. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18601. ret = mbedtls_pk_parse_key(
  18602. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18603. strlen(key_pem) + 1,
  18604. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18605. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18606. &mbed_ctx->ctr_drbg);
  18607. #else
  18608. ret = mbedtls_pk_parse_key(
  18609. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18610. strlen(key_pem) + 1,
  18611. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18612. password ? strlen(password) : 0);
  18613. #endif
  18614. if (ret != 0) {
  18615. impl::mbedtls_last_error() = ret;
  18616. return false;
  18617. }
  18618. std::swap(mbed_ctx->own_cert, cert);
  18619. std::swap(mbed_ctx->own_key, key);
  18620. // Configure SSL to use the new certificate and key
  18621. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18622. &mbed_ctx->own_key);
  18623. if (ret != 0) {
  18624. impl::mbedtls_last_error() = ret;
  18625. return false;
  18626. }
  18627. return true;
  18628. }
  18629. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18630. if (!ctx || !ca_pem) { return false; }
  18631. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18632. // Parse into a new chain first, so that a bad one leaves the old in place
  18633. mbedtls_x509_crt chain;
  18634. mbedtls_x509_crt_init(&chain);
  18635. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18636. // Parse CA PEM
  18637. int ret = mbedtls_x509_crt_parse(
  18638. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18639. strlen(ca_pem) + 1);
  18640. if (ret != 0) {
  18641. impl::mbedtls_last_error() = ret;
  18642. return false;
  18643. }
  18644. std::swap(mbed_ctx->ca_chain, chain);
  18645. // Update SSL config to use new CA chain
  18646. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18647. return true;
  18648. }
  18649. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18650. if (!ctx) { return false; }
  18651. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18652. // create_session() hands each session its own copy to run.
  18653. mbed_ctx->verify_callback = std::move(callback);
  18654. if (mbed_ctx->verify_callback) {
  18655. // Set OPTIONAL mode to ensure callback is called even when verification
  18656. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18657. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18658. }
  18659. return true;
  18660. }
  18661. inline long get_verify_error(const_session_t session) {
  18662. if (!session) { return -1; }
  18663. auto *msession =
  18664. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18665. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18666. }
  18667. inline std::string verify_error_string(long error_code) {
  18668. if (error_code == 0) { return ""; }
  18669. char buf[256];
  18670. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18671. static_cast<uint32_t>(error_code));
  18672. // Remove trailing newline if present
  18673. std::string result(buf);
  18674. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18675. result.pop_back();
  18676. }
  18677. return result;
  18678. }
  18679. } // namespace tls
  18680. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18681. /*
  18682. * Group 10: TLS abstraction layer - wolfSSL backend
  18683. */
  18684. /*
  18685. * wolfSSL Backend Implementation
  18686. */
  18687. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18688. namespace tls {
  18689. namespace impl {
  18690. // wolfSSL session wrapper
  18691. struct WolfSSLSession {
  18692. WOLFSSL *ssl = nullptr;
  18693. socket_t sock = INVALID_SOCKET;
  18694. std::string hostname; // For client: set via set_sni
  18695. std::string sni_hostname; // For server: received from client via SNI callback
  18696. WolfSSLSession() = default;
  18697. ~WolfSSLSession() {
  18698. if (ssl) { wolfSSL_free(ssl); }
  18699. }
  18700. WolfSSLSession(const WolfSSLSession &) = delete;
  18701. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18702. };
  18703. // Thread-local error code accessor for wolfSSL
  18704. inline uint64_t &wolfssl_last_error() {
  18705. static thread_local uint64_t err = 0;
  18706. return err;
  18707. }
  18708. // Helper to map wolfSSL error to ErrorCode.
  18709. // ssl_error is the value from wolfSSL_get_error().
  18710. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18711. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18712. int &out_errno) {
  18713. switch (ssl_error) {
  18714. case SSL_ERROR_NONE: return ErrorCode::Success;
  18715. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18716. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18717. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18718. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18719. default:
  18720. if (ssl) {
  18721. // wolfSSL stores the low-level error code as a negative value.
  18722. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18723. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18724. if (low_err == DOMAIN_NAME_MISMATCH) {
  18725. return ErrorCode::HostnameMismatch;
  18726. }
  18727. // Check verify result to distinguish cert verification from generic SSL
  18728. // errors.
  18729. long vr = wolfSSL_get_verify_result(ssl);
  18730. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18731. }
  18732. return ErrorCode::Fatal;
  18733. }
  18734. }
  18735. // WolfSSLContext constructor/destructor implementations
  18736. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18737. inline WolfSSLContext::~WolfSSLContext() {
  18738. if (ctx) { wolfSSL_CTX_free(ctx); }
  18739. }
  18740. // Thread-local storage for SNI captured during handshake
  18741. inline std::string &wolfssl_pending_sni() {
  18742. static thread_local std::string sni;
  18743. return sni;
  18744. }
  18745. // SNI callback for wolfSSL server to capture client's SNI hostname
  18746. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18747. (void)ret;
  18748. (void)exArg;
  18749. void *name_data = nullptr;
  18750. unsigned short name_len =
  18751. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18752. if (name_data && name_len > 0) {
  18753. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18754. name_len);
  18755. } else {
  18756. wolfssl_pending_sni().clear();
  18757. }
  18758. return 0; // Continue regardless
  18759. }
  18760. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18761. // runs the verify callback of its own context.
  18762. inline int context_ex_data_index() {
  18763. static const auto index =
  18764. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18765. return index;
  18766. }
  18767. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18768. // other tls:: function takes.
  18769. inline int session_ex_data_index() {
  18770. static const auto index =
  18771. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18772. return index;
  18773. }
  18774. // wolfSSL verify callback wrapper
  18775. inline int wolfssl_verify_callback(int preverify_ok,
  18776. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18777. // Get the WOLFSSL object from the X509_STORE_CTX
  18778. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18779. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18780. if (!ssl) { return preverify_ok; }
  18781. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  18782. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  18783. if (!wctx || !wctx->verify_callback) { return preverify_ok; }
  18784. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18785. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18786. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18787. VerifyContext verify_ctx;
  18788. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  18789. verify_ctx.cert = static_cast<cert_t>(cert);
  18790. verify_ctx.depth = depth;
  18791. verify_ctx.preverify_ok = (preverify_ok != 0);
  18792. verify_ctx.error_code = static_cast<long>(err);
  18793. if (err != 0) {
  18794. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18795. } else {
  18796. verify_ctx.error_string = nullptr;
  18797. }
  18798. bool accepted = wctx->verify_callback(verify_ctx);
  18799. return accepted ? 1 : 0;
  18800. }
  18801. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18802. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18803. wolfSSL_CTX_set_default_passwd_cb(
  18804. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18805. auto *pwd = static_cast<const char *>(userdata);
  18806. if (!pwd) return 0;
  18807. auto len = static_cast<int>(strlen(pwd));
  18808. if (len > size) len = size;
  18809. memcpy(buf, pwd, static_cast<size_t>(len));
  18810. return len;
  18811. });
  18812. }
  18813. } // namespace impl
  18814. inline ctx_t create_client_context() {
  18815. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18816. if (!ctx) { return nullptr; }
  18817. ctx->is_server = false;
  18818. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18819. if (!method) {
  18820. delete ctx;
  18821. return nullptr;
  18822. }
  18823. ctx->ctx = wolfSSL_CTX_new(method);
  18824. if (!ctx->ctx ||
  18825. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18826. WOLFSSL_SUCCESS) {
  18827. delete ctx;
  18828. return nullptr;
  18829. }
  18830. // Default: verify peer certificate
  18831. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18832. return static_cast<ctx_t>(ctx);
  18833. }
  18834. inline ctx_t create_server_context() {
  18835. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18836. if (!ctx) { return nullptr; }
  18837. ctx->is_server = true;
  18838. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18839. if (!method) {
  18840. delete ctx;
  18841. return nullptr;
  18842. }
  18843. ctx->ctx = wolfSSL_CTX_new(method);
  18844. if (!ctx->ctx ||
  18845. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18846. WOLFSSL_SUCCESS) {
  18847. delete ctx;
  18848. return nullptr;
  18849. }
  18850. // Default: don't verify client
  18851. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18852. // Enable SNI on server
  18853. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18854. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18855. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18856. return static_cast<ctx_t>(ctx);
  18857. }
  18858. inline void free_context(ctx_t ctx) {
  18859. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18860. }
  18861. inline bool set_min_version(ctx_t ctx, Version version) {
  18862. if (!ctx) { return false; }
  18863. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18864. int min_ver = WOLFSSL_TLSV1_2;
  18865. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18866. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18867. }
  18868. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18869. if (!ctx || !pem) { return false; }
  18870. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18871. int ret = wolfSSL_CTX_load_verify_buffer(
  18872. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18873. static_cast<long>(len), SSL_FILETYPE_PEM);
  18874. if (ret != SSL_SUCCESS) {
  18875. impl::wolfssl_last_error() =
  18876. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18877. return false;
  18878. }
  18879. wctx->ca_pem_data_.append(pem, len);
  18880. return true;
  18881. }
  18882. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18883. if (!ctx || !file_path) { return false; }
  18884. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18885. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18886. if (ret != SSL_SUCCESS) {
  18887. impl::wolfssl_last_error() =
  18888. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18889. return false;
  18890. }
  18891. return true;
  18892. }
  18893. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18894. if (!ctx || !dir_path) { return false; }
  18895. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18896. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18897. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18898. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18899. // immediately. Return true even on failure since the CA file may have
  18900. // already been loaded, matching OpenSSL's lenient behavior.
  18901. (void)ret;
  18902. return true;
  18903. }
  18904. inline bool load_system_certs(ctx_t ctx) {
  18905. if (!ctx) { return false; }
  18906. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18907. bool loaded = false;
  18908. #ifdef _WIN32
  18909. loaded = impl::enumerate_windows_system_certs(
  18910. [&](const unsigned char *data, size_t len) {
  18911. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18912. static_cast<long>(len),
  18913. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18914. });
  18915. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18916. loaded = impl::enumerate_macos_keychain_certs(
  18917. [&](const unsigned char *data, size_t len) {
  18918. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18919. static_cast<long>(len),
  18920. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18921. });
  18922. #else
  18923. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18924. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18925. SSL_SUCCESS) {
  18926. loaded = true;
  18927. break;
  18928. }
  18929. }
  18930. if (!loaded) {
  18931. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18932. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18933. SSL_SUCCESS) {
  18934. loaded = true;
  18935. break;
  18936. }
  18937. }
  18938. }
  18939. #endif
  18940. return loaded;
  18941. }
  18942. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18943. const char *password) {
  18944. if (!ctx || !cert || !key) { return false; }
  18945. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18946. // Load certificate
  18947. int ret = wolfSSL_CTX_use_certificate_buffer(
  18948. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18949. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18950. if (ret != SSL_SUCCESS) {
  18951. impl::wolfssl_last_error() =
  18952. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18953. return false;
  18954. }
  18955. // Set password callback if password is provided
  18956. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18957. // Load private key
  18958. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18959. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18960. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18961. if (ret != SSL_SUCCESS) {
  18962. impl::wolfssl_last_error() =
  18963. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18964. return false;
  18965. }
  18966. // Verify that the certificate and private key match
  18967. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18968. }
  18969. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18970. const char *key_path, const char *password) {
  18971. if (!ctx || !cert_path || !key_path) { return false; }
  18972. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18973. // Load certificate file
  18974. int ret =
  18975. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18976. if (ret != SSL_SUCCESS) {
  18977. impl::wolfssl_last_error() =
  18978. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18979. return false;
  18980. }
  18981. // Set password callback if password is provided
  18982. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18983. // Load private key file
  18984. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18985. if (ret != SSL_SUCCESS) {
  18986. impl::wolfssl_last_error() =
  18987. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18988. return false;
  18989. }
  18990. // Verify that the certificate and private key match
  18991. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18992. }
  18993. inline void set_verify_client(ctx_t ctx, bool require) {
  18994. if (!ctx) { return; }
  18995. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18996. wctx->verify_client = require;
  18997. if (require) {
  18998. wolfSSL_CTX_set_verify(
  18999. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  19000. wctx->verify_callback ? impl::wolfssl_verify_callback : nullptr);
  19001. } else {
  19002. if (wctx->verify_callback) {
  19003. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19004. impl::wolfssl_verify_callback);
  19005. } else {
  19006. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  19007. }
  19008. }
  19009. }
  19010. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19011. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19012. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19013. auto session = new (std::nothrow) impl::WolfSSLSession();
  19014. if (!session) { return nullptr; }
  19015. session->sock = sock;
  19016. session->ssl = wolfSSL_new(wctx->ctx);
  19017. if (!session->ssl) {
  19018. impl::wolfssl_last_error() =
  19019. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19020. delete session;
  19021. return nullptr;
  19022. }
  19023. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19024. session) != WOLFSSL_SUCCESS) {
  19025. delete session;
  19026. return nullptr;
  19027. }
  19028. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19029. return static_cast<session_t>(session);
  19030. }
  19031. inline void free_session(session_t session) {
  19032. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19033. }
  19034. inline bool set_sni(session_t session, const char *hostname,
  19035. bool verify_hostname) {
  19036. if (!session || !hostname) { return false; }
  19037. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19038. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19039. static_cast<word16>(strlen(hostname)));
  19040. if (ret != WOLFSSL_SUCCESS) {
  19041. impl::wolfssl_last_error() =
  19042. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19043. return false;
  19044. }
  19045. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19046. // separately from the SNI extension sent above; skip it when hostname
  19047. // verification is disabled so only the chain is checked, matching OpenSSL.
  19048. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19049. wsession->hostname = hostname;
  19050. return true;
  19051. }
  19052. inline TlsError connect(session_t session) {
  19053. TlsError err;
  19054. if (!session) {
  19055. err.code = ErrorCode::Fatal;
  19056. return err;
  19057. }
  19058. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19059. int ret = wolfSSL_connect(wsession->ssl);
  19060. if (ret == SSL_SUCCESS) {
  19061. err.code = ErrorCode::Success;
  19062. } else {
  19063. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19064. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19065. err.backend_code = static_cast<uint64_t>(ssl_error);
  19066. impl::wolfssl_last_error() = err.backend_code;
  19067. }
  19068. return err;
  19069. }
  19070. inline TlsError accept(session_t session) {
  19071. TlsError err;
  19072. if (!session) {
  19073. err.code = ErrorCode::Fatal;
  19074. return err;
  19075. }
  19076. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19077. int ret = wolfSSL_accept(wsession->ssl);
  19078. if (ret == SSL_SUCCESS) {
  19079. err.code = ErrorCode::Success;
  19080. // Capture SNI from thread-local storage after successful handshake
  19081. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19082. impl::wolfssl_pending_sni().clear();
  19083. } else {
  19084. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19085. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19086. err.backend_code = static_cast<uint64_t>(ssl_error);
  19087. impl::wolfssl_last_error() = err.backend_code;
  19088. }
  19089. return err;
  19090. }
  19091. inline bool connect_nonblocking(session_t session, socket_t sock,
  19092. time_t timeout_sec, time_t timeout_usec,
  19093. TlsError *err) {
  19094. if (!session) {
  19095. if (err) { err->code = ErrorCode::Fatal; }
  19096. return false;
  19097. }
  19098. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19099. // Set socket to non-blocking mode
  19100. detail::set_nonblocking(sock, true);
  19101. auto cleanup =
  19102. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19103. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19104. int ret;
  19105. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19106. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19107. if (ssl_error == SSL_ERROR_WANT_READ) {
  19108. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19109. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19110. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19111. }
  19112. // Error or timeout
  19113. if (err) {
  19114. err->code =
  19115. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19116. err->backend_code = static_cast<uint64_t>(ssl_error);
  19117. }
  19118. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19119. return false;
  19120. }
  19121. if (err) { err->code = ErrorCode::Success; }
  19122. return true;
  19123. }
  19124. inline bool accept_nonblocking(session_t session, socket_t sock,
  19125. time_t timeout_sec, time_t timeout_usec,
  19126. TlsError *err) {
  19127. if (!session) {
  19128. if (err) { err->code = ErrorCode::Fatal; }
  19129. return false;
  19130. }
  19131. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19132. // Set socket to non-blocking mode
  19133. detail::set_nonblocking(sock, true);
  19134. auto cleanup =
  19135. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19136. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19137. int ret;
  19138. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19139. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19140. if (ssl_error == SSL_ERROR_WANT_READ) {
  19141. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19142. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19143. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19144. }
  19145. // Error or timeout
  19146. if (err) {
  19147. err->code =
  19148. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19149. err->backend_code = static_cast<uint64_t>(ssl_error);
  19150. }
  19151. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19152. return false;
  19153. }
  19154. if (err) { err->code = ErrorCode::Success; }
  19155. // Capture SNI from thread-local storage after successful handshake
  19156. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19157. impl::wolfssl_pending_sni().clear();
  19158. return true;
  19159. }
  19160. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19161. if (!session || !buf) {
  19162. err.code = ErrorCode::Fatal;
  19163. return -1;
  19164. }
  19165. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19166. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19167. if (ret > 0) {
  19168. err.code = ErrorCode::Success;
  19169. return static_cast<ssize_t>(ret);
  19170. }
  19171. if (ret == 0) {
  19172. err.code = ErrorCode::PeerClosed;
  19173. return 0;
  19174. }
  19175. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19176. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19177. err.backend_code = static_cast<uint64_t>(ssl_error);
  19178. impl::wolfssl_last_error() = err.backend_code;
  19179. return -1;
  19180. }
  19181. inline ssize_t write(session_t session, const void *buf, size_t len,
  19182. TlsError &err) {
  19183. if (!session || !buf) {
  19184. err.code = ErrorCode::Fatal;
  19185. return -1;
  19186. }
  19187. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19188. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19189. if (ret > 0) {
  19190. err.code = ErrorCode::Success;
  19191. return static_cast<ssize_t>(ret);
  19192. }
  19193. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19194. // Treat this as an error (return -1) so callers don't spin in a
  19195. // write loop adding zero to the offset.
  19196. if (ret == 0) {
  19197. err.code = ErrorCode::PeerClosed;
  19198. return -1;
  19199. }
  19200. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19201. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19202. err.backend_code = static_cast<uint64_t>(ssl_error);
  19203. impl::wolfssl_last_error() = err.backend_code;
  19204. return -1;
  19205. }
  19206. inline int pending(const_session_t session) {
  19207. if (!session) { return 0; }
  19208. auto wsession =
  19209. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19210. return wolfSSL_pending(wsession->ssl);
  19211. }
  19212. inline void shutdown(session_t session, bool graceful) {
  19213. if (!session) { return; }
  19214. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19215. if (graceful) {
  19216. int ret;
  19217. int attempts = 0;
  19218. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19219. attempts < 3) {
  19220. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19221. if (ssl_error != SSL_ERROR_WANT_READ &&
  19222. ssl_error != SSL_ERROR_WANT_WRITE) {
  19223. break;
  19224. }
  19225. attempts++;
  19226. }
  19227. } else {
  19228. wolfSSL_shutdown(wsession->ssl);
  19229. }
  19230. }
  19231. inline bool is_peer_closed(session_t session, socket_t sock) {
  19232. if (!session || sock == INVALID_SOCKET) { return true; }
  19233. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19234. // Check if there's already decrypted data available
  19235. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19236. // Set socket to non-blocking to avoid blocking on read
  19237. detail::set_nonblocking(sock, true);
  19238. auto cleanup =
  19239. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19240. // Peek 1 byte to check connection status without consuming data
  19241. unsigned char buf;
  19242. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19243. // If we got data or WANT_READ (would block), connection is alive
  19244. if (ret > 0) { return false; }
  19245. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19246. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19247. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19248. ret == 0;
  19249. }
  19250. inline cert_t get_peer_cert(const_session_t session) {
  19251. if (!session) { return nullptr; }
  19252. auto wsession =
  19253. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19254. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19255. return static_cast<cert_t>(cert);
  19256. }
  19257. inline size_t get_peer_certs(const_session_t session,
  19258. std::vector<cert_t> &certs) {
  19259. certs.clear();
  19260. if (!session) { return 0; }
  19261. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19262. #ifdef SESSION_CERTS
  19263. auto wsession =
  19264. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19265. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19266. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19267. for (int i = 0; i < count; i++) {
  19268. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19269. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19270. }
  19271. #endif
  19272. return certs.size();
  19273. }
  19274. inline void free_cert(cert_t cert) {
  19275. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19276. }
  19277. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19278. if (!cert || !hostname) { return false; }
  19279. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19280. std::string host_str(hostname);
  19281. // Check if hostname is an IP address (IPv4 or IPv6)
  19282. unsigned char ip_bytes[16];
  19283. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19284. auto is_ip = ip_len > 0;
  19285. // Check Subject Alternative Names
  19286. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19287. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19288. if (san_names) {
  19289. int san_count = wolfSSL_sk_num(san_names);
  19290. for (int i = 0; i < san_count; i++) {
  19291. auto *names =
  19292. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19293. if (!names) continue;
  19294. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19295. // DNS name
  19296. unsigned char *dns_name = nullptr;
  19297. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19298. if (dns_name && dns_len > 0) {
  19299. std::string san_name(reinterpret_cast<char *>(dns_name),
  19300. static_cast<size_t>(dns_len));
  19301. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19302. if (detail::match_hostname(san_name, host_str)) {
  19303. wolfSSL_sk_free(san_names);
  19304. return true;
  19305. }
  19306. }
  19307. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19308. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19309. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19310. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19311. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19312. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19313. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19314. wolfSSL_sk_free(san_names);
  19315. return true;
  19316. }
  19317. }
  19318. }
  19319. wolfSSL_sk_free(san_names);
  19320. }
  19321. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19322. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19323. // the OpenSSL backend's X509_check_ip behaves the same way).
  19324. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19325. if (subject) {
  19326. char cn[256] = {};
  19327. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19328. sizeof(cn));
  19329. if (cn_len > 0) {
  19330. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19331. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19332. }
  19333. }
  19334. return false;
  19335. }
  19336. inline uint64_t hostname_mismatch_code() {
  19337. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19338. }
  19339. inline long get_verify_result(const_session_t session) {
  19340. if (!session) { return -1; }
  19341. auto wsession =
  19342. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19343. long result = wolfSSL_get_verify_result(wsession->ssl);
  19344. return result;
  19345. }
  19346. inline std::string get_cert_subject_cn(cert_t cert) {
  19347. if (!cert) return "";
  19348. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19349. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19350. if (!subject) return "";
  19351. char cn[256] = {};
  19352. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19353. sizeof(cn));
  19354. if (cn_len <= 0) return "";
  19355. return std::string(cn, static_cast<size_t>(cn_len));
  19356. }
  19357. inline std::string get_cert_issuer_name(cert_t cert) {
  19358. if (!cert) return "";
  19359. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19360. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19361. if (!issuer) return "";
  19362. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19363. if (!name_str) return "";
  19364. std::string result(name_str);
  19365. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19366. return result;
  19367. }
  19368. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19369. sans.clear();
  19370. if (!cert) return false;
  19371. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19372. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19373. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19374. if (!san_names) return true; // No SANs is not an error
  19375. int count = wolfSSL_sk_num(san_names);
  19376. for (int i = 0; i < count; i++) {
  19377. auto *name =
  19378. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19379. if (!name) continue;
  19380. SanEntry entry;
  19381. switch (name->type) {
  19382. case WOLFSSL_GEN_DNS: {
  19383. entry.type = SanType::DNS;
  19384. unsigned char *dns_name = nullptr;
  19385. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19386. if (dns_name && dns_len > 0) {
  19387. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19388. static_cast<size_t>(dns_len));
  19389. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19390. }
  19391. break;
  19392. }
  19393. case WOLFSSL_GEN_IPADD: {
  19394. entry.type = SanType::IP;
  19395. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19396. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19397. if (ip_data && ip_len == 4) {
  19398. char buf[16];
  19399. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19400. ip_data[2], ip_data[3]);
  19401. entry.value = buf;
  19402. } else if (ip_data && ip_len == 16) {
  19403. char buf[64];
  19404. snprintf(buf, sizeof(buf),
  19405. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19406. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19407. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19408. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19409. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19410. ip_data[14], ip_data[15]);
  19411. entry.value = buf;
  19412. }
  19413. break;
  19414. }
  19415. case WOLFSSL_GEN_EMAIL:
  19416. entry.type = SanType::EMAIL;
  19417. {
  19418. unsigned char *email = nullptr;
  19419. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19420. if (email && email_len > 0) {
  19421. entry.value = std::string(reinterpret_cast<char *>(email),
  19422. static_cast<size_t>(email_len));
  19423. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19424. }
  19425. }
  19426. break;
  19427. case WOLFSSL_GEN_URI:
  19428. entry.type = SanType::URI;
  19429. {
  19430. unsigned char *uri = nullptr;
  19431. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19432. &uri, name->d.uniformResourceIdentifier);
  19433. if (uri && uri_len > 0) {
  19434. entry.value = std::string(reinterpret_cast<char *>(uri),
  19435. static_cast<size_t>(uri_len));
  19436. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19437. }
  19438. }
  19439. break;
  19440. default: entry.type = SanType::OTHER; break;
  19441. }
  19442. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19443. }
  19444. wolfSSL_sk_free(san_names);
  19445. return true;
  19446. }
  19447. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19448. time_t &not_after) {
  19449. if (!cert) return false;
  19450. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19451. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19452. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19453. if (!nb || !na) return false;
  19454. // wolfSSL_ASN1_TIME_to_tm is available
  19455. struct tm tm_nb = {}, tm_na = {};
  19456. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19457. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19458. #ifdef _WIN32
  19459. not_before = _mkgmtime(&tm_nb);
  19460. not_after = _mkgmtime(&tm_na);
  19461. #else
  19462. not_before = timegm(&tm_nb);
  19463. not_after = timegm(&tm_na);
  19464. #endif
  19465. return true;
  19466. }
  19467. inline std::string get_cert_serial(cert_t cert) {
  19468. if (!cert) return "";
  19469. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19470. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19471. if (!serial_asn1) return "";
  19472. // Get the serial number data
  19473. int len = serial_asn1->length;
  19474. unsigned char *data = serial_asn1->data;
  19475. if (!data || len <= 0) return "";
  19476. std::string result;
  19477. result.reserve(static_cast<size_t>(len) * 2);
  19478. for (int i = 0; i < len; i++) {
  19479. char hex[3];
  19480. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19481. result += hex;
  19482. }
  19483. return result;
  19484. }
  19485. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19486. if (!cert) return false;
  19487. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19488. int der_len = 0;
  19489. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19490. if (!der_data || der_len <= 0) return false;
  19491. der.assign(der_data, der_data + der_len);
  19492. return true;
  19493. }
  19494. inline const char *get_sni(const_session_t session) {
  19495. if (!session) return nullptr;
  19496. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19497. // For server: return SNI received from client during handshake
  19498. if (!wsession->sni_hostname.empty()) {
  19499. return wsession->sni_hostname.c_str();
  19500. }
  19501. // For client: return the hostname set via set_sni
  19502. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19503. return nullptr;
  19504. }
  19505. inline uint64_t peek_error() {
  19506. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19507. }
  19508. inline uint64_t get_error() {
  19509. uint64_t err = impl::wolfssl_last_error();
  19510. impl::wolfssl_last_error() = 0;
  19511. return err;
  19512. }
  19513. inline std::string error_string(uint64_t code) {
  19514. char buf[256];
  19515. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19516. return std::string(buf);
  19517. }
  19518. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19519. if (!pem || len == 0) { return nullptr; }
  19520. // Validate by attempting to load into a temporary ctx
  19521. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19522. if (!tmp_ctx) { return nullptr; }
  19523. int ret = wolfSSL_CTX_load_verify_buffer(
  19524. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19525. static_cast<long>(len), SSL_FILETYPE_PEM);
  19526. wolfSSL_CTX_free(tmp_ctx);
  19527. if (ret != SSL_SUCCESS) { return nullptr; }
  19528. return static_cast<ca_store_t>(
  19529. new impl::WolfSSLCAStore{std::string(pem, len)});
  19530. }
  19531. inline void free_ca_store(ca_store_t store) {
  19532. delete static_cast<impl::WolfSSLCAStore *>(store);
  19533. }
  19534. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19535. if (!ctx || !store) { return false; }
  19536. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19537. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19538. int ret = wolfSSL_CTX_load_verify_buffer(
  19539. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19540. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19541. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19542. // This function takes ownership of the store; the PEM data was copied into
  19543. // the context, so release the source
  19544. free_ca_store(store);
  19545. return ret == SSL_SUCCESS;
  19546. }
  19547. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19548. certs.clear();
  19549. if (!ctx) { return 0; }
  19550. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19551. if (wctx->ca_pem_data_.empty()) { return 0; }
  19552. const std::string &pem = wctx->ca_pem_data_;
  19553. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19554. const std::string end_marker = "-----END CERTIFICATE-----";
  19555. size_t pos = 0;
  19556. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19557. size_t end_pos = pem.find(end_marker, pos);
  19558. if (end_pos == std::string::npos) { break; }
  19559. end_pos += end_marker.size();
  19560. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19561. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19562. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19563. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19564. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19565. pos = end_pos;
  19566. }
  19567. return certs.size();
  19568. }
  19569. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19570. std::vector<std::string> names;
  19571. if (!ctx) { return names; }
  19572. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19573. if (wctx->ca_pem_data_.empty()) { return names; }
  19574. const std::string &pem = wctx->ca_pem_data_;
  19575. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19576. const std::string end_marker = "-----END CERTIFICATE-----";
  19577. size_t pos = 0;
  19578. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19579. size_t end_pos = pem.find(end_marker, pos);
  19580. if (end_pos == std::string::npos) { break; }
  19581. end_pos += end_marker.size();
  19582. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19583. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19584. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19585. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19586. if (x509) {
  19587. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19588. if (subject) {
  19589. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19590. if (name_str) {
  19591. names.push_back(name_str);
  19592. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19593. }
  19594. }
  19595. wolfSSL_X509_free(x509);
  19596. }
  19597. pos = end_pos;
  19598. }
  19599. return names;
  19600. }
  19601. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19602. const char *key_pem, const char *password) {
  19603. if (!ctx || !cert_pem || !key_pem) { return false; }
  19604. // Try the pair on a scratch context first, so that a bad one leaves the
  19605. // server's certificate and key as they were
  19606. auto tmp = create_server_context();
  19607. if (!tmp) { return false; }
  19608. auto se = detail::scope_exit([&] { free_context(tmp); });
  19609. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19610. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19611. }
  19612. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19613. if (!ctx || !ca_pem) { return false; }
  19614. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19615. // Replace the CAs rather than add to them, as the other backends do, once
  19616. // the new ones are known to load
  19617. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19618. if (!store) { return false; }
  19619. free_ca_store(store);
  19620. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19621. wctx->ca_pem_data_.clear();
  19622. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19623. }
  19624. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19625. if (!ctx) { return false; }
  19626. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19627. wctx->verify_callback = std::move(callback);
  19628. if (wctx->verify_callback) {
  19629. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19630. impl::wolfssl_verify_callback);
  19631. } else {
  19632. wolfSSL_CTX_set_verify(
  19633. wctx->ctx,
  19634. wctx->verify_client
  19635. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19636. : SSL_VERIFY_NONE,
  19637. nullptr);
  19638. }
  19639. return true;
  19640. }
  19641. inline long get_verify_error(const_session_t session) {
  19642. if (!session) { return -1; }
  19643. auto *wsession =
  19644. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19645. return wolfSSL_get_verify_result(wsession->ssl);
  19646. }
  19647. inline std::string verify_error_string(long error_code) {
  19648. if (error_code == 0) { return ""; }
  19649. const char *str =
  19650. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19651. return str ? std::string(str) : std::string();
  19652. }
  19653. } // namespace tls
  19654. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19655. // WebSocket implementation
  19656. namespace ws {
  19657. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19658. bool fin) {
  19659. std::lock_guard<std::mutex> lock(write_mutex_);
  19660. if (closed_) { return false; }
  19661. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19662. }
  19663. inline ReadResult WebSocket::read(std::string &msg) {
  19664. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is malformed,
  19665. // which is answered with a protocol error instead.
  19666. auto answer_close = [&](const std::string &payload) {
  19667. if (closed_.exchange(true)) { return; }
  19668. auto reply = payload;
  19669. if (!impl::is_valid_close_payload(payload)) {
  19670. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19671. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19672. }
  19673. std::lock_guard<std::mutex> lock(write_mutex_);
  19674. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19675. reply.size(), true, !is_server_);
  19676. };
  19677. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19678. while (!closed_) {
  19679. Opcode opcode;
  19680. std::string payload;
  19681. bool fin;
  19682. impl::FrameRead r =
  19683. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19684. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19685. // A timeout landed on a frame boundary: the connection is untouched and
  19686. // still usable, so hand control back without closing it. That is only
  19687. // useful to a caller who asked for the timeout; the compile-time default
  19688. // is a backstop against a peer gone quiet, and elapsing it closes the
  19689. // connection so a plain `while (ws.read(msg))` loop ends.
  19690. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19691. if (r != impl::FrameRead::Ok) {
  19692. closed_ = true;
  19693. return Fail;
  19694. }
  19695. switch (opcode) {
  19696. case Opcode::Ping: {
  19697. std::lock_guard<std::mutex> lock(write_mutex_);
  19698. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19699. payload.size(), true, !is_server_);
  19700. continue;
  19701. }
  19702. case Opcode::Pong: {
  19703. std::lock_guard<std::mutex> lock(ping_mutex_);
  19704. unacked_pings_ = 0;
  19705. continue;
  19706. }
  19707. case Opcode::Close: {
  19708. answer_close(payload);
  19709. return Fail;
  19710. }
  19711. case Opcode::Text:
  19712. case Opcode::Binary: {
  19713. auto result = opcode == Opcode::Text ? Text : Binary;
  19714. msg = std::move(payload);
  19715. // Handle fragmentation
  19716. if (!fin) {
  19717. while (true) {
  19718. Opcode cont_opcode;
  19719. std::string cont_payload;
  19720. bool cont_fin;
  19721. // Only what is left of the limit, but room for a control frame,
  19722. // which may come between the fragments.
  19723. auto max_len =
  19724. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19725. ? size_t(0)
  19726. : (std::max)(size_t(125),
  19727. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19728. msg.size());
  19729. // A timeout is not reportable here: half of a fragmented message is
  19730. // already in `msg` and read() has no way to resume it, so it is a
  19731. // failure like any other. Timeouts are only ever seen on a message
  19732. // boundary.
  19733. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19734. cont_fin, is_server_,
  19735. max_len) != impl::FrameRead::Ok) {
  19736. closed_ = true;
  19737. return Fail;
  19738. }
  19739. if (cont_opcode == Opcode::Ping) {
  19740. std::lock_guard<std::mutex> lock(write_mutex_);
  19741. detail::write_websocket_frame(
  19742. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19743. true, !is_server_);
  19744. continue;
  19745. }
  19746. if (cont_opcode == Opcode::Pong) {
  19747. std::lock_guard<std::mutex> lock(ping_mutex_);
  19748. unacked_pings_ = 0;
  19749. continue;
  19750. }
  19751. if (cont_opcode == Opcode::Close) {
  19752. answer_close(cont_payload);
  19753. return Fail;
  19754. }
  19755. // RFC 6455: continuation frames must use opcode 0x0
  19756. if (cont_opcode != Opcode::Continuation) {
  19757. closed_ = true;
  19758. return Fail;
  19759. }
  19760. msg += cont_payload;
  19761. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19762. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19763. closed_ = true;
  19764. return Fail;
  19765. }
  19766. if (cont_fin) { break; }
  19767. }
  19768. }
  19769. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19770. if (result == Text && !impl::is_valid_utf8(msg)) {
  19771. // close() takes the read lock to wait for the peer's Close reply, so
  19772. // it must not run while this thread still holds it.
  19773. read_lock.unlock();
  19774. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19775. return Fail;
  19776. }
  19777. return result;
  19778. }
  19779. default: closed_ = true; return Fail;
  19780. }
  19781. }
  19782. return Fail;
  19783. }
  19784. inline bool WebSocket::send(const std::string &data) {
  19785. return send_frame(Opcode::Text, data.data(), data.size());
  19786. }
  19787. inline bool WebSocket::send(const char *data, size_t len) {
  19788. return send_frame(Opcode::Binary, data, len);
  19789. }
  19790. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19791. if (closed_.exchange(true)) { return; }
  19792. ping_cv_.notify_all();
  19793. std::string payload;
  19794. auto code = static_cast<uint16_t>(status);
  19795. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19796. payload.push_back(static_cast<char>(code & 0xFF));
  19797. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19798. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  19799. // cut back to a whole UTF-8 character
  19800. auto short_reason = reason.substr(0, 123);
  19801. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  19802. short_reason.pop_back();
  19803. }
  19804. payload += short_reason;
  19805. // A code that may not be sent, such as NoStatus, goes without a payload
  19806. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  19807. {
  19808. std::lock_guard<std::mutex> lock(write_mutex_);
  19809. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19810. payload.size(), true, !is_server_);
  19811. }
  19812. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19813. // Close response before closing the TCP connection.
  19814. //
  19815. // Wait only when no other thread is parsing frames. When one is, it is the
  19816. // thread positioned to see the peer's reply, and reading here would take
  19817. // bytes out of the message it is assembling. Bailing out also leaves the
  19818. // stream, including its read timeout, entirely to that thread.
  19819. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19820. if (!read_lock.owns_lock()) { return; }
  19821. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19822. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19823. Opcode op;
  19824. std::string resp;
  19825. bool fin;
  19826. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19827. impl::FrameRead::Ok) {
  19828. if (op == Opcode::Close) { break; }
  19829. }
  19830. }
  19831. inline WebSocket::~WebSocket() {
  19832. {
  19833. std::lock_guard<std::mutex> lock(ping_mutex_);
  19834. closed_ = true;
  19835. }
  19836. ping_cv_.notify_all();
  19837. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19838. }
  19839. inline void WebSocket::start_heartbeat() {
  19840. if (ping_interval_sec_ == 0) { return; }
  19841. ping_thread_ = std::thread([this]() {
  19842. std::unique_lock<std::mutex> lock(ping_mutex_);
  19843. // The predicate keeps a spurious wakeup from sending a ping early
  19844. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19845. [this]() { return closed_.load(); })) {
  19846. // If the peer has failed to respond to the previous pings, give up.
  19847. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19848. // opt-in liveness check controlled by max_missed_pongs_.
  19849. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19850. lock.unlock();
  19851. close(CloseStatus::GoingAway, "pong timeout");
  19852. // Wake a read() blocked on the unresponsive peer. Only the read side
  19853. // is shut down: a TLS backend answers the EOF with an alert, and
  19854. // writing it to a socket closed for writing raises SIGPIPE.
  19855. #ifdef _WIN32
  19856. shutdown(strm_.socket(), SD_RECEIVE);
  19857. #else
  19858. shutdown(strm_.socket(), SHUT_RD);
  19859. #endif
  19860. return;
  19861. }
  19862. lock.unlock();
  19863. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19864. lock.lock();
  19865. closed_ = true;
  19866. break;
  19867. }
  19868. lock.lock();
  19869. unacked_pings_++;
  19870. }
  19871. });
  19872. }
  19873. inline const Request &WebSocket::request() const { return req_; }
  19874. inline bool WebSocket::is_open() const { return !closed_; }
  19875. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19876. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19877. // poll(), where 0 would instead mean "return immediately", so hand it the
  19878. // negative poll uses for an unbounded wait.
  19879. if (sec == 0 && usec == 0) { sec = -1; }
  19880. strm_.set_read_timeout(sec, usec);
  19881. read_timeout_set_ = true;
  19882. }
  19883. // WebSocketClient implementation
  19884. inline WebSocketClient::WebSocketClient(
  19885. const std::string &scheme_host_port_path, const Headers &headers)
  19886. : headers_(headers) {
  19887. detail::UrlComponents uc;
  19888. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19889. !uc.host.empty() && !uc.path.empty()) {
  19890. auto &scheme = uc.scheme;
  19891. #ifdef CPPHTTPLIB_SSL_ENABLED
  19892. if (scheme != "ws" && scheme != "wss") {
  19893. #else
  19894. if (scheme != "ws") {
  19895. #endif
  19896. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19897. std::string msg = "'" + scheme + "' scheme is not supported.";
  19898. throw std::invalid_argument(msg);
  19899. #endif
  19900. return;
  19901. }
  19902. auto is_ssl = scheme == "wss";
  19903. host_ = std::move(uc.host);
  19904. port_ = is_ssl ? 443 : 80;
  19905. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19906. path_ = std::move(uc.path);
  19907. if (!uc.query.empty()) { path_ += uc.query; }
  19908. #ifdef CPPHTTPLIB_SSL_ENABLED
  19909. is_ssl_ = is_ssl;
  19910. if (is_ssl_) {
  19911. // The context lives as long as the client so that CA configuration
  19912. // survives reconnects; sessions are created per connection.
  19913. tls_ctx_ = tls::create_client_context();
  19914. if (!tls_ctx_) { return; }
  19915. }
  19916. #else
  19917. if (is_ssl) { return; }
  19918. #endif
  19919. is_valid_ = true;
  19920. }
  19921. }
  19922. #ifdef CPPHTTPLIB_SSL_ENABLED
  19923. inline WebSocketClient::WebSocketClient(
  19924. const std::string &scheme_host_port_path, const PemMemory &pem,
  19925. const Headers &headers)
  19926. : WebSocketClient(scheme_host_port_path, headers) {
  19927. // For ws:// URLs the client certificate is silently ignored, consistent
  19928. // with the TLS-only setters such as set_ca_cert_path().
  19929. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19930. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19931. pem.private_key_password)) {
  19932. tls::free_context(tls_ctx_);
  19933. tls_ctx_ = nullptr;
  19934. is_valid_ = false;
  19935. }
  19936. }
  19937. }
  19938. #endif
  19939. inline WebSocketClient::~WebSocketClient() {
  19940. shutdown_and_close();
  19941. #ifdef CPPHTTPLIB_SSL_ENABLED
  19942. if (tls_ctx_) {
  19943. tls::free_context(tls_ctx_);
  19944. tls_ctx_ = nullptr;
  19945. }
  19946. #endif
  19947. }
  19948. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19949. inline void WebSocketClient::shutdown_and_close() {
  19950. // Send the close frame while the TLS session is still alive: ws_ holds an
  19951. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19952. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19953. if (ws_ && ws_->is_open()) { ws_->close(); }
  19954. ws_.reset();
  19955. #ifdef CPPHTTPLIB_SSL_ENABLED
  19956. if (is_ssl_) {
  19957. if (tls_session_) {
  19958. tls::shutdown(tls_session_, true);
  19959. tls::free_session(tls_session_);
  19960. tls_session_ = nullptr;
  19961. }
  19962. }
  19963. #endif
  19964. if (sock_ != INVALID_SOCKET) {
  19965. detail::shutdown_socket(sock_);
  19966. detail::close_socket(sock_);
  19967. sock_ = INVALID_SOCKET;
  19968. }
  19969. }
  19970. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19971. Error &error, int &ssl_error,
  19972. uint64_t &ssl_backend_error) {
  19973. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19974. // The streams wait with poll(), where 0 instead means "return immediately",
  19975. // so they are given the negative poll uses for an unbounded wait.
  19976. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19977. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19978. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19979. // The handshake belongs to establishing the connection, so an unset read
  19980. // timeout leaves it bounded by the connection timeout instead of forever.
  19981. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19982. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19983. #ifdef CPPHTTPLIB_SSL_ENABLED
  19984. if (is_ssl_) {
  19985. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19986. // is not safe to call concurrently on one client to begin with, since
  19987. // nothing else here is guarded either.
  19988. if (server_certificate_verification_ && !certs_loaded_) {
  19989. uint64_t backend_error = 0;
  19990. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19991. ca_cert_dir_path_, custom_ca_loaded_,
  19992. system_ca_mode_, backend_error);
  19993. certs_loaded_ = true;
  19994. }
  19995. detail::ClientTlsSessionOptions options;
  19996. options.server_hostname_verification = server_hostname_verification_;
  19997. options.session_verifier = session_verifier_;
  19998. detail::ClientTlsSessionError tls_error;
  19999. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20000. server_certificate_verification_,
  20001. hs_sec, hs_usec, &tls_error,
  20002. options)) {
  20003. error = tls_error.error;
  20004. ssl_error = tls_error.ssl_error;
  20005. ssl_backend_error = tls_error.backend_error;
  20006. return false;
  20007. }
  20008. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20009. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20010. write_timeout_usec_));
  20011. return true;
  20012. }
  20013. #else
  20014. (void)error;
  20015. (void)ssl_error;
  20016. (void)ssl_backend_error;
  20017. (void)hs_sec;
  20018. (void)hs_usec;
  20019. #endif
  20020. strm = std::unique_ptr<Stream>(
  20021. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20022. write_timeout_sec_, write_timeout_usec_));
  20023. return true;
  20024. }
  20025. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20026. #ifdef CPPHTTPLIB_SSL_ENABLED
  20027. auto is_ssl = is_ssl_;
  20028. #else
  20029. auto is_ssl = false;
  20030. #endif
  20031. if (!req.has_header("Host")) {
  20032. req.headers.emplace("Host", detail::make_default_host_header_value(
  20033. host_, port_, is_ssl, address_family_));
  20034. }
  20035. detail::add_default_user_agent_header(req);
  20036. }
  20037. inline Result WebSocketClient::connect() {
  20038. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20039. shutdown_and_close();
  20040. // Check is custom IP or hostname specified for host_
  20041. std::string connect_host;
  20042. std::string ip;
  20043. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20044. auto error = Error::Success;
  20045. sock_ = detail::create_client_socket(
  20046. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  20047. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20048. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20049. write_timeout_usec_, interface_, error);
  20050. if (sock_ == INVALID_SOCKET) {
  20051. if (error == Error::Success) { error = Error::Connection; }
  20052. return Result{error, -1, Headers{}};
  20053. }
  20054. std::unique_ptr<Stream> strm;
  20055. auto stream_error = Error::SSLConnection;
  20056. int ssl_error = 0;
  20057. uint64_t ssl_backend_error = 0;
  20058. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20059. shutdown_and_close();
  20060. #ifdef CPPHTTPLIB_SSL_ENABLED
  20061. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20062. #else
  20063. return Result{stream_error, -1, Headers{}};
  20064. #endif
  20065. }
  20066. Request req;
  20067. req.method = "GET";
  20068. req.path = path_;
  20069. req.headers = headers_;
  20070. prepare_default_headers(req);
  20071. detail::WebSocketUpgradeResponse upgrade;
  20072. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20073. shutdown_and_close();
  20074. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20075. }
  20076. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20077. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20078. websocket_ping_interval_sec_,
  20079. websocket_max_missed_pongs_));
  20080. // The stream was created with the timeout already; tell the WebSocket
  20081. // whether it came from the caller, so read() knows to report it as Timeout.
  20082. ws_->read_timeout_set_ = read_timeout_set_;
  20083. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20084. }
  20085. inline ReadResult WebSocketClient::read(std::string &msg) {
  20086. if (!ws_) { return Fail; }
  20087. return ws_->read(msg);
  20088. }
  20089. inline bool WebSocketClient::send(const std::string &data) {
  20090. if (!ws_) { return false; }
  20091. return ws_->send(data);
  20092. }
  20093. inline bool WebSocketClient::send(const char *data, size_t len) {
  20094. if (!ws_) { return false; }
  20095. return ws_->send(data, len);
  20096. }
  20097. inline void WebSocketClient::close(CloseStatus status,
  20098. const std::string &reason) {
  20099. if (ws_) { ws_->close(status, reason); }
  20100. }
  20101. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20102. inline const std::string &WebSocketClient::subprotocol() const {
  20103. return subprotocol_;
  20104. }
  20105. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20106. read_timeout_sec_ = sec;
  20107. read_timeout_usec_ = usec;
  20108. read_timeout_set_ = true;
  20109. // The members above only seed the next connect(); read() consults the
  20110. // stream, so an already-open connection has to be told directly.
  20111. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20112. }
  20113. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20114. write_timeout_sec_ = sec;
  20115. write_timeout_usec_ = usec;
  20116. }
  20117. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20118. websocket_ping_interval_sec_ = sec;
  20119. }
  20120. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20121. websocket_max_missed_pongs_ = count;
  20122. }
  20123. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20124. inline void WebSocketClient::set_address_family(int family) {
  20125. address_family_ = family;
  20126. }
  20127. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20128. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20129. socket_options_ = std::move(socket_options);
  20130. }
  20131. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20132. connection_timeout_sec_ = sec;
  20133. connection_timeout_usec_ = usec;
  20134. }
  20135. inline void WebSocketClient::set_interface(const std::string &intf) {
  20136. interface_ = intf;
  20137. }
  20138. inline void WebSocketClient::set_hostname_addr_map(
  20139. std::map<std::string, std::string> addr_map) {
  20140. addr_map_ = std::move(addr_map);
  20141. }
  20142. #ifdef CPPHTTPLIB_SSL_ENABLED
  20143. inline void
  20144. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20145. const std::string &ca_cert_dir_path) {
  20146. ca_cert_file_path_ = ca_cert_file_path;
  20147. ca_cert_dir_path_ = ca_cert_dir_path;
  20148. }
  20149. inline void
  20150. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20151. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20152. }
  20153. inline void WebSocketClient::set_session_verifier(
  20154. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20155. session_verifier_ = std::move(verifier);
  20156. }
  20157. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20158. if (store && tls_ctx_) {
  20159. // set_ca_store takes ownership of store
  20160. tls::set_ca_store(tls_ctx_, store);
  20161. custom_ca_loaded_ = true;
  20162. } else if (store) {
  20163. tls::free_ca_store(store);
  20164. }
  20165. }
  20166. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20167. std::size_t size) {
  20168. if (tls_ctx_ && ca_cert && size > 0) {
  20169. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20170. custom_ca_loaded_ = true;
  20171. }
  20172. }
  20173. inline void
  20174. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20175. server_certificate_verification_ = enabled;
  20176. }
  20177. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20178. server_hostname_verification_ = enabled;
  20179. }
  20180. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20181. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20182. }
  20183. #endif // CPPHTTPLIB_SSL_ENABLED
  20184. } // namespace ws
  20185. // ----------------------------------------------------------------------------
  20186. } // namespace httplib
  20187. #endif // CPPHTTPLIB_HTTPLIB_H