1
0

httplib.h 791 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188
  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.58.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003a00"
  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. /*
  18. * Configuration
  19. */
  20. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  21. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  22. #endif
  23. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  24. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  25. #endif
  26. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  27. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  28. #endif
  29. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  30. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  31. #endif
  32. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  33. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  34. #endif
  35. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  36. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  37. #endif
  38. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  39. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  40. #endif
  41. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  42. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  43. #endif
  44. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  45. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  46. #endif
  47. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  48. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  49. #endif
  50. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  51. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  52. #endif
  53. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  54. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  55. #endif
  56. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  57. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  58. #endif
  59. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  60. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  61. #endif
  62. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  63. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  64. #endif
  65. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  66. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  67. #endif
  68. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  69. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  70. #endif
  71. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  72. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  73. #endif
  74. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  75. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  76. #endif
  77. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  78. #ifdef _WIN32
  79. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  80. #else
  81. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  82. #endif
  83. #endif
  84. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  85. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  86. #endif
  87. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  88. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  89. #endif
  90. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  91. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  92. #endif
  93. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  94. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  95. #endif
  96. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  97. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  98. #endif
  99. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  100. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  101. #endif
  102. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  103. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  104. #endif
  105. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  106. // 1400 rather than a round number: a body that already fits in one 1500-byte
  107. // MTU gains nothing from being made smaller.
  108. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  109. #endif
  110. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  111. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  112. #endif
  113. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  114. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  115. #endif
  116. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  117. // recurses roughly once per matched character for quantified patterns such
  118. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  119. // a default ~8MB thread stack that has been observed to take on the order of
  120. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  121. // margin below that (well under the 8192-byte request URI limit) while still
  122. // fitting any realistic route segment; raise it if a route legitimately needs
  123. // longer paths. Regex routes are never applied to paths longer than this.
  124. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  125. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  126. #endif
  127. #ifndef CPPHTTPLIB_TCP_NODELAY
  128. #define CPPHTTPLIB_TCP_NODELAY false
  129. #endif
  130. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  131. #define CPPHTTPLIB_IPV6_V6ONLY false
  132. #endif
  133. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  134. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  135. #endif
  136. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  137. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  138. #endif
  139. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  140. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  141. #endif
  142. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  143. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  144. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  145. ? std::thread::hardware_concurrency() - 1 \
  146. : 0))
  147. #endif
  148. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  149. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  150. #endif
  151. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  152. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  153. #endif
  154. #ifndef CPPHTTPLIB_RECV_FLAGS
  155. #define CPPHTTPLIB_RECV_FLAGS 0
  156. #endif
  157. #ifndef CPPHTTPLIB_SEND_FLAGS
  158. #define CPPHTTPLIB_SEND_FLAGS 0
  159. #endif
  160. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  161. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  162. #endif
  163. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  164. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  165. #endif
  166. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  167. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  168. #endif
  169. // One macro used to set the read timeout for both sides. They want different
  170. // defaults: a client's read timeout is the caller's own tool (it waits forever
  171. // until asked not to), while a server keeps a ceiling that reclaims a worker
  172. // from a peer that has gone quiet. The old name still works and sets both.
  173. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  174. #pragma message( \
  175. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  176. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  177. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  178. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  179. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  180. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  181. #endif
  182. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  183. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  184. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  185. #endif
  186. #endif
  187. // 0 waits forever. A read timeout is how a caller gets control back to send on
  188. // the same connection; it is not a liveness check (that is ping/pong). Only a
  189. // timeout set at runtime through set_read_timeout() is reported as
  190. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  191. // ws::Fail and closes the connection.
  192. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  194. #endif
  195. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  196. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  197. #endif
  198. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  199. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  200. #endif
  201. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  202. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  203. #endif
  204. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  205. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  206. #endif
  207. /*
  208. * Headers
  209. */
  210. #ifdef _WIN32
  211. #ifndef _CRT_SECURE_NO_WARNINGS
  212. #define _CRT_SECURE_NO_WARNINGS
  213. #endif //_CRT_SECURE_NO_WARNINGS
  214. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  215. #define _CRT_NONSTDC_NO_DEPRECATE
  216. #endif //_CRT_NONSTDC_NO_DEPRECATE
  217. #if defined(_MSC_VER)
  218. #if _MSC_VER < 1900
  219. #error Sorry, Visual Studio versions prior to 2015 are not supported
  220. #endif
  221. #pragma comment(lib, "ws2_32.lib")
  222. #ifndef _SSIZE_T_DEFINED
  223. using ssize_t = __int64;
  224. #define _SSIZE_T_DEFINED
  225. #endif
  226. #endif // _MSC_VER
  227. #ifndef S_ISREG
  228. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  229. #endif // S_ISREG
  230. #ifndef S_ISDIR
  231. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  232. #endif // S_ISDIR
  233. #ifndef NOMINMAX
  234. #define NOMINMAX
  235. #endif // NOMINMAX
  236. #include <io.h>
  237. #include <winsock2.h>
  238. #include <ws2tcpip.h>
  239. #if defined(__has_include)
  240. #if __has_include(<afunix.h>)
  241. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  242. #include <afunix.h>
  243. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  244. #endif
  245. #endif
  246. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  247. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  248. #endif
  249. using nfds_t = unsigned long;
  250. using socket_t = SOCKET;
  251. using socklen_t = int;
  252. #else // not _WIN32
  253. #include <arpa/inet.h>
  254. #if !defined(_AIX) && !defined(__MVS__)
  255. #include <ifaddrs.h>
  256. #endif
  257. #ifdef __MVS__
  258. #include <strings.h>
  259. #ifndef NI_MAXHOST
  260. #define NI_MAXHOST 1025
  261. #endif
  262. #endif
  263. #include <net/if.h>
  264. #include <netdb.h>
  265. #include <netinet/in.h>
  266. #ifdef __linux__
  267. #include <resolv.h>
  268. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  269. #endif
  270. #include <csignal>
  271. #include <netinet/tcp.h>
  272. #include <poll.h>
  273. #include <pthread.h>
  274. #include <sys/mman.h>
  275. #include <sys/socket.h>
  276. #include <sys/un.h>
  277. #include <unistd.h>
  278. using socket_t = int;
  279. #ifndef INVALID_SOCKET
  280. #define INVALID_SOCKET (-1)
  281. #endif
  282. #endif //_WIN32
  283. #if defined(__APPLE__)
  284. #include <TargetConditionals.h>
  285. #endif
  286. #include <algorithm>
  287. #include <array>
  288. #include <atomic>
  289. #include <cassert>
  290. #include <chrono>
  291. #include <climits>
  292. #include <condition_variable>
  293. #include <cstdlib>
  294. #include <cstring>
  295. #include <errno.h>
  296. #include <exception>
  297. #include <fcntl.h>
  298. #include <fstream>
  299. #include <functional>
  300. #include <iomanip>
  301. #include <iostream>
  302. #include <iterator>
  303. #include <list>
  304. #include <map>
  305. #include <memory>
  306. #include <mutex>
  307. #include <random>
  308. #include <regex>
  309. #include <set>
  310. #include <sstream>
  311. #include <string>
  312. #include <sys/stat.h>
  313. #include <system_error>
  314. #include <thread>
  315. #include <type_traits>
  316. #include <unordered_map>
  317. #include <unordered_set>
  318. #include <utility>
  319. #include <vector>
  320. // On macOS with a TLS backend, enable Keychain root certificates by default
  321. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  322. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  323. // only; on those platforms the user must provide a CA bundle explicitly.
  324. #if defined(__APPLE__) && defined(__clang__) && \
  325. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  326. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  327. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  328. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  329. #if TARGET_OS_OSX
  330. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  331. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  332. #endif
  333. #endif
  334. #endif
  335. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  336. defined(__APPLE__) && !TARGET_OS_OSX
  337. #error \
  338. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  339. #endif
  340. // On Windows, enable Schannel certificate verification by default
  341. // unless the user explicitly opts out.
  342. #if defined(_WIN32) && \
  343. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  344. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  345. #endif
  346. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  347. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  348. #if TARGET_OS_MAC && defined(__clang__)
  349. #include <CFNetwork/CFHost.h>
  350. #include <CoreFoundation/CoreFoundation.h>
  351. #endif
  352. #endif
  353. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  354. #ifdef _WIN32
  355. #include <wincrypt.h>
  356. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  357. // used
  358. #undef X509_NAME
  359. #undef X509_CERT_PAIR
  360. #undef X509_EXTENSIONS
  361. #undef PKCS7_SIGNER_INFO
  362. #ifdef _MSC_VER
  363. #pragma comment(lib, "crypt32.lib")
  364. #endif
  365. #endif // _WIN32
  366. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  367. #if TARGET_OS_OSX
  368. #include <Security/Security.h>
  369. #endif
  370. #endif
  371. #include <openssl/err.h>
  372. #include <openssl/evp.h>
  373. #include <openssl/ssl.h>
  374. #include <openssl/x509v3.h>
  375. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  376. #include <openssl/applink.c>
  377. #endif
  378. #include <iostream>
  379. #include <sstream>
  380. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  381. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  382. #error Please use OpenSSL or a current version of BoringSSL
  383. #endif
  384. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  385. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  386. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  387. #endif
  388. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  389. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  390. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  391. // in with this first include group so the version gating below can use it.
  392. #include <mbedtls/error.h>
  393. #include <mbedtls/net_sockets.h>
  394. #include <mbedtls/oid.h>
  395. #include <mbedtls/pk.h>
  396. #include <mbedtls/ssl.h>
  397. #include <mbedtls/version.h>
  398. #include <mbedtls/x509_crt.h>
  399. #if MBEDTLS_VERSION_MAJOR >= 4
  400. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  401. #include <psa/crypto.h>
  402. #else
  403. #include <mbedtls/ctr_drbg.h>
  404. #include <mbedtls/entropy.h>
  405. #include <mbedtls/md5.h>
  406. #include <mbedtls/sha1.h>
  407. #include <mbedtls/sha256.h>
  408. #include <mbedtls/sha512.h>
  409. #endif
  410. #ifdef _WIN32
  411. #include <wincrypt.h>
  412. #ifdef _MSC_VER
  413. #pragma comment(lib, "crypt32.lib")
  414. #endif
  415. #endif // _WIN32
  416. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  417. #if TARGET_OS_OSX
  418. #include <Security/Security.h>
  419. #endif
  420. #endif
  421. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  422. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  423. #if MBEDTLS_VERSION_MAJOR >= 4
  424. #define CPPHTTPLIB_MBEDTLS_V4
  425. #endif
  426. #if MBEDTLS_VERSION_MAJOR >= 3
  427. #define CPPHTTPLIB_MBEDTLS_V3
  428. #endif
  429. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  430. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  431. #include <wolfssl/options.h>
  432. #include <wolfssl/openssl/x509v3.h>
  433. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  434. #ifndef WOLFSSL_GEN_EMAIL
  435. #define WOLFSSL_GEN_EMAIL 1
  436. #endif
  437. #ifndef WOLFSSL_GEN_DNS
  438. #define WOLFSSL_GEN_DNS 2
  439. #endif
  440. #ifndef WOLFSSL_GEN_URI
  441. #define WOLFSSL_GEN_URI 6
  442. #endif
  443. #ifndef WOLFSSL_GEN_IPADD
  444. #define WOLFSSL_GEN_IPADD 7
  445. #endif
  446. #include <wolfssl/ssl.h>
  447. #include <wolfssl/wolfcrypt/hash.h>
  448. #include <wolfssl/wolfcrypt/md5.h>
  449. #include <wolfssl/wolfcrypt/sha256.h>
  450. #include <wolfssl/wolfcrypt/sha512.h>
  451. #ifdef _WIN32
  452. #include <wincrypt.h>
  453. #ifdef _MSC_VER
  454. #pragma comment(lib, "crypt32.lib")
  455. #endif
  456. #endif // _WIN32
  457. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  458. #if TARGET_OS_OSX
  459. #include <Security/Security.h>
  460. #endif
  461. #endif
  462. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  463. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  464. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  465. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  466. #define CPPHTTPLIB_SSL_ENABLED
  467. #endif
  468. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  469. #include <zlib.h>
  470. #endif
  471. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  472. #include <brotli/decode.h>
  473. #include <brotli/encode.h>
  474. #endif
  475. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  476. #include <zstd.h>
  477. #endif
  478. /*
  479. * Declaration
  480. */
  481. namespace httplib {
  482. namespace ws {
  483. class WebSocket;
  484. } // namespace ws
  485. namespace detail {
  486. /*
  487. * Backport std::make_unique from C++14.
  488. *
  489. * NOTE: This code came up with the following stackoverflow post:
  490. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  491. *
  492. */
  493. template <class T, class... Args>
  494. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  495. make_unique(Args &&...args) {
  496. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  497. }
  498. template <class T>
  499. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  500. make_unique(std::size_t n) {
  501. typedef typename std::remove_extent<T>::type RT;
  502. return std::unique_ptr<T>(new RT[n]);
  503. }
  504. // Locale-independent ASCII character classification. The <cctype>
  505. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  506. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  507. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  508. // classified without regard to the locale.
  509. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  510. inline bool is_ascii_alpha(char c) {
  511. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  512. }
  513. inline bool is_ascii_alnum(char c) {
  514. return is_ascii_digit(c) || is_ascii_alpha(c);
  515. }
  516. namespace case_ignore {
  517. inline unsigned char to_lower(int c) {
  518. const static unsigned char table[256] = {
  519. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  520. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  521. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  522. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  523. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  524. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  525. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  526. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  527. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  528. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  529. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  530. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  531. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  532. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  533. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  534. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  535. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  536. 255,
  537. };
  538. return table[(unsigned char)(char)c];
  539. }
  540. inline std::string to_lower(const std::string &s) {
  541. std::string result = s;
  542. std::transform(
  543. result.begin(), result.end(), result.begin(),
  544. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  545. return result;
  546. }
  547. inline bool equal(const std::string &a, const std::string &b) {
  548. return a.size() == b.size() &&
  549. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  550. return to_lower(ca) == to_lower(cb);
  551. });
  552. }
  553. struct equal_to {
  554. bool operator()(const std::string &a, const std::string &b) const {
  555. return equal(a, b);
  556. }
  557. };
  558. struct hash {
  559. size_t operator()(const std::string &key) const {
  560. return hash_core(key.data(), key.size(), 0);
  561. }
  562. size_t hash_core(const char *s, size_t l, size_t h) const {
  563. return (l == 0) ? h
  564. : hash_core(s + 1, l - 1,
  565. // Unsets the 6 high bits of h, therefore no
  566. // overflow happens
  567. (((std::numeric_limits<size_t>::max)() >> 6) &
  568. h * 33) ^
  569. static_cast<unsigned char>(to_lower(*s)));
  570. }
  571. };
  572. template <typename T>
  573. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  574. detail::case_ignore::equal_to>;
  575. } // namespace case_ignore
  576. // This is based on
  577. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  578. struct scope_exit {
  579. explicit scope_exit(std::function<void(void)> &&f)
  580. : exit_function(std::move(f)), execute_on_destruction{true} {}
  581. scope_exit(scope_exit &&rhs) noexcept
  582. : exit_function(std::move(rhs.exit_function)),
  583. execute_on_destruction{rhs.execute_on_destruction} {
  584. rhs.release();
  585. }
  586. ~scope_exit() {
  587. if (execute_on_destruction) { this->exit_function(); }
  588. }
  589. void release() { this->execute_on_destruction = false; }
  590. private:
  591. scope_exit(const scope_exit &) = delete;
  592. void operator=(const scope_exit &) = delete;
  593. scope_exit &operator=(scope_exit &&) = delete;
  594. std::function<void(void)> exit_function;
  595. bool execute_on_destruction;
  596. };
  597. // Simple from_chars implementation for integer and double types (C++17
  598. // substitute)
  599. template <typename T> struct from_chars_result {
  600. const char *ptr;
  601. std::errc ec;
  602. };
  603. template <typename T>
  604. inline from_chars_result<T> from_chars(const char *first, const char *last,
  605. T &value, int base = 10) {
  606. value = 0;
  607. const char *p = first;
  608. bool negative = false;
  609. if (p != last && *p == '-') {
  610. negative = true;
  611. ++p;
  612. }
  613. if (p == last) { return {first, std::errc::invalid_argument}; }
  614. T result = 0;
  615. for (; p != last; ++p) {
  616. char c = *p;
  617. int digit = -1;
  618. if (is_ascii_digit(c)) {
  619. digit = c - '0';
  620. } else if ('a' <= c && c <= 'z') {
  621. digit = c - 'a' + 10;
  622. } else if ('A' <= c && c <= 'Z') {
  623. digit = c - 'A' + 10;
  624. } else {
  625. break;
  626. }
  627. if (digit < 0 || digit >= base) { break; }
  628. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  629. return {p, std::errc::result_out_of_range};
  630. }
  631. result = result * base + digit;
  632. }
  633. if (p == first || (negative && p == first + 1)) {
  634. return {first, std::errc::invalid_argument};
  635. }
  636. value = negative ? T(0) - result : result;
  637. return {p, std::errc{}};
  638. }
  639. // from_chars for double (hand-written, locale-independent)
  640. //
  641. // The only double consumed by this library is the HTTP quality value, whose
  642. // grammar is (RFC 9110 12.4.2):
  643. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  644. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  645. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  646. // '.' always the decimal separator (std::strtod would instead read it from the
  647. // global C locale, mis-parsing q-values once an embedder calls
  648. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  649. // the result to [0, 1], so inputs outside that range need not be distinguished
  650. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  651. // cases that exponent and wide-range handling would introduce.
  652. inline from_chars_result<double> from_chars(const char *first, const char *last,
  653. double &value) {
  654. value = 0.0;
  655. const char *p = first;
  656. // Each 1eN is exactly representable, so a single final division by the
  657. // matching entry yields a correctly-rounded result.
  658. static const double powers_of_ten[] = {
  659. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  660. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  661. const int max_frac_digits =
  662. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  663. // Accumulate digits into a 64-bit integer and remember how many were
  664. // fractional. Two independent caps keep this bounded and safe:
  665. // * accumulation saturates before mantissa could overflow uint64_t, and
  666. // * frac_digits is capped at max_frac_digits so it is always a valid index
  667. // into powers_of_ten (without this an input like "0.000...0" would never
  668. // grow mantissa, so the saturation cap alone would not bound it).
  669. // Both caps only drop digits far beyond the precision a q-value needs; any
  670. // value they would change is well outside [0, 1] and rejected by the caller.
  671. uint64_t mantissa = 0;
  672. int frac_digits = 0;
  673. bool seen_digit = false;
  674. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  675. auto accumulate = [&](char c) {
  676. if (mantissa <= limit) {
  677. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  678. return true;
  679. }
  680. return false;
  681. };
  682. for (; p != last && is_ascii_digit(*p); ++p) {
  683. seen_digit = true;
  684. accumulate(*p);
  685. }
  686. if (p != last && *p == '.') {
  687. ++p;
  688. for (; p != last && is_ascii_digit(*p); ++p) {
  689. seen_digit = true;
  690. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  691. }
  692. }
  693. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  694. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  695. return {p, std::errc{}};
  696. }
  697. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  698. int &out) {
  699. int val = 0;
  700. auto r = from_chars(s, s + len, val);
  701. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  702. return false;
  703. }
  704. out = val;
  705. return true;
  706. }
  707. inline bool parse_port(const char *s, size_t len, int &port) {
  708. return parse_int_in_range(s, len, 1, 65535, port);
  709. }
  710. inline bool parse_port(const std::string &s, int &port) {
  711. return parse_port(s.data(), s.size(), port);
  712. }
  713. struct UrlComponents {
  714. std::string scheme;
  715. std::string host;
  716. std::string port;
  717. std::string path;
  718. std::string query;
  719. };
  720. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  721. uc = {};
  722. size_t pos = 0;
  723. auto sep = url.find("://");
  724. if (sep != std::string::npos) {
  725. uc.scheme = url.substr(0, sep);
  726. // Scheme must be [a-z]+ only
  727. if (uc.scheme.empty()) { return false; }
  728. for (auto c : uc.scheme) {
  729. if (c < 'a' || c > 'z') { return false; }
  730. }
  731. pos = sep + 3;
  732. } else if (url.compare(0, 2, "//") == 0) {
  733. pos = 2;
  734. }
  735. auto has_authority_prefix = pos > 0;
  736. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  737. url[0] != '?' && url[0] != '#');
  738. if (has_authority) {
  739. if (pos < url.size() && url[pos] == '[') {
  740. auto close = url.find(']', pos);
  741. if (close == std::string::npos) { return false; }
  742. uc.host = url.substr(pos + 1, close - pos - 1);
  743. // IPv6 host must be [a-fA-F0-9:]+ only
  744. if (uc.host.empty()) { return false; }
  745. for (auto c : uc.host) {
  746. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  747. (c >= 'A' && c <= 'F') || c == ':')) {
  748. return false;
  749. }
  750. }
  751. pos = close + 1;
  752. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  753. // path, query or fragment delimiter (or the end of input). Otherwise the
  754. // trailing bytes would be folded into the path while the connection
  755. // still targets the bracketed address.
  756. if (pos < url.size()) {
  757. auto c = url[pos];
  758. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  759. }
  760. } else {
  761. auto end = url.find_first_of(":/?#", pos);
  762. if (end == std::string::npos) { end = url.size(); }
  763. uc.host = url.substr(pos, end - pos);
  764. pos = end;
  765. }
  766. if (pos < url.size() && url[pos] == ':') {
  767. ++pos;
  768. auto end = url.find_first_of("/?#", pos);
  769. if (end == std::string::npos) { end = url.size(); }
  770. uc.port = url.substr(pos, end - pos);
  771. pos = end;
  772. }
  773. // Without :// or //, the entire input must be consumed as host[:port].
  774. // If there is leftover (path, query, etc.), this is not a valid
  775. // host[:port] string — clear and reparse as a plain path.
  776. if (!has_authority_prefix && pos < url.size()) {
  777. uc.host.clear();
  778. uc.port.clear();
  779. pos = 0;
  780. }
  781. }
  782. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  783. auto end = url.find_first_of("?#", pos);
  784. if (end == std::string::npos) { end = url.size(); }
  785. uc.path = url.substr(pos, end - pos);
  786. pos = end;
  787. }
  788. if (pos < url.size() && url[pos] == '?') {
  789. auto end = url.find('#', pos);
  790. if (end == std::string::npos) { end = url.size(); }
  791. uc.query = url.substr(pos, end - pos);
  792. }
  793. return true;
  794. }
  795. // Resolves a relative-path or query-only Location value against the path of
  796. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  797. // references starting with '/' are returned unchanged.
  798. inline std::string resolve_relative_location(const std::string &location,
  799. const std::string &base) {
  800. if (location.empty() || location[0] == '/') { return location; }
  801. // A ':' in the first segment means the value has a scheme.
  802. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  803. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  804. auto base_path = base.substr(0, base.find_first_of("?#"));
  805. if (location[0] == '?') { return base_path + location; }
  806. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  807. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  808. // Remove "." and ".." segments from the merged path.
  809. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  810. std::string path;
  811. size_t i = 0;
  812. while (i < path_end) {
  813. auto next = (std::min)(merged.find('/', i + 1), path_end);
  814. auto segment = merged.substr(i + 1, next - i - 1);
  815. auto is_last = next == path_end;
  816. if (segment == "." || segment == "..") {
  817. if (segment == "..") {
  818. path.erase((std::min)(path.rfind('/'), path.size()));
  819. }
  820. if (is_last) { path += '/'; }
  821. } else {
  822. path += '/';
  823. path += segment;
  824. }
  825. i = next;
  826. }
  827. if (path.empty()) { path = "/"; }
  828. return path + merged.substr(path_end);
  829. }
  830. } // namespace detail
  831. enum class SSLVerifierResponse {
  832. // no decision has been made, use the built-in certificate verifier
  833. NoDecisionMade,
  834. // connection certificate is verified and accepted
  835. CertificateAccepted,
  836. // connection certificate was processed but is rejected
  837. CertificateRejected
  838. };
  839. // System CA loading policy for SSL clients. Auto (the default) loads system
  840. // CA certs only when no custom CA is configured; enable_system_ca() switches
  841. // to an explicit policy.
  842. enum class SystemCAMode { Auto, Enabled, Disabled };
  843. enum StatusCode {
  844. // Information responses
  845. Continue_100 = 100,
  846. SwitchingProtocol_101 = 101,
  847. Processing_102 = 102,
  848. EarlyHints_103 = 103,
  849. // Successful responses
  850. OK_200 = 200,
  851. Created_201 = 201,
  852. Accepted_202 = 202,
  853. NonAuthoritativeInformation_203 = 203,
  854. NoContent_204 = 204,
  855. ResetContent_205 = 205,
  856. PartialContent_206 = 206,
  857. MultiStatus_207 = 207,
  858. AlreadyReported_208 = 208,
  859. IMUsed_226 = 226,
  860. // Redirection messages
  861. MultipleChoices_300 = 300,
  862. MovedPermanently_301 = 301,
  863. Found_302 = 302,
  864. SeeOther_303 = 303,
  865. NotModified_304 = 304,
  866. UseProxy_305 = 305,
  867. unused_306 = 306,
  868. TemporaryRedirect_307 = 307,
  869. PermanentRedirect_308 = 308,
  870. // Client error responses
  871. BadRequest_400 = 400,
  872. Unauthorized_401 = 401,
  873. PaymentRequired_402 = 402,
  874. Forbidden_403 = 403,
  875. NotFound_404 = 404,
  876. MethodNotAllowed_405 = 405,
  877. NotAcceptable_406 = 406,
  878. ProxyAuthenticationRequired_407 = 407,
  879. RequestTimeout_408 = 408,
  880. Conflict_409 = 409,
  881. Gone_410 = 410,
  882. LengthRequired_411 = 411,
  883. PreconditionFailed_412 = 412,
  884. PayloadTooLarge_413 = 413,
  885. UriTooLong_414 = 414,
  886. UnsupportedMediaType_415 = 415,
  887. RangeNotSatisfiable_416 = 416,
  888. ExpectationFailed_417 = 417,
  889. ImATeapot_418 = 418,
  890. MisdirectedRequest_421 = 421,
  891. UnprocessableContent_422 = 422,
  892. Locked_423 = 423,
  893. FailedDependency_424 = 424,
  894. TooEarly_425 = 425,
  895. UpgradeRequired_426 = 426,
  896. PreconditionRequired_428 = 428,
  897. TooManyRequests_429 = 429,
  898. RequestHeaderFieldsTooLarge_431 = 431,
  899. UnavailableForLegalReasons_451 = 451,
  900. // Server error responses
  901. InternalServerError_500 = 500,
  902. NotImplemented_501 = 501,
  903. BadGateway_502 = 502,
  904. ServiceUnavailable_503 = 503,
  905. GatewayTimeout_504 = 504,
  906. HttpVersionNotSupported_505 = 505,
  907. VariantAlsoNegotiates_506 = 506,
  908. InsufficientStorage_507 = 507,
  909. LoopDetected_508 = 508,
  910. NotExtended_510 = 510,
  911. NetworkAuthenticationRequired_511 = 511,
  912. };
  913. namespace detail {
  914. // A multimap that keeps its entries in the order they were inserted.
  915. //
  916. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  917. // fields sharing a field name significant and forbids a proxy from reordering
  918. // them, and a query string's parameters are meaningful in the order the caller
  919. // wrote them. Neither standard container expresses it: std::unordered_multimap
  920. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  921. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  922. // key, which would drop control data such as Host behind whatever else the
  923. // message carries and alphabetise a query string.
  924. //
  925. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  926. // scan, which beats hashing for the handful of entries a message carries
  927. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  928. //
  929. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  930. // Params, whose parameter names are case-sensitive, not.
  931. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  932. public:
  933. using key_type = std::string;
  934. using mapped_type = Mapped;
  935. using value_type = std::pair<std::string, Mapped>;
  936. using size_type = std::size_t;
  937. using difference_type = std::ptrdiff_t;
  938. using reference = value_type &;
  939. using const_reference = const value_type &;
  940. private:
  941. static size_type npos() { return static_cast<size_type>(-1); }
  942. static bool keys_equal(const std::string &a, const std::string &b) {
  943. return KeyEqual()(a, b);
  944. }
  945. // Iterating yields every entry in insertion order, but equal_range() and
  946. // find() have to walk only the entries sharing one key, which are not
  947. // adjacent. Both are the same iterator type: key_idx_ selects between the
  948. // two traversals, and since equality compares only the position, an iterator
  949. // restricted to one key still compares equal to end().
  950. template <typename V> class iterator_t {
  951. public:
  952. using iterator_category = std::bidirectional_iterator_tag;
  953. using value_type = insertion_ordered_multimap::value_type;
  954. using difference_type = insertion_ordered_multimap::difference_type;
  955. using pointer = V *;
  956. using reference = V &;
  957. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  958. template <typename U,
  959. typename std::enable_if<std::is_convertible<U *, V *>::value,
  960. int>::type = 0>
  961. iterator_t(const iterator_t<U> &rhs)
  962. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  963. key_idx_(rhs.key_idx_) {}
  964. reference operator*() const { return data_[idx_]; }
  965. pointer operator->() const { return data_ + idx_; }
  966. iterator_t &operator++() {
  967. // Saturating, so that advancing past the last entry of a key (which
  968. // get_multimap_value() does when asked for an out-of-range id) stays at
  969. // end() instead of running off the container.
  970. if (idx_ >= size_) { return *this; }
  971. ++idx_;
  972. if (key_idx_ != npos()) {
  973. while (idx_ < size_ && !matches(idx_)) {
  974. ++idx_;
  975. }
  976. }
  977. return *this;
  978. }
  979. iterator_t operator++(int) {
  980. auto tmp = *this;
  981. ++*this;
  982. return tmp;
  983. }
  984. iterator_t &operator--() {
  985. if (idx_ == 0) { return *this; }
  986. --idx_;
  987. if (key_idx_ != npos()) {
  988. while (idx_ > 0 && !matches(idx_)) {
  989. --idx_;
  990. }
  991. }
  992. return *this;
  993. }
  994. iterator_t operator--(int) {
  995. auto tmp = *this;
  996. --*this;
  997. return tmp;
  998. }
  999. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1000. return idx_ == rhs.idx_;
  1001. }
  1002. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1003. return idx_ != rhs.idx_;
  1004. }
  1005. private:
  1006. friend class insertion_ordered_multimap;
  1007. template <typename> friend class iterator_t;
  1008. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1009. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1010. bool matches(size_type i) const {
  1011. return keys_equal(data_[i].first, data_[key_idx_].first);
  1012. }
  1013. V *data_;
  1014. size_type idx_;
  1015. size_type size_;
  1016. size_type key_idx_;
  1017. };
  1018. public:
  1019. using iterator = iterator_t<value_type>;
  1020. using const_iterator = iterator_t<const value_type>;
  1021. insertion_ordered_multimap() = default;
  1022. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1023. : entries_(il) {}
  1024. template <typename InputIt>
  1025. insertion_ordered_multimap(InputIt first, InputIt last)
  1026. : entries_(first, last) {}
  1027. iterator begin() { return make_iter(0, npos()); }
  1028. iterator end() { return make_iter(entries_.size(), npos()); }
  1029. const_iterator begin() const { return make_citer(0, npos()); }
  1030. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1031. const_iterator cbegin() const { return begin(); }
  1032. const_iterator cend() const { return end(); }
  1033. bool empty() const { return entries_.empty(); }
  1034. size_type size() const { return entries_.size(); }
  1035. void clear() { entries_.clear(); }
  1036. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1037. iterator insert(const value_type &val) {
  1038. entries_.push_back(val);
  1039. return make_iter(entries_.size() - 1, npos());
  1040. }
  1041. iterator insert(value_type &&val) {
  1042. entries_.push_back(std::move(val));
  1043. return make_iter(entries_.size() - 1, npos());
  1044. }
  1045. template <typename... Args> iterator emplace(Args &&...args) {
  1046. entries_.emplace_back(std::forward<Args>(args)...);
  1047. return make_iter(entries_.size() - 1, npos());
  1048. }
  1049. // For entries that have to lead the message, such as the Host header field
  1050. // (RFC 9110 5.3 recommends sending control data first).
  1051. template <typename... Args> iterator emplace_front(Args &&...args) {
  1052. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1053. return make_iter(0, npos());
  1054. }
  1055. iterator find(const std::string &key) {
  1056. auto i = index_of(key);
  1057. return i == npos() ? end() : make_iter(i, i);
  1058. }
  1059. const_iterator find(const std::string &key) const {
  1060. auto i = index_of(key);
  1061. return i == npos() ? end() : make_citer(i, i);
  1062. }
  1063. size_type count(const std::string &key) const {
  1064. size_type n = 0;
  1065. for (const auto &entry : entries_) {
  1066. if (keys_equal(entry.first, key)) { n++; }
  1067. }
  1068. return n;
  1069. }
  1070. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1071. auto i = index_of(key);
  1072. return i == npos() ? std::make_pair(end(), end())
  1073. : std::make_pair(make_iter(i, i), end());
  1074. }
  1075. std::pair<const_iterator, const_iterator>
  1076. equal_range(const std::string &key) const {
  1077. auto i = index_of(key);
  1078. return i == npos() ? std::make_pair(end(), end())
  1079. : std::make_pair(make_citer(i, i), end());
  1080. }
  1081. size_type erase(const std::string &key) {
  1082. auto before = entries_.size();
  1083. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1084. [&](const value_type &entry) {
  1085. return keys_equal(entry.first, key);
  1086. }),
  1087. entries_.end());
  1088. return before - entries_.size();
  1089. }
  1090. iterator erase(const_iterator pos) {
  1091. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1092. return make_iter(pos.idx_, npos());
  1093. }
  1094. // Erases what iterating [first, last) would actually visit, so erasing an
  1095. // equal_range() removes only the entries with that key, not everything
  1096. // positioned between them.
  1097. iterator erase(const_iterator first, const_iterator last) {
  1098. auto from = first.idx_;
  1099. auto to = last.idx_;
  1100. if (from >= to) { return make_iter(from, npos()); }
  1101. auto begin_it = entries_.begin();
  1102. auto from_it = begin_it + static_cast<difference_type>(from);
  1103. auto to_it = begin_it + static_cast<difference_type>(to);
  1104. if (first.key_idx_ == npos()) {
  1105. entries_.erase(from_it, to_it);
  1106. } else {
  1107. auto key = entries_[first.key_idx_].first;
  1108. auto keep = from_it;
  1109. for (auto it = from_it; it != to_it; ++it) {
  1110. if (!keys_equal(it->first, key)) {
  1111. if (keep != it) { *keep = std::move(*it); }
  1112. ++keep;
  1113. }
  1114. }
  1115. if (keep != to_it) {
  1116. keep = std::move(to_it, entries_.end(), keep);
  1117. } else {
  1118. keep = entries_.end();
  1119. }
  1120. entries_.erase(keep, entries_.end());
  1121. }
  1122. return make_iter(from, npos());
  1123. }
  1124. friend bool operator==(const insertion_ordered_multimap &lhs,
  1125. const insertion_ordered_multimap &rhs) {
  1126. return lhs.entries_ == rhs.entries_;
  1127. }
  1128. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1129. const insertion_ordered_multimap &rhs) {
  1130. return !(lhs == rhs);
  1131. }
  1132. private:
  1133. size_type index_of(const std::string &key) const {
  1134. for (size_type i = 0; i < entries_.size(); i++) {
  1135. if (keys_equal(entries_[i].first, key)) { return i; }
  1136. }
  1137. return npos();
  1138. }
  1139. iterator make_iter(size_type idx, size_type key_idx) {
  1140. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1141. }
  1142. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1143. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1144. }
  1145. std::vector<value_type> entries_;
  1146. };
  1147. } // namespace detail
  1148. using Headers =
  1149. detail::insertion_ordered_multimap<std::string,
  1150. detail::case_ignore::equal_to>;
  1151. // Query parameter names are case-sensitive, unlike header field names.
  1152. using Params =
  1153. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1154. using Match = std::smatch;
  1155. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1156. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1157. /*
  1158. * detail: type-erased storage used by UserData.
  1159. * ABI-stable regardless of C++ standard — always uses this custom
  1160. * implementation instead of std::any.
  1161. */
  1162. namespace detail {
  1163. using any_type_id = const void *;
  1164. template <typename T> any_type_id any_typeid() noexcept {
  1165. static const char id = 0;
  1166. return &id;
  1167. }
  1168. struct any_storage {
  1169. virtual ~any_storage() = default;
  1170. virtual std::unique_ptr<any_storage> clone() const = 0;
  1171. virtual any_type_id type_id() const noexcept = 0;
  1172. };
  1173. template <typename T> struct any_value final : any_storage {
  1174. T value;
  1175. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1176. std::unique_ptr<any_storage> clone() const override {
  1177. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1178. }
  1179. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1180. };
  1181. } // namespace detail
  1182. class UserData {
  1183. public:
  1184. UserData() = default;
  1185. UserData(UserData &&) noexcept = default;
  1186. UserData &operator=(UserData &&) noexcept = default;
  1187. UserData(const UserData &o) {
  1188. for (const auto &e : o.entries_) {
  1189. if (e.second) { entries_[e.first] = e.second->clone(); }
  1190. }
  1191. }
  1192. UserData &operator=(const UserData &o) {
  1193. if (this != &o) {
  1194. entries_.clear();
  1195. for (const auto &e : o.entries_) {
  1196. if (e.second) { entries_[e.first] = e.second->clone(); }
  1197. }
  1198. }
  1199. return *this;
  1200. }
  1201. template <typename T> void set(const std::string &key, T &&value) {
  1202. using D = typename std::decay<T>::type;
  1203. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1204. }
  1205. template <typename T> T *get(const std::string &key) noexcept {
  1206. auto it = entries_.find(key);
  1207. if (it == entries_.end() || !it->second) { return nullptr; }
  1208. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1209. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1210. }
  1211. template <typename T> const T *get(const std::string &key) const noexcept {
  1212. auto it = entries_.find(key);
  1213. if (it == entries_.end() || !it->second) { return nullptr; }
  1214. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1215. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1216. }
  1217. bool has(const std::string &key) const noexcept {
  1218. return entries_.find(key) != entries_.end();
  1219. }
  1220. void erase(const std::string &key) { entries_.erase(key); }
  1221. void clear() noexcept { entries_.clear(); }
  1222. private:
  1223. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1224. entries_;
  1225. };
  1226. struct Response;
  1227. using ResponseHandler = std::function<bool(const Response &response)>;
  1228. struct FormData {
  1229. std::string name;
  1230. std::string content;
  1231. std::string filename;
  1232. std::string content_type;
  1233. Headers headers;
  1234. };
  1235. struct FormField {
  1236. std::string name;
  1237. std::string content;
  1238. Headers headers;
  1239. };
  1240. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1241. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1242. // should see the parts as they were sent. A std::multimap sorts by field name
  1243. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1244. // than the case-insensitive predicate Headers uses.
  1245. using FormFields =
  1246. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1247. using FormFiles =
  1248. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1249. struct MultipartFormData {
  1250. FormFields fields; // Text fields from multipart
  1251. FormFiles files; // Files from multipart
  1252. // Text field access
  1253. std::string get_field(const std::string &key, size_t id = 0) const;
  1254. std::vector<std::string> get_fields(const std::string &key) const;
  1255. bool has_field(const std::string &key) const;
  1256. size_t get_field_count(const std::string &key) const;
  1257. // File access
  1258. FormData get_file(const std::string &key, size_t id = 0) const;
  1259. std::vector<FormData> get_files(const std::string &key) const;
  1260. bool has_file(const std::string &key) const;
  1261. size_t get_file_count(const std::string &key) const;
  1262. };
  1263. struct UploadFormData {
  1264. std::string name;
  1265. std::string content;
  1266. std::string filename;
  1267. std::string content_type;
  1268. };
  1269. using UploadFormDataItems = std::vector<UploadFormData>;
  1270. class DataSink {
  1271. public:
  1272. DataSink() : os(&sb_), sb_(*this) {}
  1273. DataSink(const DataSink &) = delete;
  1274. DataSink &operator=(const DataSink &) = delete;
  1275. DataSink(DataSink &&) = delete;
  1276. DataSink &operator=(DataSink &&) = delete;
  1277. std::function<bool(const char *data, size_t data_len)> write;
  1278. // Only `write` is mandatory. The rest are defaulted so that a provider
  1279. // calling one on a writer that does not set it gets sensible behaviour
  1280. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1281. // `this` is safe: DataSink is neither copyable nor movable.
  1282. std::function<bool()> is_writable = []() { return true; };
  1283. std::function<void()> done = []() {};
  1284. std::function<void(const Headers &trailer)> done_with_trailer =
  1285. [this](const Headers & /*trailer*/) { done(); };
  1286. std::ostream os;
  1287. private:
  1288. class data_sink_streambuf final : public std::streambuf {
  1289. public:
  1290. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1291. protected:
  1292. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1293. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1294. return 0;
  1295. }
  1296. private:
  1297. DataSink &sink_;
  1298. };
  1299. data_sink_streambuf sb_;
  1300. };
  1301. using ContentProvider =
  1302. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1303. using ContentProviderWithoutLength =
  1304. std::function<bool(size_t offset, DataSink &sink)>;
  1305. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1306. struct FormDataProvider {
  1307. std::string name;
  1308. ContentProviderWithoutLength provider;
  1309. std::string filename;
  1310. std::string content_type;
  1311. };
  1312. using FormDataProviderItems = std::vector<FormDataProvider>;
  1313. inline FormDataProvider
  1314. make_file_provider(const std::string &name, const std::string &filepath,
  1315. const std::string &filename = std::string(),
  1316. const std::string &content_type = std::string()) {
  1317. FormDataProvider fdp;
  1318. fdp.name = name;
  1319. fdp.filename = filename.empty() ? filepath : filename;
  1320. fdp.content_type = content_type;
  1321. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1322. std::ifstream f(filepath, std::ios::binary);
  1323. if (!f) { return false; }
  1324. if (offset > 0) {
  1325. f.seekg(static_cast<std::streamoff>(offset));
  1326. if (!f.good()) {
  1327. sink.done();
  1328. return true;
  1329. }
  1330. }
  1331. char buf[8192];
  1332. f.read(buf, sizeof(buf));
  1333. auto n = static_cast<size_t>(f.gcount());
  1334. if (n > 0) { return sink.write(buf, n); }
  1335. sink.done(); // EOF
  1336. return true;
  1337. };
  1338. return fdp;
  1339. }
  1340. inline std::pair<size_t, ContentProvider>
  1341. make_file_body(const std::string &filepath) {
  1342. size_t size = 0;
  1343. {
  1344. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1345. if (!f) { return {0, ContentProvider{}}; }
  1346. size = static_cast<size_t>(f.tellg());
  1347. }
  1348. ContentProvider provider = [filepath](size_t offset, size_t length,
  1349. DataSink &sink) -> bool {
  1350. std::ifstream f(filepath, std::ios::binary);
  1351. if (!f) { return false; }
  1352. f.seekg(static_cast<std::streamoff>(offset));
  1353. if (!f.good()) { return false; }
  1354. char buf[8192];
  1355. while (length > 0) {
  1356. auto to_read = (std::min)(sizeof(buf), length);
  1357. f.read(buf, static_cast<std::streamsize>(to_read));
  1358. auto n = static_cast<size_t>(f.gcount());
  1359. // The file is shorter than the size make_file_body() measured, which the
  1360. // caller has already committed to as Content-Length. The body cannot be
  1361. // completed, so fail as every other error here does.
  1362. if (n == 0) { return false; }
  1363. if (!sink.write(buf, n)) { return false; }
  1364. length -= n;
  1365. }
  1366. return true;
  1367. };
  1368. return {size, std::move(provider)};
  1369. }
  1370. using ContentReceiverWithProgress = std::function<bool(
  1371. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1372. using ContentReceiver =
  1373. std::function<bool(const char *data, size_t data_length)>;
  1374. using FormDataHeader = std::function<bool(const FormData &file)>;
  1375. class ContentReader {
  1376. public:
  1377. using Reader = std::function<bool(ContentReceiver receiver)>;
  1378. using FormDataReader =
  1379. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1380. ContentReader(Reader reader, FormDataReader multipart_reader)
  1381. : reader_(std::move(reader)),
  1382. formdata_reader_(std::move(multipart_reader)) {}
  1383. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1384. return formdata_reader_(std::move(header), std::move(receiver));
  1385. }
  1386. bool operator()(ContentReceiver receiver) const {
  1387. return reader_(std::move(receiver));
  1388. }
  1389. Reader reader_;
  1390. FormDataReader formdata_reader_;
  1391. };
  1392. using Range = std::pair<ssize_t, ssize_t>;
  1393. using Ranges = std::vector<Range>;
  1394. #ifdef CPPHTTPLIB_SSL_ENABLED
  1395. // TLS abstraction layer - public type definitions and API
  1396. namespace tls {
  1397. // Opaque handles (defined as void* for abstraction)
  1398. using ctx_t = void *;
  1399. using session_t = void *;
  1400. using const_session_t = const void *; // For read-only session access
  1401. using cert_t = void *;
  1402. using ca_store_t = void *;
  1403. // TLS versions
  1404. enum class Version {
  1405. TLS1_2 = 0x0303,
  1406. TLS1_3 = 0x0304,
  1407. };
  1408. // Subject Alternative Names (SAN) entry types
  1409. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1410. // SAN entry structure
  1411. struct SanEntry {
  1412. SanType type;
  1413. std::string value;
  1414. };
  1415. // Verification context for certificate verification callback
  1416. struct VerifyContext {
  1417. session_t session; // TLS session handle
  1418. cert_t cert; // Current certificate being verified
  1419. int depth; // Certificate chain depth (0 = leaf)
  1420. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1421. long error_code; // Backend-specific error code (0 = no error)
  1422. const char *error_string; // Human-readable error description
  1423. // Certificate introspection methods
  1424. std::string subject_cn() const;
  1425. std::string issuer_name() const;
  1426. bool check_hostname(const char *hostname) const;
  1427. std::vector<SanEntry> sans() const;
  1428. bool validity(time_t &not_before, time_t &not_after) const;
  1429. std::string serial() const;
  1430. };
  1431. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1432. // TlsError codes for TLS operations (backend-independent)
  1433. enum class ErrorCode : int {
  1434. Success = 0,
  1435. WantRead, // Non-blocking: need to wait for read
  1436. WantWrite, // Non-blocking: need to wait for write
  1437. PeerClosed, // Peer closed the connection
  1438. Fatal, // Unrecoverable error
  1439. SyscallError, // System call error (check sys_errno)
  1440. CertVerifyFailed, // Certificate verification failed
  1441. HostnameMismatch, // Hostname verification failed
  1442. };
  1443. // TLS error information
  1444. struct TlsError {
  1445. ErrorCode code = ErrorCode::Fatal;
  1446. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1447. int sys_errno = 0; // errno when SyscallError
  1448. // Convert verification error code to human-readable string
  1449. static std::string verify_error_to_string(long error_code);
  1450. };
  1451. // RAII wrapper for peer certificate
  1452. class PeerCert {
  1453. public:
  1454. PeerCert();
  1455. PeerCert(PeerCert &&other) noexcept;
  1456. PeerCert &operator=(PeerCert &&other) noexcept;
  1457. ~PeerCert();
  1458. PeerCert(const PeerCert &) = delete;
  1459. PeerCert &operator=(const PeerCert &) = delete;
  1460. explicit operator bool() const;
  1461. std::string subject_cn() const;
  1462. std::string issuer_name() const;
  1463. bool check_hostname(const char *hostname) const;
  1464. std::vector<SanEntry> sans() const;
  1465. bool validity(time_t &not_before, time_t &not_after) const;
  1466. std::string serial() const;
  1467. private:
  1468. explicit PeerCert(cert_t cert);
  1469. cert_t cert_ = nullptr;
  1470. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1471. };
  1472. // Callback for TLS context setup (used by SSLServer constructor)
  1473. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1474. } // namespace tls
  1475. #endif
  1476. struct Request {
  1477. std::string method;
  1478. std::string path;
  1479. std::string matched_route;
  1480. Params params;
  1481. Headers headers;
  1482. Headers trailers;
  1483. std::string body;
  1484. std::string remote_addr;
  1485. int remote_port = -1;
  1486. std::string local_addr;
  1487. int local_port = -1;
  1488. // for server
  1489. std::string version;
  1490. std::string target;
  1491. MultipartFormData form;
  1492. Ranges ranges;
  1493. Match matches;
  1494. std::unordered_map<std::string, std::string> path_params;
  1495. std::function<bool()> is_connection_closed = []() { return true; };
  1496. // for client
  1497. std::vector<std::string> accept_content_types;
  1498. ResponseHandler response_handler;
  1499. ContentReceiverWithProgress content_receiver;
  1500. DownloadProgress download_progress;
  1501. UploadProgress upload_progress;
  1502. bool has_header(const std::string &key) const;
  1503. std::string get_header_value(const std::string &key, const char *def = "",
  1504. size_t id = 0) const;
  1505. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1506. size_t id = 0) const;
  1507. size_t get_header_value_count(const std::string &key) const;
  1508. void set_header(const std::string &key, const std::string &val);
  1509. bool has_trailer(const std::string &key) const;
  1510. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1511. size_t get_trailer_value_count(const std::string &key) const;
  1512. bool has_param(const std::string &key) const;
  1513. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1514. std::vector<std::string> get_param_values(const std::string &key) const;
  1515. size_t get_param_value_count(const std::string &key) const;
  1516. bool is_multipart_form_data() const;
  1517. // private members...
  1518. bool body_consumed_ = false;
  1519. bool expect_100_continue_pending_ = false;
  1520. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1521. size_t content_length_ = 0;
  1522. ContentProvider content_provider_;
  1523. bool is_chunked_content_provider_ = false;
  1524. size_t authorization_count_ = 0;
  1525. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1526. (std::chrono::steady_clock::time_point::min)();
  1527. #ifdef CPPHTTPLIB_SSL_ENABLED
  1528. tls::const_session_t ssl = nullptr;
  1529. tls::PeerCert peer_cert() const;
  1530. std::string sni() const;
  1531. #endif
  1532. };
  1533. namespace detail {
  1534. // Declared up here, away from the rest of the compression helpers, because
  1535. // `Response` stores one.
  1536. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1537. } // namespace detail
  1538. struct Response {
  1539. std::string version;
  1540. int status = -1;
  1541. std::string reason;
  1542. Headers headers;
  1543. Headers trailers;
  1544. std::string body;
  1545. std::string location; // Redirect location
  1546. // User-defined context — set by pre-routing/pre-request handlers and read
  1547. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1548. UserData user_data;
  1549. bool has_header(const std::string &key) const;
  1550. std::string get_header_value(const std::string &key, const char *def = "",
  1551. size_t id = 0) const;
  1552. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1553. size_t id = 0) const;
  1554. size_t get_header_value_count(const std::string &key) const;
  1555. void set_header(const std::string &key, const std::string &val);
  1556. bool has_trailer(const std::string &key) const;
  1557. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1558. size_t get_trailer_value_count(const std::string &key) const;
  1559. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1560. void set_content(const char *s, size_t n, const std::string &content_type);
  1561. void set_content(const std::string &s, const std::string &content_type);
  1562. void set_content(std::string &&s, const std::string &content_type);
  1563. void set_content_provider(
  1564. size_t length, const std::string &content_type, ContentProvider provider,
  1565. ContentProviderResourceReleaser resource_releaser = nullptr);
  1566. void set_content_provider(
  1567. const std::string &content_type, ContentProviderWithoutLength provider,
  1568. ContentProviderResourceReleaser resource_releaser = nullptr);
  1569. void set_chunked_content_provider(
  1570. const std::string &content_type, ContentProviderWithoutLength provider,
  1571. ContentProviderResourceReleaser resource_releaser = nullptr);
  1572. void set_file_content(const std::string &path,
  1573. const std::string &content_type);
  1574. void set_file_content(const std::string &path);
  1575. Response() = default;
  1576. Response(const Response &) = default;
  1577. Response &operator=(const Response &) = default;
  1578. Response(Response &&) = default;
  1579. Response &operator=(Response &&) = default;
  1580. ~Response() {
  1581. if (content_provider_resource_releaser_) {
  1582. content_provider_resource_releaser_(content_provider_success_);
  1583. }
  1584. }
  1585. // private members...
  1586. size_t content_length_ = 0;
  1587. ContentProvider content_provider_;
  1588. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1589. bool is_chunked_content_provider_ = false;
  1590. bool is_file_content_provider_ = false;
  1591. bool content_provider_success_ = false;
  1592. std::string file_content_path_;
  1593. std::string file_content_content_type_;
  1594. // Content coding chosen for the response body, decided once so that the
  1595. // headers and the body cannot disagree: where the file is opened for a
  1596. // file-backed content provider (keeping the ETag honest), and in
  1597. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1598. // for every other kind of response.
  1599. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1600. };
  1601. enum class Error {
  1602. Success = 0,
  1603. Unknown,
  1604. Connection,
  1605. BindIPAddress,
  1606. Read,
  1607. Write,
  1608. ExceedRedirectCount,
  1609. Canceled,
  1610. SSLConnection,
  1611. SSLLoadingCerts,
  1612. SSLServerVerification,
  1613. SSLServerHostnameVerification,
  1614. UnsupportedMultipartBoundaryChars,
  1615. Compression,
  1616. ConnectionTimeout,
  1617. ProxyConnection,
  1618. ConnectionClosed,
  1619. Timeout,
  1620. ResourceExhaustion,
  1621. TooManyFormDataFiles,
  1622. ExceedMaxPayloadSize,
  1623. ExceedUriMaxLength,
  1624. ExceedMaxSocketDescriptorCount,
  1625. InvalidRequestLine,
  1626. InvalidHTTPMethod,
  1627. InvalidHTTPVersion,
  1628. InvalidHeaders,
  1629. MultipartParsing,
  1630. OpenFile,
  1631. Listen,
  1632. GetSockName,
  1633. UnsupportedAddressFamily,
  1634. HTTPParsing,
  1635. InvalidRangeHeader,
  1636. UnsupportedContentEncoding,
  1637. WebSocketHandshake,
  1638. UserCallbackException,
  1639. // For internal use only
  1640. SSLPeerCouldBeClosed_,
  1641. };
  1642. std::string to_string(Error error);
  1643. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1644. class Stream {
  1645. public:
  1646. virtual ~Stream() = default;
  1647. virtual bool is_readable() const = 0;
  1648. virtual bool wait_readable() const = 0;
  1649. virtual bool wait_writable() const = 0;
  1650. virtual bool is_peer_alive() const { return wait_writable(); }
  1651. virtual ssize_t read(char *ptr, size_t size) = 0;
  1652. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1653. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1654. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1655. virtual socket_t socket() const = 0;
  1656. virtual time_t duration() const = 0;
  1657. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1658. (void)sec;
  1659. (void)usec;
  1660. }
  1661. // Bytes already pulled off the socket and sitting in this stream's own
  1662. // buffer. Exposing them lets a line reader scan for a terminator in one
  1663. // pass instead of asking for a byte at a time. A stream that does no
  1664. // buffering of its own reports none, and readers fall back to read().
  1665. virtual const char *buffered_data(size_t &size) const {
  1666. size = 0;
  1667. return nullptr;
  1668. }
  1669. // Discards `size` bytes previously returned by buffered_data().
  1670. virtual void consume_buffered(size_t size) { (void)size; }
  1671. ssize_t write(const char *ptr);
  1672. ssize_t write(const std::string &s);
  1673. Error get_error() const { return error_; }
  1674. protected:
  1675. Error error_ = Error::Success;
  1676. };
  1677. class TaskQueue {
  1678. public:
  1679. TaskQueue() = default;
  1680. virtual ~TaskQueue() = default;
  1681. virtual bool enqueue(std::function<void()> fn) = 0;
  1682. virtual void shutdown() = 0;
  1683. virtual void on_idle() {}
  1684. };
  1685. class ThreadPool final : public TaskQueue {
  1686. public:
  1687. explicit ThreadPool(
  1688. size_t n, size_t max_n = 0, size_t mqr = 0,
  1689. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1690. ThreadPool(const ThreadPool &) = delete;
  1691. ~ThreadPool() override = default;
  1692. bool enqueue(std::function<void()> fn) override;
  1693. void shutdown() override;
  1694. private:
  1695. void worker(bool is_dynamic);
  1696. void move_to_finished(std::thread::id id);
  1697. void cleanup_finished_threads();
  1698. size_t base_thread_count_;
  1699. size_t max_thread_count_;
  1700. size_t max_queued_requests_;
  1701. time_t idle_timeout_sec_;
  1702. size_t idle_thread_count_;
  1703. bool shutdown_;
  1704. std::list<std::function<void()>> jobs_;
  1705. std::vector<std::thread> threads_; // base threads
  1706. std::list<std::thread> dynamic_threads_; // dynamic threads
  1707. std::vector<std::thread>
  1708. finished_threads_; // exited dynamic threads awaiting join
  1709. std::condition_variable cond_;
  1710. std::mutex mutex_;
  1711. };
  1712. using Logger = std::function<void(const Request &, const Response &)>;
  1713. // Forward declaration for Error type
  1714. enum class Error;
  1715. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1716. using SocketOptions = std::function<void(socket_t sock)>;
  1717. void default_socket_options(socket_t sock);
  1718. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1719. const char *status_message(int status);
  1720. std::string to_string(Error error);
  1721. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1722. std::string get_bearer_token_auth(const Request &req);
  1723. namespace detail {
  1724. class MatcherBase {
  1725. public:
  1726. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1727. virtual ~MatcherBase() = default;
  1728. const std::string &pattern() const { return pattern_; }
  1729. // Match request path and populate its matches and
  1730. virtual bool match(Request &request) const = 0;
  1731. private:
  1732. std::string pattern_;
  1733. };
  1734. /**
  1735. * Captures parameters in request path and stores them in Request::path_params
  1736. *
  1737. * Capture name is a substring of a pattern from : to /.
  1738. * The rest of the pattern is matched against the request path directly
  1739. * Parameters are captured starting from the next character after
  1740. * the end of the last matched static pattern fragment until the next /.
  1741. *
  1742. * Example pattern:
  1743. * "/path/fragments/:capture/more/fragments/:second_capture"
  1744. * Static fragments:
  1745. * "/path/fragments/", "more/fragments/"
  1746. *
  1747. * Given the following request path:
  1748. * "/path/fragments/:1/more/fragments/:2"
  1749. * the resulting capture will be
  1750. * {{"capture", "1"}, {"second_capture", "2"}}
  1751. */
  1752. class PathParamsMatcher final : public MatcherBase {
  1753. public:
  1754. PathParamsMatcher(const std::string &pattern);
  1755. bool match(Request &request) const override;
  1756. private:
  1757. // Treat segment separators as the end of path parameter capture
  1758. // Does not need to handle query parameters as they are parsed before path
  1759. // matching
  1760. static constexpr char separator = '/';
  1761. // Contains static path fragments to match against, excluding the '/' after
  1762. // path params
  1763. // Fragments are separated by path params
  1764. std::vector<std::string> static_fragments_;
  1765. // Stores the names of the path parameters to be used as keys in the
  1766. // Request::path_params map
  1767. std::vector<std::string> param_names_;
  1768. };
  1769. /**
  1770. * Performs std::regex_match on request path
  1771. * and stores the result in Request::matches
  1772. *
  1773. * Note that regex match is performed directly on the whole request.
  1774. * This means that wildcard patterns may match multiple path segments with /:
  1775. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1776. */
  1777. class RegexMatcher final : public MatcherBase {
  1778. public:
  1779. RegexMatcher(const std::string &pattern)
  1780. : MatcherBase(pattern), regex_(pattern) {}
  1781. bool match(Request &request) const override;
  1782. private:
  1783. std::regex regex_;
  1784. };
  1785. int close_socket(socket_t sock) noexcept;
  1786. bool is_accept_resource_error();
  1787. bool is_accept_transient_error();
  1788. ssize_t write_headers(Stream &strm, const Headers &headers);
  1789. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1790. time_t usec);
  1791. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1792. const std::string &boundary);
  1793. ContentProvider
  1794. make_multipart_content_provider(const UploadFormDataItems &items,
  1795. const std::string &boundary);
  1796. } // namespace detail
  1797. bool is_valid_multipart_boundary(const std::string &boundary);
  1798. // Serializer for multipart/form-data request bodies. The boundary is owned
  1799. // by the writer so that per-part framing and the final terminator always
  1800. // agree. Field names and filenames are escaped following the WHATWG HTML
  1801. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1802. // in content types.
  1803. class MultipartFormDataWriter {
  1804. public:
  1805. MultipartFormDataWriter();
  1806. // precondition: is_valid_multipart_boundary(boundary)
  1807. explicit MultipartFormDataWriter(std::string boundary);
  1808. const std::string &boundary() const;
  1809. std::string content_type() const;
  1810. // In-memory items -> whole body (known length)
  1811. std::string serialize(const UploadFormDataItems &items) const;
  1812. size_t content_length(const UploadFormDataItems &items) const;
  1813. // Per-part framing for streaming via a content provider
  1814. std::string item_begin(const UploadFormData &item) const;
  1815. static std::string item_end();
  1816. std::string finish() const;
  1817. private:
  1818. std::string boundary_;
  1819. };
  1820. class Server {
  1821. public:
  1822. using Handler = std::function<void(const Request &, Response &)>;
  1823. using ExceptionHandler =
  1824. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1825. enum class HandlerResponse {
  1826. Handled,
  1827. Unhandled,
  1828. };
  1829. using HandlerWithResponse =
  1830. std::function<HandlerResponse(const Request &, Response &)>;
  1831. using HandlerWithContentReader = std::function<void(
  1832. const Request &, Response &, const ContentReader &content_reader)>;
  1833. using Expect100ContinueHandler =
  1834. std::function<int(const Request &, Response &)>;
  1835. using StartHandler = std::function<void()>;
  1836. using WebSocketHandler =
  1837. std::function<void(const Request &, ws::WebSocket &)>;
  1838. using SubProtocolSelector =
  1839. std::function<std::string(const std::vector<std::string> &protocols)>;
  1840. Server();
  1841. virtual ~Server();
  1842. virtual bool is_valid() const;
  1843. Server &Get(const std::string &pattern, Handler handler);
  1844. Server &Post(const std::string &pattern, Handler handler);
  1845. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1846. Server &Put(const std::string &pattern, Handler handler);
  1847. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1848. Server &Patch(const std::string &pattern, Handler handler);
  1849. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1850. Server &Delete(const std::string &pattern, Handler handler);
  1851. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1852. Server &Options(const std::string &pattern, Handler handler);
  1853. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1854. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1855. // server accept it; an unregistered method is still rejected with 400.
  1856. // `method` must be a valid HTTP method token and must not be one of the
  1857. // built-in methods, which have their own registration functions above. A
  1858. // rejected registration makes is_valid() return false, so listen() fails.
  1859. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1860. Handler handler);
  1861. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1862. HandlerWithContentReader handler);
  1863. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1864. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1865. SubProtocolSelector sub_protocol_selector);
  1866. bool set_base_dir(const std::string &dir,
  1867. const std::string &mount_point = std::string());
  1868. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1869. Headers headers = Headers());
  1870. bool remove_mount_point(const std::string &mount_point);
  1871. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1872. const std::string &mime);
  1873. Server &set_default_file_mimetype(const std::string &mime);
  1874. Server &set_file_request_handler(Handler handler);
  1875. template <class ErrorHandlerFunc>
  1876. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1877. return set_error_handler_core(
  1878. std::forward<ErrorHandlerFunc>(handler),
  1879. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1880. }
  1881. Server &set_exception_handler(ExceptionHandler handler);
  1882. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1883. Server &set_post_routing_handler(Handler handler);
  1884. Server &set_pre_request_handler(HandlerWithResponse handler);
  1885. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1886. Server &set_start_handler(StartHandler handler);
  1887. Server &set_logger(Logger logger);
  1888. Server &set_pre_compression_logger(Logger logger);
  1889. Server &set_error_logger(ErrorLogger error_logger);
  1890. Server &set_address_family(int family);
  1891. Server &set_tcp_nodelay(bool on);
  1892. Server &set_ipv6_v6only(bool on);
  1893. Server &set_socket_options(SocketOptions socket_options);
  1894. Server &set_default_headers(Headers headers);
  1895. Server &
  1896. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1897. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1898. Server &set_keep_alive_max_count(size_t count);
  1899. Server &set_keep_alive_timeout(time_t sec);
  1900. template <class Rep, class Period>
  1901. Server &
  1902. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1903. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1904. template <class Rep, class Period>
  1905. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1906. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1907. template <class Rep, class Period>
  1908. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1909. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1910. template <class Rep, class Period>
  1911. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1912. Server &set_payload_max_length(size_t length);
  1913. Server &set_static_file_compression(bool on);
  1914. Server &set_static_file_compression_min_length(size_t length);
  1915. Server &set_static_file_compression_max_length(size_t length);
  1916. Server &set_websocket_ping_interval(time_t sec);
  1917. template <class Rep, class Period>
  1918. Server &set_websocket_ping_interval(
  1919. const std::chrono::duration<Rep, Period> &duration);
  1920. Server &set_websocket_max_missed_pongs(int count);
  1921. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1922. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1923. bool listen_after_bind();
  1924. bool listen(const std::string &host, int port, int socket_flags = 0);
  1925. bool is_running() const;
  1926. void wait_until_ready() const;
  1927. void stop() noexcept;
  1928. void decommission();
  1929. std::function<TaskQueue *(void)> new_task_queue;
  1930. protected:
  1931. bool process_request(Stream &strm, const std::string &remote_addr,
  1932. int remote_port, const std::string &local_addr,
  1933. int local_port, bool close_connection,
  1934. bool &connection_closed,
  1935. const std::function<void(Request &)> &setup_request,
  1936. bool *websocket_upgraded = nullptr);
  1937. // Runs the per-connection serving loop and stops an exception thrown by a
  1938. // user callback from escaping the worker thread.
  1939. //
  1940. // process_request() wraps only routing() in a try/catch. Content providers,
  1941. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1942. // handlers all run outside it, and the task queue calls the job without a
  1943. // catch, so an exception from any of those would terminate the process.
  1944. //
  1945. // No 500 is possible here: by the time a content provider runs, the status
  1946. // line and headers are already on the wire. Report it through the error
  1947. // logger and drop the connection, which is what the peer observes either
  1948. // way. Other connections are unaffected.
  1949. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1950. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1951. return serve();
  1952. #else
  1953. try {
  1954. return serve();
  1955. } catch (...) {
  1956. // The error logger is a user callback too, so it must not be able to
  1957. // throw the guard back open.
  1958. try {
  1959. output_error_log(Error::UserCallbackException, nullptr);
  1960. } catch (...) {}
  1961. return false;
  1962. }
  1963. #endif
  1964. }
  1965. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1966. std::vector<std::string> trusted_proxies_;
  1967. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1968. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1969. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1970. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1971. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1972. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1973. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1974. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1975. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1976. bool static_file_compression_ = false;
  1977. size_t static_file_compression_min_length_ =
  1978. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1979. size_t static_file_compression_max_length_ =
  1980. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1981. time_t websocket_ping_interval_sec_ =
  1982. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1983. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1984. private:
  1985. using Handlers =
  1986. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1987. using HandlersForContentReader =
  1988. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1989. HandlerWithContentReader>>;
  1990. // Both handler tables for one custom method live in a single entry, so that
  1991. // routing() needs only one map lookup per request to reach either of them.
  1992. struct CustomHandlerEntry {
  1993. Handlers handlers;
  1994. HandlersForContentReader handlers_for_content_reader;
  1995. };
  1996. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1997. static std::unique_ptr<detail::MatcherBase>
  1998. make_matcher(const std::string &pattern);
  1999. static const std::set<std::string> &builtin_methods();
  2000. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2001. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2002. template <typename H>
  2003. Server &add_handler(
  2004. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2005. const std::string &pattern, H handler) {
  2006. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2007. return *this;
  2008. }
  2009. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2010. Server &set_error_handler_core(Handler handler, std::false_type);
  2011. socket_t create_server_socket(const std::string &host, int port,
  2012. int socket_flags,
  2013. SocketOptions socket_options) const;
  2014. int bind_internal(const std::string &host, int port, int socket_flags);
  2015. bool listen_internal();
  2016. bool routing(Request &req, Response &res, Stream &strm);
  2017. bool handle_file_request(Request &req, Response &res);
  2018. bool check_if_not_modified(const Request &req, Response &res,
  2019. const std::string &etag, time_t mtime) const;
  2020. bool check_if_range(Request &req, const std::string &etag,
  2021. time_t mtime) const;
  2022. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2023. Stream &strm);
  2024. bool dispatch_request_for_content_reader(
  2025. Request &req, Response &res, ContentReader content_reader,
  2026. const HandlersForContentReader &handlers) const;
  2027. bool parse_request_line(const char *s, Request &req) const;
  2028. detail::EncodingType static_file_encoding(const Request &req,
  2029. const Response &res,
  2030. const std::string &content_type,
  2031. size_t length) const;
  2032. bool apply_static_file_compression(const Request &req, Response &res) const;
  2033. void apply_ranges(const Request &req, Response &res,
  2034. std::string &content_type, std::string &boundary) const;
  2035. bool write_response(Stream &strm, bool close_connection, Request &req,
  2036. Response &res);
  2037. bool write_response_with_content(Stream &strm, bool close_connection,
  2038. const Request &req, Response &res);
  2039. bool write_response_core(Stream &strm, bool close_connection,
  2040. const Request &req, Response &res,
  2041. bool need_apply_ranges);
  2042. bool write_content_with_provider(Stream &strm, const Request &req,
  2043. Response &res, const std::string &boundary,
  2044. const std::string &content_type);
  2045. bool read_content(Stream &strm, Request &req, Response &res);
  2046. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2047. Response &res,
  2048. ContentReceiver receiver,
  2049. FormDataHeader multipart_header,
  2050. ContentReceiver multipart_receiver);
  2051. bool read_content_core(Stream &strm, Request &req, Response &res,
  2052. ContentReceiver receiver,
  2053. FormDataHeader multipart_header,
  2054. ContentReceiver multipart_receiver) const;
  2055. virtual bool process_and_close_socket(socket_t sock);
  2056. void output_log(const Request &req, const Response &res) const;
  2057. void output_pre_compression_log(const Request &req,
  2058. const Response &res) const;
  2059. void output_error_log(const Error &err, const Request *req) const;
  2060. std::atomic<bool> is_running_{false};
  2061. std::atomic<bool> is_decommissioned{false};
  2062. // Set when CustomRoute() refuses a registration. Written before listen(),
  2063. // read by is_valid() on the same thread, so it needs no synchronization.
  2064. bool has_invalid_registration_ = false;
  2065. struct MountPointEntry {
  2066. std::string mount_point;
  2067. std::string base_dir;
  2068. std::string resolved_base_dir;
  2069. Headers headers;
  2070. };
  2071. std::vector<MountPointEntry> base_dirs_;
  2072. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2073. std::string default_file_mimetype_ = "application/octet-stream";
  2074. Handler file_request_handler_;
  2075. Handlers get_handlers_;
  2076. Handlers post_handlers_;
  2077. HandlersForContentReader post_handlers_for_content_reader_;
  2078. Handlers put_handlers_;
  2079. HandlersForContentReader put_handlers_for_content_reader_;
  2080. Handlers patch_handlers_;
  2081. HandlersForContentReader patch_handlers_for_content_reader_;
  2082. Handlers delete_handlers_;
  2083. HandlersForContentReader delete_handlers_for_content_reader_;
  2084. Handlers options_handlers_;
  2085. CustomHandlers custom_handlers_;
  2086. struct WebSocketHandlerEntry {
  2087. std::unique_ptr<detail::MatcherBase> matcher;
  2088. WebSocketHandler handler;
  2089. SubProtocolSelector sub_protocol_selector;
  2090. };
  2091. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2092. WebSocketHandlers websocket_handlers_;
  2093. HandlerWithResponse error_handler_;
  2094. ExceptionHandler exception_handler_;
  2095. HandlerWithResponse pre_routing_handler_;
  2096. Handler post_routing_handler_;
  2097. HandlerWithResponse pre_request_handler_;
  2098. Expect100ContinueHandler expect_100_continue_handler_;
  2099. StartHandler start_handler_;
  2100. mutable std::mutex logger_mutex_;
  2101. Logger logger_;
  2102. Logger pre_compression_logger_;
  2103. ErrorLogger error_logger_;
  2104. int address_family_ = AF_UNSPEC;
  2105. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2106. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2107. SocketOptions socket_options_ = default_socket_options;
  2108. Headers default_headers_;
  2109. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2110. detail::write_headers;
  2111. };
  2112. class Result {
  2113. public:
  2114. Result() = default;
  2115. Result(std::unique_ptr<Response> &&res, Error err,
  2116. Headers &&request_headers = Headers{})
  2117. : res_(std::move(res)), err_(err),
  2118. request_headers_(std::move(request_headers)) {}
  2119. // Response
  2120. operator bool() const { return res_ != nullptr; }
  2121. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2122. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2123. const Response &value() const { return *res_; }
  2124. Response &value() { return *res_; }
  2125. const Response &operator*() const { return *res_; }
  2126. Response &operator*() { return *res_; }
  2127. const Response *operator->() const { return res_.get(); }
  2128. Response *operator->() { return res_.get(); }
  2129. // Error
  2130. Error error() const { return err_; }
  2131. // Request Headers
  2132. bool has_request_header(const std::string &key) const;
  2133. std::string get_request_header_value(const std::string &key,
  2134. const char *def = "",
  2135. size_t id = 0) const;
  2136. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2137. size_t id = 0) const;
  2138. size_t get_request_header_value_count(const std::string &key) const;
  2139. private:
  2140. std::unique_ptr<Response> res_;
  2141. Error err_ = Error::Unknown;
  2142. Headers request_headers_;
  2143. #ifdef CPPHTTPLIB_SSL_ENABLED
  2144. public:
  2145. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2146. int ssl_error)
  2147. : res_(std::move(res)), err_(err),
  2148. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2149. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2150. int ssl_error, uint64_t ssl_backend_error)
  2151. : res_(std::move(res)), err_(err),
  2152. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2153. ssl_backend_error_(ssl_backend_error) {}
  2154. int ssl_error() const { return ssl_error_; }
  2155. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2156. private:
  2157. int ssl_error_ = 0;
  2158. uint64_t ssl_backend_error_ = 0;
  2159. #endif
  2160. };
  2161. struct ClientConnection {
  2162. socket_t sock = INVALID_SOCKET;
  2163. bool is_open() const { return sock != INVALID_SOCKET; }
  2164. ClientConnection() = default;
  2165. ~ClientConnection();
  2166. ClientConnection(const ClientConnection &) = delete;
  2167. ClientConnection &operator=(const ClientConnection &) = delete;
  2168. ClientConnection(ClientConnection &&other) noexcept
  2169. : sock(other.sock)
  2170. #ifdef CPPHTTPLIB_SSL_ENABLED
  2171. ,
  2172. session(other.session)
  2173. #endif
  2174. {
  2175. other.sock = INVALID_SOCKET;
  2176. #ifdef CPPHTTPLIB_SSL_ENABLED
  2177. other.session = nullptr;
  2178. #endif
  2179. }
  2180. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2181. if (this != &other) {
  2182. sock = other.sock;
  2183. other.sock = INVALID_SOCKET;
  2184. #ifdef CPPHTTPLIB_SSL_ENABLED
  2185. session = other.session;
  2186. other.session = nullptr;
  2187. #endif
  2188. }
  2189. return *this;
  2190. }
  2191. #ifdef CPPHTTPLIB_SSL_ENABLED
  2192. tls::session_t session = nullptr;
  2193. #endif
  2194. };
  2195. namespace detail {
  2196. struct ChunkedDecoder;
  2197. struct BodyReader {
  2198. Stream *stream = nullptr;
  2199. bool has_content_length = false;
  2200. size_t content_length = 0;
  2201. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2202. size_t bytes_read = 0;
  2203. bool chunked = false;
  2204. bool eof = false;
  2205. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2206. Error last_error = Error::Success;
  2207. ssize_t read(char *buf, size_t len);
  2208. bool has_error() const { return last_error != Error::Success; }
  2209. };
  2210. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2211. size_t len) {
  2212. (void)stream;
  2213. return br.read(buf, len);
  2214. }
  2215. class decompressor;
  2216. enum class NoProxyKind {
  2217. Wildcard, // "*"
  2218. HostnameSuffix, // "example.com" or ".example.com"
  2219. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2220. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2221. };
  2222. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2223. // Lets one CIDR matcher cover both families.
  2224. using IPBytes = std::array<uint8_t, 16>;
  2225. struct NoProxyEntry {
  2226. NoProxyKind kind = NoProxyKind::Wildcard;
  2227. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2228. IPBytes net{};
  2229. int prefix_bits = 0;
  2230. };
  2231. struct NormalizedTarget {
  2232. std::string hostname; // lowercase; brackets and trailing dot removed
  2233. bool is_ipv4 = false;
  2234. bool is_ipv6 = false;
  2235. IPBytes ip{};
  2236. };
  2237. } // namespace detail
  2238. class ClientImpl {
  2239. public:
  2240. explicit ClientImpl(const std::string &host);
  2241. explicit ClientImpl(const std::string &host, int port);
  2242. explicit ClientImpl(const std::string &host, int port,
  2243. const std::string &client_cert_path,
  2244. const std::string &client_key_path);
  2245. virtual ~ClientImpl();
  2246. virtual bool is_valid() const;
  2247. struct StreamHandle {
  2248. std::unique_ptr<Response> response;
  2249. Error error = Error::Success;
  2250. StreamHandle() = default;
  2251. StreamHandle(const StreamHandle &) = delete;
  2252. StreamHandle &operator=(const StreamHandle &) = delete;
  2253. StreamHandle(StreamHandle &&) = default;
  2254. StreamHandle &operator=(StreamHandle &&) = default;
  2255. ~StreamHandle() = default;
  2256. bool is_valid() const {
  2257. return response != nullptr && error == Error::Success;
  2258. }
  2259. ssize_t read(char *buf, size_t len);
  2260. void parse_trailers_if_needed();
  2261. Error get_read_error() const { return body_reader_.last_error; }
  2262. bool has_read_error() const { return body_reader_.has_error(); }
  2263. bool trailers_parsed_ = false;
  2264. private:
  2265. friend class ClientImpl;
  2266. ssize_t read_with_decompression(char *buf, size_t len);
  2267. std::unique_ptr<ClientConnection> connection_;
  2268. std::unique_ptr<Stream> socket_stream_;
  2269. Stream *stream_ = nullptr;
  2270. detail::BodyReader body_reader_;
  2271. std::unique_ptr<detail::decompressor> decompressor_;
  2272. std::string decompress_buffer_;
  2273. size_t decompress_offset_ = 0;
  2274. size_t decompressed_bytes_read_ = 0;
  2275. };
  2276. // clang-format off
  2277. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2278. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2279. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2280. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2281. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2282. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2283. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2284. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2285. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2286. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2287. Result Head(const std::string &path);
  2288. Result Head(const std::string &path, const Headers &headers);
  2289. Result Post(const std::string &path);
  2290. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2291. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2292. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2293. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2294. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2295. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2296. Result Post(const std::string &path, const Params &params);
  2297. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2298. Result Post(const std::string &path, const Headers &headers);
  2299. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2300. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2301. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2302. 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);
  2303. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2304. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2305. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2306. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2307. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2308. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2309. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2310. Result Put(const std::string &path);
  2311. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2312. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2313. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2314. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2315. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2316. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2317. Result Put(const std::string &path, const Params &params);
  2318. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2319. Result Put(const std::string &path, const Headers &headers);
  2320. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2321. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2322. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2323. 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);
  2324. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2325. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2326. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2327. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2328. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2329. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2330. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2331. Result Patch(const std::string &path);
  2332. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2333. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2334. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2335. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2336. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2338. Result Patch(const std::string &path, const Params &params);
  2339. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2340. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2341. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2343. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2344. 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);
  2345. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2346. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2347. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2348. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2349. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2350. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2351. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2352. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2353. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2354. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2355. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2356. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2357. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2358. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2359. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2360. Result Options(const std::string &path);
  2361. Result Options(const std::string &path, const Headers &headers);
  2362. // clang-format on
  2363. // Streaming API: Open a stream for reading response body incrementally
  2364. // Socket ownership is transferred to StreamHandle for true streaming
  2365. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2366. StreamHandle open_stream(const std::string &method, const std::string &path,
  2367. const Params &params = {},
  2368. const Headers &headers = {},
  2369. const std::string &body = {},
  2370. const std::string &content_type = {});
  2371. bool send(Request &req, Response &res, Error &error);
  2372. Result send(const Request &req);
  2373. void stop();
  2374. std::string host() const;
  2375. int port() const;
  2376. size_t is_socket_open() const;
  2377. socket_t socket() const;
  2378. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2379. void set_default_headers(Headers headers);
  2380. void
  2381. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2382. void set_address_family(int family);
  2383. void set_tcp_nodelay(bool on);
  2384. void set_ipv6_v6only(bool on);
  2385. void set_socket_options(SocketOptions socket_options);
  2386. void set_connection_timeout(time_t sec, time_t usec = 0);
  2387. template <class Rep, class Period>
  2388. void
  2389. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2390. void set_read_timeout(time_t sec, time_t usec = 0);
  2391. template <class Rep, class Period>
  2392. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2393. void set_write_timeout(time_t sec, time_t usec = 0);
  2394. template <class Rep, class Period>
  2395. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2396. void set_max_timeout(time_t msec);
  2397. template <class Rep, class Period>
  2398. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2399. void set_basic_auth(const std::string &username, const std::string &password);
  2400. void set_bearer_token_auth(const std::string &token);
  2401. void set_keep_alive(bool on);
  2402. void set_follow_location(bool on);
  2403. void set_path_encode(bool on);
  2404. void set_compress(bool on);
  2405. void set_decompress(bool on);
  2406. void set_payload_max_length(size_t length);
  2407. void set_interface(const std::string &intf);
  2408. void set_proxy(const std::string &host, int port);
  2409. void set_proxy_basic_auth(const std::string &username,
  2410. const std::string &password);
  2411. void set_proxy_bearer_token_auth(const std::string &token);
  2412. void set_no_proxy(const std::vector<std::string> &patterns);
  2413. void set_logger(Logger logger);
  2414. void set_error_logger(ErrorLogger error_logger);
  2415. protected:
  2416. struct Socket {
  2417. socket_t sock = INVALID_SOCKET;
  2418. // For Mbed TLS compatibility: start_time for request timeout tracking
  2419. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2420. bool is_open() const { return sock != INVALID_SOCKET; }
  2421. #ifdef CPPHTTPLIB_SSL_ENABLED
  2422. tls::session_t ssl = nullptr;
  2423. #endif
  2424. };
  2425. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2426. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2427. virtual bool setup_proxy_connection(
  2428. Socket &socket,
  2429. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2430. Response &res, bool &success, Error &error);
  2431. bool is_proxy_enabled_for_host(const std::string &host) const;
  2432. // All of:
  2433. // shutdown_ssl
  2434. // shutdown_socket
  2435. // close_socket
  2436. // disconnect
  2437. // should ONLY be called when socket_mutex_ is locked, and only when
  2438. // no other thread is using the socket.
  2439. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2440. void shutdown_socket(Socket &socket) const;
  2441. void close_socket(Socket &socket);
  2442. void disconnect(bool gracefully);
  2443. bool process_request(Stream &strm, Request &req, Response &res,
  2444. bool close_connection, Error &error);
  2445. bool write_content_with_provider(Stream &strm, const Request &req,
  2446. Error &error) const;
  2447. void copy_settings(const ClientImpl &rhs);
  2448. void output_log(const Request &req, const Response &res) const;
  2449. void output_error_log(const Error &err, const Request *req) const;
  2450. // Socket endpoint information
  2451. const std::string host_;
  2452. const int port_;
  2453. // Current open socket
  2454. Socket socket_;
  2455. mutable std::mutex socket_mutex_;
  2456. std::recursive_mutex request_mutex_;
  2457. // These are all protected under socket_mutex
  2458. size_t socket_requests_in_flight_ = 0;
  2459. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2460. bool socket_should_be_closed_when_request_is_done_ = false;
  2461. // Hostname to connection target map. The value is an IP literal or another
  2462. // hostname; only the connection target changes, never the identity.
  2463. std::map<std::string, std::string> addr_map_;
  2464. // Default headers
  2465. Headers default_headers_;
  2466. // Header writer
  2467. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2468. detail::write_headers;
  2469. // Settings
  2470. std::string client_cert_path_;
  2471. std::string client_key_path_;
  2472. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2473. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2474. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2475. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2476. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2477. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2478. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2479. std::string basic_auth_username_;
  2480. std::string basic_auth_password_;
  2481. std::string bearer_token_auth_token_;
  2482. bool keep_alive_ = false;
  2483. bool follow_location_ = false;
  2484. bool path_encode_ = true;
  2485. int address_family_ = AF_UNSPEC;
  2486. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2487. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2488. SocketOptions socket_options_ = nullptr;
  2489. bool compress_ = false;
  2490. bool decompress_ = true;
  2491. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2492. bool has_payload_max_length_ = false;
  2493. std::string interface_;
  2494. std::string proxy_host_;
  2495. int proxy_port_ = -1;
  2496. std::string proxy_basic_auth_username_;
  2497. std::string proxy_basic_auth_password_;
  2498. std::string proxy_bearer_token_auth_token_;
  2499. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2500. mutable detail::NormalizedTarget host_normalized_;
  2501. mutable bool host_normalized_valid_ = false;
  2502. mutable std::mutex logger_mutex_;
  2503. Logger logger_;
  2504. ErrorLogger error_logger_;
  2505. private:
  2506. bool send_(Request &req, Response &res, Error &error);
  2507. Result send_(Request &&req);
  2508. socket_t create_client_socket(Error &error) const;
  2509. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2510. bool skip_100_continue = true) const;
  2511. bool write_request(Stream &strm, Request &req, bool close_connection,
  2512. Error &error, bool skip_body, bool &rejected_locally);
  2513. bool write_request_body(Stream &strm, Request &req, Error &error);
  2514. void prepare_default_headers(Request &r, bool for_stream,
  2515. const std::string &ct);
  2516. bool redirect(Request &req, Response &res, Error &error);
  2517. bool create_redirect_client(const std::string &scheme,
  2518. const std::string &host, int port, Request &req,
  2519. Response &res, const std::string &path,
  2520. const std::string &location, Error &error);
  2521. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2522. bool handle_request(Stream &strm, Request &req, Response &res,
  2523. bool close_connection, Error &error);
  2524. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2525. Request &req, const char *body, size_t content_length,
  2526. ContentProvider content_provider,
  2527. ContentProviderWithoutLength content_provider_without_length,
  2528. const std::string &content_type, ContentReceiver content_receiver,
  2529. Error &error);
  2530. Result send_with_content_provider_and_receiver(
  2531. const std::string &method, const std::string &path,
  2532. const Headers &headers, const char *body, size_t content_length,
  2533. ContentProvider content_provider,
  2534. ContentProviderWithoutLength content_provider_without_length,
  2535. const std::string &content_type, ContentReceiver content_receiver,
  2536. UploadProgress progress);
  2537. ContentProviderWithoutLength get_multipart_content_provider(
  2538. const std::string &boundary, const UploadFormDataItems &items,
  2539. const FormDataProviderItems &provider_items) const;
  2540. virtual bool
  2541. process_socket(const Socket &socket,
  2542. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2543. std::function<bool(Stream &strm)> callback);
  2544. virtual bool is_ssl() const;
  2545. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2546. #ifdef CPPHTTPLIB_SSL_ENABLED
  2547. public:
  2548. void set_digest_auth(const std::string &username,
  2549. const std::string &password);
  2550. void set_proxy_digest_auth(const std::string &username,
  2551. const std::string &password);
  2552. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2553. const std::string &ca_cert_dir_path = std::string());
  2554. void enable_server_certificate_verification(bool enabled);
  2555. void enable_server_hostname_verification(bool enabled);
  2556. void enable_system_ca(bool enabled);
  2557. protected:
  2558. std::string digest_auth_username_;
  2559. std::string digest_auth_password_;
  2560. std::string proxy_digest_auth_username_;
  2561. std::string proxy_digest_auth_password_;
  2562. std::string ca_cert_file_path_;
  2563. std::string ca_cert_dir_path_;
  2564. bool server_certificate_verification_ = true;
  2565. bool server_hostname_verification_ = true;
  2566. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2567. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2568. int last_ssl_error_ = 0;
  2569. uint64_t last_backend_error_ = 0;
  2570. #endif
  2571. };
  2572. class Client {
  2573. public:
  2574. // Universal interface
  2575. explicit Client(const std::string &scheme_host_port);
  2576. explicit Client(const std::string &scheme_host_port,
  2577. const std::string &client_cert_path,
  2578. const std::string &client_key_path);
  2579. // HTTP only interface
  2580. explicit Client(const std::string &host, int port);
  2581. explicit Client(const std::string &host, int port,
  2582. const std::string &client_cert_path,
  2583. const std::string &client_key_path);
  2584. Client(Client &&) = default;
  2585. Client &operator=(Client &&) = default;
  2586. ~Client();
  2587. bool is_valid() const;
  2588. // clang-format off
  2589. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2590. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2591. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2592. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2593. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2594. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2595. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2596. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2597. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2598. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2599. Result Head(const std::string &path);
  2600. Result Head(const std::string &path, const Headers &headers);
  2601. Result Post(const std::string &path);
  2602. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2603. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2604. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2605. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2606. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2607. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2608. Result Post(const std::string &path, const Params &params);
  2609. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2610. Result Post(const std::string &path, const Headers &headers);
  2611. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2612. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2613. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2614. 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);
  2615. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2616. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2617. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2618. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2619. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2620. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2621. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2622. Result Put(const std::string &path);
  2623. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2624. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2625. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2626. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2627. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2628. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2629. Result Put(const std::string &path, const Params &params);
  2630. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2631. Result Put(const std::string &path, const Headers &headers);
  2632. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2633. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2634. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2635. 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);
  2636. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2637. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2638. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2639. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2640. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2641. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2642. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2643. Result Patch(const std::string &path);
  2644. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2645. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2646. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2647. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2648. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2649. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2650. Result Patch(const std::string &path, const Params &params);
  2651. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2652. Result Patch(const std::string &path, const Headers &headers);
  2653. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2654. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2655. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2656. 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);
  2657. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2658. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2659. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2660. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2661. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2662. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2663. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2664. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2665. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2666. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2667. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2668. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2669. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2670. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2671. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2672. Result Options(const std::string &path);
  2673. Result Options(const std::string &path, const Headers &headers);
  2674. // clang-format on
  2675. // Streaming API: Open a stream for reading response body incrementally
  2676. // Socket ownership is transferred to StreamHandle for true streaming
  2677. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2678. ClientImpl::StreamHandle open_stream(const std::string &method,
  2679. const std::string &path,
  2680. const Params &params = {},
  2681. const Headers &headers = {},
  2682. const std::string &body = {},
  2683. const std::string &content_type = {});
  2684. bool send(Request &req, Response &res, Error &error);
  2685. Result send(const Request &req);
  2686. void stop();
  2687. std::string host() const;
  2688. int port() const;
  2689. size_t is_socket_open() const;
  2690. socket_t socket() const;
  2691. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2692. void set_default_headers(Headers headers);
  2693. void
  2694. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2695. void set_address_family(int family);
  2696. void set_tcp_nodelay(bool on);
  2697. void set_socket_options(SocketOptions socket_options);
  2698. void set_connection_timeout(time_t sec, time_t usec = 0);
  2699. template <class Rep, class Period>
  2700. void
  2701. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2702. void set_read_timeout(time_t sec, time_t usec = 0);
  2703. template <class Rep, class Period>
  2704. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2705. void set_write_timeout(time_t sec, time_t usec = 0);
  2706. template <class Rep, class Period>
  2707. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2708. void set_max_timeout(time_t msec);
  2709. template <class Rep, class Period>
  2710. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2711. void set_basic_auth(const std::string &username, const std::string &password);
  2712. void set_bearer_token_auth(const std::string &token);
  2713. void set_keep_alive(bool on);
  2714. void set_follow_location(bool on);
  2715. void set_path_encode(bool on);
  2716. void set_compress(bool on);
  2717. void set_decompress(bool on);
  2718. void set_payload_max_length(size_t length);
  2719. void set_interface(const std::string &intf);
  2720. void set_proxy(const std::string &host, int port);
  2721. void set_proxy_basic_auth(const std::string &username,
  2722. const std::string &password);
  2723. void set_proxy_bearer_token_auth(const std::string &token);
  2724. void set_no_proxy(const std::vector<std::string> &patterns);
  2725. void set_logger(Logger logger);
  2726. void set_error_logger(ErrorLogger error_logger);
  2727. private:
  2728. std::unique_ptr<ClientImpl> cli_;
  2729. #ifdef CPPHTTPLIB_SSL_ENABLED
  2730. public:
  2731. void set_digest_auth(const std::string &username,
  2732. const std::string &password);
  2733. void set_proxy_digest_auth(const std::string &username,
  2734. const std::string &password);
  2735. void enable_server_certificate_verification(bool enabled);
  2736. void enable_server_hostname_verification(bool enabled);
  2737. void enable_system_ca(bool enabled);
  2738. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2739. const std::string &ca_cert_dir_path = std::string());
  2740. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2741. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2742. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2743. void set_session_verifier(
  2744. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2745. tls::ctx_t tls_context() const;
  2746. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2747. void enable_windows_certificate_verification(bool enabled);
  2748. #endif
  2749. private:
  2750. bool is_ssl_ = false;
  2751. #endif
  2752. };
  2753. #ifdef CPPHTTPLIB_SSL_ENABLED
  2754. class SSLServer : public Server {
  2755. public:
  2756. SSLServer(const char *cert_path, const char *private_key_path,
  2757. const char *client_ca_cert_file_path = nullptr,
  2758. const char *client_ca_cert_dir_path = nullptr,
  2759. const char *private_key_password = nullptr);
  2760. struct PemMemory {
  2761. const char *cert_pem;
  2762. size_t cert_pem_len;
  2763. const char *key_pem;
  2764. size_t key_pem_len;
  2765. const char *client_ca_pem;
  2766. size_t client_ca_pem_len;
  2767. const char *private_key_password;
  2768. };
  2769. explicit SSLServer(const PemMemory &pem);
  2770. // The callback receives the ctx_t handle which can be cast to the
  2771. // appropriate backend type (SSL_CTX* for OpenSSL,
  2772. // tls::impl::MbedTlsContext* for Mbed TLS)
  2773. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2774. ~SSLServer() override;
  2775. bool is_valid() const override;
  2776. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2777. const char *client_ca_pem = nullptr,
  2778. const char *password = nullptr);
  2779. tls::ctx_t tls_context() const { return ctx_; }
  2780. int ssl_last_error() const { return last_ssl_error_; }
  2781. private:
  2782. bool process_and_close_socket(socket_t sock) override;
  2783. tls::ctx_t ctx_ = nullptr;
  2784. std::mutex ctx_mutex_;
  2785. int last_ssl_error_ = 0;
  2786. };
  2787. class SSLClient final : public ClientImpl {
  2788. public:
  2789. explicit SSLClient(const std::string &host);
  2790. explicit SSLClient(const std::string &host, int port);
  2791. explicit SSLClient(const std::string &host, int port,
  2792. const std::string &client_cert_path,
  2793. const std::string &client_key_path,
  2794. const std::string &private_key_password = std::string());
  2795. struct PemMemory {
  2796. const char *cert_pem;
  2797. size_t cert_pem_len;
  2798. const char *key_pem;
  2799. size_t key_pem_len;
  2800. const char *private_key_password;
  2801. };
  2802. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2803. ~SSLClient() override;
  2804. bool is_valid() const override;
  2805. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2806. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2807. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2808. // Post-handshake session verifier (backend-independent)
  2809. void set_session_verifier(
  2810. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2811. tls::ctx_t tls_context() const { return ctx_; }
  2812. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2813. void enable_windows_certificate_verification(bool enabled);
  2814. #endif
  2815. private:
  2816. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2817. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2818. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2819. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2820. bool
  2821. process_socket(const Socket &socket,
  2822. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2823. std::function<bool(Stream &strm)> callback) override;
  2824. bool is_ssl() const override;
  2825. bool setup_proxy_connection(
  2826. Socket &socket,
  2827. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2828. Response &res, bool &success, Error &error) override;
  2829. bool connect_with_proxy(
  2830. Socket &sock,
  2831. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2832. Response &res, bool &success, Error &error);
  2833. bool initialize_ssl(Socket &socket, Error &error);
  2834. void init_ctx();
  2835. void reset_ctx_on_error();
  2836. bool load_certs();
  2837. tls::ctx_t ctx_ = nullptr;
  2838. std::mutex ctx_mutex_;
  2839. std::once_flag initialize_cert_;
  2840. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2841. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2842. // Used to keep custom CA configuration exclusive with system CA loading.
  2843. bool ca_cert_store_set_ = false;
  2844. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2845. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2846. bool enable_windows_cert_verification_ = true;
  2847. // Like ca_cert_store_set_, tracks what ctx_ cannot report back: whether
  2848. // set_server_certificate_verifier() installed a verifier.
  2849. bool server_certificate_verifier_set_ = false;
  2850. #endif
  2851. friend class ClientImpl;
  2852. };
  2853. #endif // CPPHTTPLIB_SSL_ENABLED
  2854. namespace detail {
  2855. template <typename T, typename U>
  2856. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2857. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2858. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2859. duration - std::chrono::seconds(sec))
  2860. .count();
  2861. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2862. }
  2863. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2864. return N - 1;
  2865. }
  2866. inline bool is_numeric(const std::string &str) {
  2867. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2868. }
  2869. inline size_t get_header_value_u64(const Headers &headers,
  2870. const std::string &key, size_t def,
  2871. size_t id, bool &is_invalid_value) {
  2872. is_invalid_value = false;
  2873. auto rng = headers.equal_range(key);
  2874. auto it = rng.first;
  2875. std::advance(it, static_cast<ssize_t>(id));
  2876. if (it != rng.second) {
  2877. if (is_numeric(it->second)) {
  2878. // Parse at size_t width so an out-of-range Content-Length is reported
  2879. // rather than silently saturated/truncated (a value above 2^32 would
  2880. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2881. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2882. size_t val = 0;
  2883. const auto &s = it->second;
  2884. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2885. if (r.ec == std::errc::result_out_of_range) {
  2886. is_invalid_value = true;
  2887. return (std::numeric_limits<size_t>::max)();
  2888. }
  2889. return val;
  2890. } else {
  2891. is_invalid_value = true;
  2892. }
  2893. }
  2894. return def;
  2895. }
  2896. inline size_t get_header_value_u64(const Headers &headers,
  2897. const std::string &key, size_t def,
  2898. size_t id) {
  2899. auto dummy = false;
  2900. return get_header_value_u64(headers, key, def, id, dummy);
  2901. }
  2902. } // namespace detail
  2903. template <class Rep, class Period>
  2904. inline Server &
  2905. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2906. detail::duration_to_sec_and_usec(
  2907. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2908. return *this;
  2909. }
  2910. template <class Rep, class Period>
  2911. inline Server &
  2912. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2913. detail::duration_to_sec_and_usec(
  2914. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2915. return *this;
  2916. }
  2917. template <class Rep, class Period>
  2918. inline Server &
  2919. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2920. detail::duration_to_sec_and_usec(
  2921. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2922. return *this;
  2923. }
  2924. template <class Rep, class Period>
  2925. inline void ClientImpl::set_connection_timeout(
  2926. const std::chrono::duration<Rep, Period> &duration) {
  2927. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2928. set_connection_timeout(sec, usec);
  2929. });
  2930. }
  2931. template <class Rep, class Period>
  2932. inline void ClientImpl::set_read_timeout(
  2933. const std::chrono::duration<Rep, Period> &duration) {
  2934. detail::duration_to_sec_and_usec(
  2935. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2936. }
  2937. template <class Rep, class Period>
  2938. inline void ClientImpl::set_write_timeout(
  2939. const std::chrono::duration<Rep, Period> &duration) {
  2940. detail::duration_to_sec_and_usec(
  2941. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2942. }
  2943. template <class Rep, class Period>
  2944. inline void ClientImpl::set_max_timeout(
  2945. const std::chrono::duration<Rep, Period> &duration) {
  2946. auto msec =
  2947. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2948. set_max_timeout(msec);
  2949. }
  2950. template <class Rep, class Period>
  2951. inline void Client::set_connection_timeout(
  2952. const std::chrono::duration<Rep, Period> &duration) {
  2953. cli_->set_connection_timeout(duration);
  2954. }
  2955. template <class Rep, class Period>
  2956. inline void
  2957. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2958. cli_->set_read_timeout(duration);
  2959. }
  2960. template <class Rep, class Period>
  2961. inline void
  2962. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2963. cli_->set_write_timeout(duration);
  2964. }
  2965. inline void Client::set_max_timeout(time_t msec) {
  2966. cli_->set_max_timeout(msec);
  2967. }
  2968. template <class Rep, class Period>
  2969. inline void
  2970. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2971. cli_->set_max_timeout(duration);
  2972. }
  2973. /*
  2974. * Forward declarations and types that will be part of the .h file if split into
  2975. * .h + .cc.
  2976. */
  2977. std::string hosted_at(const std::string &hostname);
  2978. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2979. // JavaScript-style URL encoding/decoding functions
  2980. std::string encode_uri_component(const std::string &value);
  2981. std::string encode_uri(const std::string &value);
  2982. std::string decode_uri_component(const std::string &value);
  2983. std::string decode_uri(const std::string &value);
  2984. // RFC 3986 compliant URL component encoding/decoding functions
  2985. std::string encode_path_component(const std::string &component);
  2986. std::string decode_path_component(const std::string &component);
  2987. std::string encode_query_component(const std::string &component,
  2988. bool space_as_plus = true);
  2989. std::string decode_query_component(const std::string &component,
  2990. bool plus_as_space = true);
  2991. std::string sanitize_filename(const std::string &filename);
  2992. std::string append_query_params(const std::string &path, const Params &params);
  2993. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2994. std::pair<std::string, std::string>
  2995. make_basic_authentication_header(const std::string &username,
  2996. const std::string &password,
  2997. bool is_proxy = false);
  2998. namespace detail {
  2999. #if defined(_WIN32)
  3000. inline std::wstring u8string_to_wstring(const char *s) {
  3001. if (!s) { return std::wstring(); }
  3002. auto len = static_cast<int>(strlen(s));
  3003. if (!len) { return std::wstring(); }
  3004. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3005. if (!wlen) { return std::wstring(); }
  3006. std::wstring ws;
  3007. ws.resize(wlen);
  3008. wlen = ::MultiByteToWideChar(
  3009. CP_UTF8, 0, s, len,
  3010. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3011. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3012. return ws;
  3013. }
  3014. #endif
  3015. struct FileStat {
  3016. FileStat(const std::string &path);
  3017. bool is_file() const;
  3018. bool is_dir() const;
  3019. time_t mtime() const;
  3020. size_t size() const;
  3021. private:
  3022. #if defined(_WIN32)
  3023. struct _stat st_;
  3024. #else
  3025. struct stat st_;
  3026. #endif
  3027. int ret_ = -1;
  3028. };
  3029. std::string make_host_and_port_string(const std::string &host, int port,
  3030. bool is_ssl);
  3031. template <typename T>
  3032. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3033. Error &error);
  3034. std::string trim_copy(const std::string &s);
  3035. void divide(
  3036. const char *data, std::size_t size, char d,
  3037. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3038. fn);
  3039. void divide(
  3040. const std::string &str, char d,
  3041. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3042. fn);
  3043. void split(const char *b, const char *e, char d,
  3044. std::function<void(const char *, const char *)> fn);
  3045. void split(const char *b, const char *e, char d, size_t m,
  3046. std::function<void(const char *, const char *)> fn);
  3047. bool split_find(const char *b, const char *e, char d,
  3048. std::function<bool(const char *, const char *)> fn);
  3049. bool has_header_token(const Headers &headers, const std::string &key,
  3050. const std::string &token);
  3051. std::string websocket_accept_key(const std::string &client_key);
  3052. bool is_websocket_upgrade(const Request &req);
  3053. bool process_client_socket(
  3054. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3055. time_t write_timeout_sec, time_t write_timeout_usec,
  3056. time_t max_timeout_msec,
  3057. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3058. std::function<bool(Stream &)> callback);
  3059. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3060. int port, int address_family, bool tcp_nodelay,
  3061. bool ipv6_v6only, SocketOptions socket_options,
  3062. time_t connection_timeout_sec,
  3063. time_t connection_timeout_usec,
  3064. time_t read_timeout_sec, time_t read_timeout_usec,
  3065. time_t write_timeout_sec,
  3066. time_t write_timeout_usec,
  3067. const std::string &intf, Error &error);
  3068. const char *get_header_value(const Headers &headers, const std::string &key,
  3069. const char *def, size_t id);
  3070. std::string get_combined_header_value(const Headers &headers,
  3071. const std::string &key);
  3072. std::string params_to_query_str(const Params &params);
  3073. void parse_query_text(const char *data, std::size_t size, Params &params);
  3074. void parse_query_text(const std::string &s, Params &params);
  3075. bool parse_multipart_boundary(const std::string &content_type,
  3076. std::string &boundary);
  3077. bool parse_range_header(const std::string &s, Ranges &ranges);
  3078. bool parse_accept_header(const std::string &s,
  3079. std::vector<std::string> &content_types);
  3080. void parse_disposition_params(const std::string &s, Params &params);
  3081. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3082. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3083. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3084. EncodingType encoding_type(const Request &req, const Response &res,
  3085. const std::string &content_type);
  3086. EncodingType encoding_type(const Request &req, const Response &res);
  3087. class BufferStream final : public Stream {
  3088. public:
  3089. BufferStream() = default;
  3090. ~BufferStream() override = default;
  3091. bool is_readable() const override;
  3092. bool wait_readable() const override;
  3093. bool wait_writable() const override;
  3094. ssize_t read(char *ptr, size_t size) override;
  3095. ssize_t write(const char *ptr, size_t size) override;
  3096. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3097. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3098. socket_t socket() const override;
  3099. time_t duration() const override;
  3100. const std::string &get_buffer() const;
  3101. private:
  3102. std::string buffer;
  3103. size_t position = 0;
  3104. };
  3105. class compressor {
  3106. public:
  3107. virtual ~compressor() = default;
  3108. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3109. virtual bool compress(const char *data, size_t data_length, bool last,
  3110. Callback callback) = 0;
  3111. };
  3112. class decompressor {
  3113. public:
  3114. virtual ~decompressor() = default;
  3115. virtual bool is_valid() const = 0;
  3116. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3117. virtual bool decompress(const char *data, size_t data_length,
  3118. Callback callback) = 0;
  3119. };
  3120. class nocompressor final : public compressor {
  3121. public:
  3122. ~nocompressor() override = default;
  3123. bool compress(const char *data, size_t data_length, bool /*last*/,
  3124. Callback callback) override;
  3125. };
  3126. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3127. class gzip_compressor final : public compressor {
  3128. public:
  3129. gzip_compressor();
  3130. ~gzip_compressor() override;
  3131. bool compress(const char *data, size_t data_length, bool last,
  3132. Callback callback) override;
  3133. private:
  3134. bool is_valid_ = false;
  3135. z_stream strm_;
  3136. };
  3137. class gzip_decompressor final : public decompressor {
  3138. public:
  3139. gzip_decompressor();
  3140. ~gzip_decompressor() override;
  3141. bool is_valid() const override;
  3142. bool decompress(const char *data, size_t data_length,
  3143. Callback callback) override;
  3144. private:
  3145. bool is_valid_ = false;
  3146. z_stream strm_;
  3147. };
  3148. #endif
  3149. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3150. class brotli_compressor final : public compressor {
  3151. public:
  3152. brotli_compressor();
  3153. ~brotli_compressor();
  3154. bool compress(const char *data, size_t data_length, bool last,
  3155. Callback callback) override;
  3156. private:
  3157. BrotliEncoderState *state_ = nullptr;
  3158. };
  3159. class brotli_decompressor final : public decompressor {
  3160. public:
  3161. brotli_decompressor();
  3162. ~brotli_decompressor();
  3163. bool is_valid() const override;
  3164. bool decompress(const char *data, size_t data_length,
  3165. Callback callback) override;
  3166. private:
  3167. BrotliDecoderResult decoder_r;
  3168. BrotliDecoderState *decoder_s = nullptr;
  3169. };
  3170. #endif
  3171. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3172. class zstd_compressor : public compressor {
  3173. public:
  3174. zstd_compressor();
  3175. ~zstd_compressor();
  3176. bool compress(const char *data, size_t data_length, bool last,
  3177. Callback callback) override;
  3178. private:
  3179. ZSTD_CCtx *ctx_ = nullptr;
  3180. };
  3181. class zstd_decompressor : public decompressor {
  3182. public:
  3183. zstd_decompressor();
  3184. ~zstd_decompressor();
  3185. bool is_valid() const override;
  3186. bool decompress(const char *data, size_t data_length,
  3187. Callback callback) override;
  3188. private:
  3189. ZSTD_DCtx *ctx_ = nullptr;
  3190. };
  3191. #endif
  3192. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3193. // to store data. The call can set memory on stack for performance.
  3194. class stream_line_reader {
  3195. public:
  3196. stream_line_reader(Stream &strm, char *fixed_buffer,
  3197. size_t fixed_buffer_size);
  3198. const char *ptr() const;
  3199. size_t size() const;
  3200. bool end_with_crlf() const;
  3201. bool getline();
  3202. private:
  3203. void append(char c);
  3204. void append(const char *data, size_t size);
  3205. Stream &strm_;
  3206. char *fixed_buffer_;
  3207. const size_t fixed_buffer_size_;
  3208. size_t fixed_buffer_used_size_ = 0;
  3209. std::string growable_buffer_;
  3210. };
  3211. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3212. const Headers &src_headers);
  3213. struct ChunkedDecoder {
  3214. Stream &strm;
  3215. size_t chunk_remaining = 0;
  3216. bool finished = false;
  3217. char line_buf[64];
  3218. size_t last_chunk_total = 0;
  3219. size_t last_chunk_offset = 0;
  3220. explicit ChunkedDecoder(Stream &s);
  3221. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3222. size_t &out_chunk_total);
  3223. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3224. };
  3225. class mmap {
  3226. public:
  3227. mmap(const char *path);
  3228. ~mmap();
  3229. bool open(const char *path);
  3230. void close();
  3231. bool is_open() const;
  3232. size_t size() const;
  3233. const char *data() const;
  3234. private:
  3235. #if defined(_WIN32)
  3236. HANDLE hFile_ = NULL;
  3237. HANDLE hMapping_ = NULL;
  3238. #else
  3239. int fd_ = -1;
  3240. #endif
  3241. size_t size_ = 0;
  3242. void *addr_ = nullptr;
  3243. bool is_open_empty_file = false;
  3244. };
  3245. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3246. namespace fields {
  3247. bool is_token_char(char c);
  3248. bool is_token(const std::string &s);
  3249. bool is_field_name(const std::string &s);
  3250. bool is_vchar(char c);
  3251. bool is_obs_text(char c);
  3252. bool is_field_vchar(char c);
  3253. bool is_field_content(const std::string &s);
  3254. bool is_field_value(const std::string &s);
  3255. bool is_field_valid(const std::string &name, const std::string &value);
  3256. bool is_request_target(const std::string &s);
  3257. } // namespace fields
  3258. } // namespace detail
  3259. /*
  3260. * TLS Abstraction Layer Declarations
  3261. */
  3262. #ifdef CPPHTTPLIB_SSL_ENABLED
  3263. // TLS abstraction layer - backend-specific type declarations
  3264. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3265. namespace tls {
  3266. namespace impl {
  3267. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3268. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3269. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3270. struct MbedTlsContext {
  3271. mbedtls_ssl_config conf;
  3272. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3273. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3274. mbedtls_entropy_context entropy;
  3275. mbedtls_ctr_drbg_context ctr_drbg;
  3276. #endif
  3277. mbedtls_x509_crt ca_chain;
  3278. mbedtls_x509_crt own_cert;
  3279. mbedtls_pk_context own_key;
  3280. bool is_server = false;
  3281. bool verify_client = false;
  3282. bool has_verify_callback = false;
  3283. MbedTlsContext();
  3284. ~MbedTlsContext();
  3285. MbedTlsContext(const MbedTlsContext &) = delete;
  3286. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3287. };
  3288. } // namespace impl
  3289. } // namespace tls
  3290. #endif
  3291. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3292. namespace tls {
  3293. namespace impl {
  3294. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3295. // This struct is accessible via tls::impl for use in SSL context
  3296. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3297. struct WolfSSLContext {
  3298. WOLFSSL_CTX *ctx = nullptr;
  3299. bool is_server = false;
  3300. bool verify_client = false;
  3301. bool has_verify_callback = false;
  3302. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3303. WolfSSLContext();
  3304. ~WolfSSLContext();
  3305. WolfSSLContext(const WolfSSLContext &) = delete;
  3306. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3307. };
  3308. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3309. struct WolfSSLCAStore {
  3310. std::string pem_data;
  3311. };
  3312. } // namespace impl
  3313. } // namespace tls
  3314. #endif
  3315. #endif // CPPHTTPLIB_SSL_ENABLED
  3316. namespace stream {
  3317. class Result {
  3318. public:
  3319. Result();
  3320. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3321. Result(Result &&other) noexcept;
  3322. Result &operator=(Result &&other) noexcept;
  3323. Result(const Result &) = delete;
  3324. Result &operator=(const Result &) = delete;
  3325. // Response info
  3326. bool is_valid() const;
  3327. explicit operator bool() const;
  3328. int status() const;
  3329. const Headers &headers() const;
  3330. std::string get_header_value(const std::string &key,
  3331. const char *def = "") const;
  3332. bool has_header(const std::string &key) const;
  3333. Error error() const;
  3334. Error read_error() const;
  3335. bool has_read_error() const;
  3336. // Stream reading
  3337. bool next();
  3338. const char *data() const;
  3339. size_t size() const;
  3340. std::string read_all();
  3341. private:
  3342. ClientImpl::StreamHandle handle_;
  3343. std::string buffer_;
  3344. size_t current_size_ = 0;
  3345. size_t chunk_size_;
  3346. bool finished_ = false;
  3347. };
  3348. // GET
  3349. template <typename ClientType>
  3350. inline Result Get(ClientType &cli, const std::string &path,
  3351. size_t chunk_size = 8192) {
  3352. return Result{cli.open_stream("GET", path), chunk_size};
  3353. }
  3354. template <typename ClientType>
  3355. inline Result Get(ClientType &cli, const std::string &path,
  3356. const Headers &headers, size_t chunk_size = 8192) {
  3357. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3358. }
  3359. template <typename ClientType>
  3360. inline Result Get(ClientType &cli, const std::string &path,
  3361. const Params &params, size_t chunk_size = 8192) {
  3362. return Result{cli.open_stream("GET", path, params), chunk_size};
  3363. }
  3364. template <typename ClientType>
  3365. inline Result Get(ClientType &cli, const std::string &path,
  3366. const Params &params, const Headers &headers,
  3367. size_t chunk_size = 8192) {
  3368. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3369. }
  3370. // POST
  3371. template <typename ClientType>
  3372. inline Result Post(ClientType &cli, const std::string &path,
  3373. const std::string &body, const std::string &content_type,
  3374. size_t chunk_size = 8192) {
  3375. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3376. chunk_size};
  3377. }
  3378. template <typename ClientType>
  3379. inline Result Post(ClientType &cli, const std::string &path,
  3380. const Headers &headers, const std::string &body,
  3381. const std::string &content_type, size_t chunk_size = 8192) {
  3382. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3383. chunk_size};
  3384. }
  3385. template <typename ClientType>
  3386. inline Result Post(ClientType &cli, const std::string &path,
  3387. const Params &params, const std::string &body,
  3388. const std::string &content_type, size_t chunk_size = 8192) {
  3389. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3390. chunk_size};
  3391. }
  3392. template <typename ClientType>
  3393. inline Result Post(ClientType &cli, const std::string &path,
  3394. const Params &params, const Headers &headers,
  3395. const std::string &body, const std::string &content_type,
  3396. size_t chunk_size = 8192) {
  3397. return Result{
  3398. cli.open_stream("POST", path, params, headers, body, content_type),
  3399. chunk_size};
  3400. }
  3401. // PUT
  3402. template <typename ClientType>
  3403. inline Result Put(ClientType &cli, const std::string &path,
  3404. const std::string &body, const std::string &content_type,
  3405. size_t chunk_size = 8192) {
  3406. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3407. chunk_size};
  3408. }
  3409. template <typename ClientType>
  3410. inline Result Put(ClientType &cli, const std::string &path,
  3411. const Headers &headers, const std::string &body,
  3412. const std::string &content_type, size_t chunk_size = 8192) {
  3413. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3414. chunk_size};
  3415. }
  3416. template <typename ClientType>
  3417. inline Result Put(ClientType &cli, const std::string &path,
  3418. const Params &params, const std::string &body,
  3419. const std::string &content_type, size_t chunk_size = 8192) {
  3420. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3421. chunk_size};
  3422. }
  3423. template <typename ClientType>
  3424. inline Result Put(ClientType &cli, const std::string &path,
  3425. const Params &params, const Headers &headers,
  3426. const std::string &body, const std::string &content_type,
  3427. size_t chunk_size = 8192) {
  3428. return Result{
  3429. cli.open_stream("PUT", path, params, headers, body, content_type),
  3430. chunk_size};
  3431. }
  3432. // PATCH
  3433. template <typename ClientType>
  3434. inline Result Patch(ClientType &cli, const std::string &path,
  3435. const std::string &body, const std::string &content_type,
  3436. size_t chunk_size = 8192) {
  3437. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3438. chunk_size};
  3439. }
  3440. template <typename ClientType>
  3441. inline Result Patch(ClientType &cli, const std::string &path,
  3442. const Headers &headers, const std::string &body,
  3443. const std::string &content_type, size_t chunk_size = 8192) {
  3444. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3445. chunk_size};
  3446. }
  3447. template <typename ClientType>
  3448. inline Result Patch(ClientType &cli, const std::string &path,
  3449. const Params &params, const std::string &body,
  3450. const std::string &content_type, size_t chunk_size = 8192) {
  3451. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3452. chunk_size};
  3453. }
  3454. template <typename ClientType>
  3455. inline Result Patch(ClientType &cli, const std::string &path,
  3456. const Params &params, const Headers &headers,
  3457. const std::string &body, const std::string &content_type,
  3458. size_t chunk_size = 8192) {
  3459. return Result{
  3460. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3461. chunk_size};
  3462. }
  3463. // DELETE
  3464. template <typename ClientType>
  3465. inline Result Delete(ClientType &cli, const std::string &path,
  3466. size_t chunk_size = 8192) {
  3467. return Result{cli.open_stream("DELETE", path), chunk_size};
  3468. }
  3469. template <typename ClientType>
  3470. inline Result Delete(ClientType &cli, const std::string &path,
  3471. const Headers &headers, size_t chunk_size = 8192) {
  3472. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3473. }
  3474. template <typename ClientType>
  3475. inline Result Delete(ClientType &cli, const std::string &path,
  3476. const std::string &body, const std::string &content_type,
  3477. size_t chunk_size = 8192) {
  3478. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3479. chunk_size};
  3480. }
  3481. template <typename ClientType>
  3482. inline Result Delete(ClientType &cli, const std::string &path,
  3483. const Headers &headers, const std::string &body,
  3484. const std::string &content_type,
  3485. size_t chunk_size = 8192) {
  3486. return Result{
  3487. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3488. chunk_size};
  3489. }
  3490. template <typename ClientType>
  3491. inline Result Delete(ClientType &cli, const std::string &path,
  3492. const Params &params, size_t chunk_size = 8192) {
  3493. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3494. }
  3495. template <typename ClientType>
  3496. inline Result Delete(ClientType &cli, const std::string &path,
  3497. const Params &params, const Headers &headers,
  3498. size_t chunk_size = 8192) {
  3499. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3500. }
  3501. template <typename ClientType>
  3502. inline Result Delete(ClientType &cli, const std::string &path,
  3503. const Params &params, const std::string &body,
  3504. const std::string &content_type,
  3505. size_t chunk_size = 8192) {
  3506. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3507. chunk_size};
  3508. }
  3509. template <typename ClientType>
  3510. inline Result Delete(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("DELETE", path, params, headers, body, content_type),
  3516. chunk_size};
  3517. }
  3518. // HEAD
  3519. template <typename ClientType>
  3520. inline Result Head(ClientType &cli, const std::string &path,
  3521. size_t chunk_size = 8192) {
  3522. return Result{cli.open_stream("HEAD", path), chunk_size};
  3523. }
  3524. template <typename ClientType>
  3525. inline Result Head(ClientType &cli, const std::string &path,
  3526. const Headers &headers, size_t chunk_size = 8192) {
  3527. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3528. }
  3529. template <typename ClientType>
  3530. inline Result Head(ClientType &cli, const std::string &path,
  3531. const Params &params, size_t chunk_size = 8192) {
  3532. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3533. }
  3534. template <typename ClientType>
  3535. inline Result Head(ClientType &cli, const std::string &path,
  3536. const Params &params, const Headers &headers,
  3537. size_t chunk_size = 8192) {
  3538. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3539. }
  3540. // OPTIONS
  3541. template <typename ClientType>
  3542. inline Result Options(ClientType &cli, const std::string &path,
  3543. size_t chunk_size = 8192) {
  3544. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3545. }
  3546. template <typename ClientType>
  3547. inline Result Options(ClientType &cli, const std::string &path,
  3548. const Headers &headers, size_t chunk_size = 8192) {
  3549. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3550. }
  3551. template <typename ClientType>
  3552. inline Result Options(ClientType &cli, const std::string &path,
  3553. const Params &params, size_t chunk_size = 8192) {
  3554. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3555. }
  3556. template <typename ClientType>
  3557. inline Result Options(ClientType &cli, const std::string &path,
  3558. const Params &params, const Headers &headers,
  3559. size_t chunk_size = 8192) {
  3560. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3561. }
  3562. } // namespace stream
  3563. namespace sse {
  3564. struct SSEMessage {
  3565. std::string event; // Event type (default: "message")
  3566. std::string data; // Event payload
  3567. std::string id; // Event ID for Last-Event-ID header
  3568. SSEMessage();
  3569. void clear();
  3570. };
  3571. class SSEClient {
  3572. public:
  3573. using MessageHandler = std::function<void(const SSEMessage &)>;
  3574. using ErrorHandler = std::function<void(Error)>;
  3575. using OpenHandler = std::function<void()>;
  3576. SSEClient(Client &client, const std::string &path);
  3577. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3578. ~SSEClient();
  3579. SSEClient(const SSEClient &) = delete;
  3580. SSEClient &operator=(const SSEClient &) = delete;
  3581. // Event handlers
  3582. SSEClient &on_message(MessageHandler handler);
  3583. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3584. SSEClient &on_open(OpenHandler handler);
  3585. SSEClient &on_error(ErrorHandler handler);
  3586. SSEClient &set_reconnect_interval(int ms);
  3587. SSEClient &set_max_reconnect_attempts(int n);
  3588. // Update headers (thread-safe)
  3589. SSEClient &set_headers(const Headers &headers);
  3590. // State accessors
  3591. bool is_connected() const;
  3592. const std::string &last_event_id() const;
  3593. // Blocking start - runs event loop with auto-reconnect
  3594. void start();
  3595. // Non-blocking start - runs in background thread
  3596. void start_async();
  3597. // Stop the client (thread-safe)
  3598. void stop();
  3599. private:
  3600. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3601. bool &has_data);
  3602. void run_event_loop();
  3603. void dispatch_event(const SSEMessage &msg);
  3604. bool should_reconnect(int count) const;
  3605. void wait_for_reconnect();
  3606. // Client and path
  3607. Client &client_;
  3608. std::string path_;
  3609. Headers headers_;
  3610. mutable std::mutex headers_mutex_;
  3611. // Callbacks
  3612. MessageHandler on_message_;
  3613. std::map<std::string, MessageHandler> event_handlers_;
  3614. OpenHandler on_open_;
  3615. ErrorHandler on_error_;
  3616. // Configuration
  3617. int reconnect_interval_ms_ = 3000;
  3618. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3619. // State
  3620. std::atomic<bool> running_{false};
  3621. std::atomic<bool> connected_{false};
  3622. std::string last_event_id_;
  3623. // Async support
  3624. std::thread async_thread_;
  3625. };
  3626. } // namespace sse
  3627. namespace ws {
  3628. enum class Opcode : uint8_t {
  3629. Continuation = 0x0,
  3630. Text = 0x1,
  3631. Binary = 0x2,
  3632. Close = 0x8,
  3633. Ping = 0x9,
  3634. Pong = 0xA,
  3635. };
  3636. enum class CloseStatus : uint16_t {
  3637. Normal = 1000,
  3638. GoingAway = 1001,
  3639. ProtocolError = 1002,
  3640. UnsupportedData = 1003,
  3641. NoStatus = 1005,
  3642. Abnormal = 1006,
  3643. InvalidPayload = 1007,
  3644. PolicyViolation = 1008,
  3645. MessageTooBig = 1009,
  3646. MandatoryExtension = 1010,
  3647. InternalError = 1011,
  3648. };
  3649. // Timeout is returned only when a read timeout was set and it elapsed before
  3650. // any byte of a frame arrived: nothing was consumed and the connection is
  3651. // still open, so the caller can send on it and read again. `msg` is left
  3652. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3653. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3654. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3655. // upgrade handshake fully succeeded. On failure error() identifies the
  3656. // failing layer; status()/headers() expose the server's upgrade response
  3657. // when one was received (status() is -1 otherwise).
  3658. class Result {
  3659. public:
  3660. Result() = default;
  3661. Result(Error err, int status, Headers &&headers)
  3662. : err_(err), status_(status), headers_(std::move(headers)) {}
  3663. explicit operator bool() const { return err_ == Error::Success; }
  3664. Error error() const { return err_; }
  3665. // Upgrade response info
  3666. int status() const { return status_; }
  3667. const Headers &headers() const { return headers_; }
  3668. std::string get_header_value(const std::string &key,
  3669. const char *def = "") const {
  3670. return detail::get_header_value(headers_, key, def, 0);
  3671. }
  3672. bool has_header(const std::string &key) const {
  3673. return headers_.find(key) != headers_.end();
  3674. }
  3675. #ifdef CPPHTTPLIB_SSL_ENABLED
  3676. Result(Error err, int status, Headers &&headers, int ssl_error,
  3677. uint64_t ssl_backend_error)
  3678. : err_(err), status_(status), headers_(std::move(headers)),
  3679. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3680. int ssl_error() const { return ssl_error_; }
  3681. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3682. #endif
  3683. private:
  3684. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3685. int status_ = -1;
  3686. Headers headers_;
  3687. #ifdef CPPHTTPLIB_SSL_ENABLED
  3688. int ssl_error_ = 0;
  3689. uint64_t ssl_backend_error_ = 0;
  3690. #endif
  3691. };
  3692. class WebSocket {
  3693. public:
  3694. WebSocket(const WebSocket &) = delete;
  3695. WebSocket &operator=(const WebSocket &) = delete;
  3696. ~WebSocket();
  3697. ReadResult read(std::string &msg);
  3698. bool send(const std::string &data);
  3699. bool send(const char *data, size_t len);
  3700. void close(CloseStatus status = CloseStatus::Normal,
  3701. const std::string &reason = "");
  3702. const Request &request() const;
  3703. bool is_open() const;
  3704. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3705. // A server handler owns its connection's timeout this way; a client sets it
  3706. // through WebSocketClient. Safe to call while another thread is in read().
  3707. //
  3708. // Only a timeout set here is reported as Timeout. The compile-time default
  3709. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3710. // than a request for control, so when it elapses read() returns Fail and
  3711. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3712. void set_read_timeout(time_t sec, time_t usec = 0);
  3713. template <class Rep, class Period>
  3714. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3715. private:
  3716. friend class httplib::Server;
  3717. friend class WebSocketClient;
  3718. WebSocket(
  3719. Stream &strm, const Request &req, bool is_server,
  3720. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3721. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3722. : strm_(strm), req_(req), is_server_(is_server),
  3723. ping_interval_sec_(ping_interval_sec),
  3724. max_missed_pongs_(max_missed_pongs) {
  3725. start_heartbeat();
  3726. }
  3727. WebSocket(
  3728. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3729. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3730. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3731. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3732. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3733. max_missed_pongs_(max_missed_pongs) {
  3734. start_heartbeat();
  3735. }
  3736. void start_heartbeat();
  3737. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3738. Stream &strm_;
  3739. std::unique_ptr<Stream> owned_strm_;
  3740. Request req_;
  3741. bool is_server_;
  3742. time_t ping_interval_sec_;
  3743. int max_missed_pongs_;
  3744. int unacked_pings_ = 0;
  3745. std::atomic<bool> closed_{false};
  3746. // Set once the caller has bounded read() through set_read_timeout(). Until
  3747. // then the timeout in effect is the compile-time default, and elapsing it
  3748. // is a failure that closes the connection, not a Timeout.
  3749. std::atomic<bool> read_timeout_set_{false};
  3750. std::mutex write_mutex_;
  3751. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3752. // may do so: read_websocket_frame() reads a payload until it has the whole
  3753. // declared length, so a second parser stealing bytes silently corrupts the
  3754. // message the first one is assembling.
  3755. std::mutex read_mutex_;
  3756. std::thread ping_thread_;
  3757. std::mutex ping_mutex_;
  3758. std::condition_variable ping_cv_;
  3759. };
  3760. class WebSocketClient {
  3761. public:
  3762. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3763. const Headers &headers = {});
  3764. ~WebSocketClient();
  3765. WebSocketClient(const WebSocketClient &) = delete;
  3766. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3767. bool is_valid() const;
  3768. Result connect();
  3769. ReadResult read(std::string &msg);
  3770. bool send(const std::string &data);
  3771. bool send(const char *data, size_t len);
  3772. void close(CloseStatus status = CloseStatus::Normal,
  3773. const std::string &reason = "");
  3774. bool is_open() const;
  3775. const std::string &subprotocol() const;
  3776. void set_read_timeout(time_t sec, time_t usec = 0);
  3777. template <class Rep, class Period>
  3778. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3779. void set_write_timeout(time_t sec, time_t usec = 0);
  3780. template <class Rep, class Period>
  3781. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3782. void set_websocket_ping_interval(time_t sec);
  3783. void set_websocket_max_missed_pongs(int count);
  3784. void set_tcp_nodelay(bool on);
  3785. void set_address_family(int family);
  3786. void set_ipv6_v6only(bool on);
  3787. void set_socket_options(SocketOptions socket_options);
  3788. void set_connection_timeout(time_t sec, time_t usec = 0);
  3789. template <class Rep, class Period>
  3790. void
  3791. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3792. void set_interface(const std::string &intf);
  3793. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3794. #ifdef CPPHTTPLIB_SSL_ENABLED
  3795. struct PemMemory {
  3796. const char *cert_pem;
  3797. size_t cert_pem_len;
  3798. const char *key_pem;
  3799. size_t key_pem_len;
  3800. const char *private_key_password;
  3801. };
  3802. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3803. const PemMemory &pem, const Headers &headers = {});
  3804. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3805. const std::string &ca_cert_dir_path = std::string());
  3806. void set_ca_cert_store(tls::ca_store_t store);
  3807. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3808. void enable_server_certificate_verification(bool enabled);
  3809. void enable_server_hostname_verification(bool enabled);
  3810. void enable_system_ca(bool enabled);
  3811. #endif
  3812. private:
  3813. void shutdown_and_close();
  3814. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3815. int &ssl_error, uint64_t &ssl_backend_error);
  3816. void prepare_default_headers(Request &req);
  3817. std::string host_;
  3818. int port_;
  3819. std::string path_;
  3820. Headers headers_;
  3821. std::string subprotocol_;
  3822. bool is_valid_ = false;
  3823. socket_t sock_ = INVALID_SOCKET;
  3824. std::unique_ptr<WebSocket> ws_;
  3825. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3826. time_t read_timeout_usec_ = 0;
  3827. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3828. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3829. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3830. time_t websocket_ping_interval_sec_ =
  3831. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3832. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3833. int address_family_ = AF_UNSPEC;
  3834. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3835. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3836. SocketOptions socket_options_ = nullptr;
  3837. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3838. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3839. std::string interface_;
  3840. // Hostname to connection target map. The value is an IP literal or another
  3841. // hostname; only the connection target changes, never the identity.
  3842. std::map<std::string, std::string> addr_map_;
  3843. #ifdef CPPHTTPLIB_SSL_ENABLED
  3844. bool is_ssl_ = false;
  3845. tls::ctx_t tls_ctx_ = nullptr;
  3846. tls::session_t tls_session_ = nullptr;
  3847. std::string ca_cert_file_path_;
  3848. std::string ca_cert_dir_path_;
  3849. bool custom_ca_loaded_ = false;
  3850. bool certs_loaded_ = false;
  3851. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3852. bool server_certificate_verification_ = true;
  3853. bool server_hostname_verification_ = true;
  3854. #endif
  3855. };
  3856. template <class Rep, class Period>
  3857. inline void WebSocket::set_read_timeout(
  3858. const std::chrono::duration<Rep, Period> &duration) {
  3859. detail::duration_to_sec_and_usec(
  3860. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3861. }
  3862. template <class Rep, class Period>
  3863. inline void WebSocketClient::set_read_timeout(
  3864. const std::chrono::duration<Rep, Period> &duration) {
  3865. detail::duration_to_sec_and_usec(
  3866. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3867. }
  3868. template <class Rep, class Period>
  3869. inline void WebSocketClient::set_write_timeout(
  3870. const std::chrono::duration<Rep, Period> &duration) {
  3871. detail::duration_to_sec_and_usec(
  3872. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3873. }
  3874. template <class Rep, class Period>
  3875. inline void WebSocketClient::set_connection_timeout(
  3876. const std::chrono::duration<Rep, Period> &duration) {
  3877. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3878. set_connection_timeout(sec, usec);
  3879. });
  3880. }
  3881. namespace impl {
  3882. bool is_valid_utf8(const std::string &s);
  3883. // Three states, because a failure that consumed bytes and one that consumed
  3884. // none are not the same thing: the first has left the stream in the middle of
  3885. // a frame and the connection cannot be reused, the second can just be retried.
  3886. enum class FrameRead { Ok, Fail, Timeout };
  3887. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3888. std::string &payload, bool &fin,
  3889. bool expect_masked, size_t max_len);
  3890. } // namespace impl
  3891. } // namespace ws
  3892. // ----------------------------------------------------------------------------
  3893. /*
  3894. * Implementation that will be part of the .cc file if split into .h + .cc.
  3895. */
  3896. namespace stream {
  3897. // stream::Result implementations
  3898. inline Result::Result() : chunk_size_(8192) {}
  3899. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3900. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3901. inline Result::Result(Result &&other) noexcept
  3902. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3903. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3904. finished_(other.finished_) {
  3905. other.current_size_ = 0;
  3906. other.finished_ = true;
  3907. }
  3908. inline Result &Result::operator=(Result &&other) noexcept {
  3909. if (this != &other) {
  3910. handle_ = std::move(other.handle_);
  3911. buffer_ = std::move(other.buffer_);
  3912. current_size_ = other.current_size_;
  3913. chunk_size_ = other.chunk_size_;
  3914. finished_ = other.finished_;
  3915. other.current_size_ = 0;
  3916. other.finished_ = true;
  3917. }
  3918. return *this;
  3919. }
  3920. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3921. inline Result::operator bool() const { return is_valid(); }
  3922. inline int Result::status() const {
  3923. return handle_.response ? handle_.response->status : -1;
  3924. }
  3925. inline const Headers &Result::headers() const {
  3926. static const Headers empty_headers;
  3927. return handle_.response ? handle_.response->headers : empty_headers;
  3928. }
  3929. inline std::string Result::get_header_value(const std::string &key,
  3930. const char *def) const {
  3931. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3932. }
  3933. inline bool Result::has_header(const std::string &key) const {
  3934. return handle_.response ? handle_.response->has_header(key) : false;
  3935. }
  3936. inline Error Result::error() const { return handle_.error; }
  3937. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3938. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3939. inline bool Result::next() {
  3940. if (!handle_.is_valid() || finished_) { return false; }
  3941. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3942. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3943. if (n > 0) {
  3944. current_size_ = static_cast<size_t>(n);
  3945. return true;
  3946. }
  3947. current_size_ = 0;
  3948. finished_ = true;
  3949. return false;
  3950. }
  3951. inline const char *Result::data() const { return buffer_.data(); }
  3952. inline size_t Result::size() const { return current_size_; }
  3953. inline std::string Result::read_all() {
  3954. std::string result;
  3955. while (next()) {
  3956. result.append(data(), size());
  3957. }
  3958. return result;
  3959. }
  3960. } // namespace stream
  3961. namespace sse {
  3962. // SSEMessage implementations
  3963. inline SSEMessage::SSEMessage() : event("message") {}
  3964. inline void SSEMessage::clear() {
  3965. event = "message";
  3966. data.clear();
  3967. id.clear();
  3968. }
  3969. // SSEClient implementations
  3970. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3971. : client_(client), path_(path) {}
  3972. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3973. const Headers &headers)
  3974. : client_(client), path_(path), headers_(headers) {}
  3975. inline SSEClient::~SSEClient() { stop(); }
  3976. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3977. on_message_ = std::move(handler);
  3978. return *this;
  3979. }
  3980. inline SSEClient &SSEClient::on_event(const std::string &type,
  3981. MessageHandler handler) {
  3982. event_handlers_[type] = std::move(handler);
  3983. return *this;
  3984. }
  3985. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3986. on_open_ = std::move(handler);
  3987. return *this;
  3988. }
  3989. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3990. on_error_ = std::move(handler);
  3991. return *this;
  3992. }
  3993. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3994. reconnect_interval_ms_ = ms;
  3995. return *this;
  3996. }
  3997. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3998. max_reconnect_attempts_ = n;
  3999. return *this;
  4000. }
  4001. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4002. std::lock_guard<std::mutex> lock(headers_mutex_);
  4003. headers_ = headers;
  4004. return *this;
  4005. }
  4006. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4007. inline const std::string &SSEClient::last_event_id() const {
  4008. return last_event_id_;
  4009. }
  4010. inline void SSEClient::start() {
  4011. running_.store(true);
  4012. run_event_loop();
  4013. }
  4014. inline void SSEClient::start_async() {
  4015. running_.store(true);
  4016. async_thread_ = std::thread([this]() { run_event_loop(); });
  4017. }
  4018. inline void SSEClient::stop() {
  4019. running_.store(false);
  4020. client_.stop(); // Cancel any pending operations
  4021. if (async_thread_.joinable()) { async_thread_.join(); }
  4022. }
  4023. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4024. int &retry_ms, bool &has_data) {
  4025. // Blank line signals end of event
  4026. if (line.empty()) { return true; }
  4027. // Lines starting with ':' are comments (ignored)
  4028. if (line[0] == ':') { return false; }
  4029. // Find the colon separator
  4030. auto colon_pos = line.find(':');
  4031. auto field = line.substr(0, colon_pos);
  4032. std::string value;
  4033. // Value starts after colon, skip optional single space
  4034. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4035. auto value_start = colon_pos + 1;
  4036. if (line[value_start] == ' ') { value_start++; }
  4037. value = line.substr(value_start);
  4038. }
  4039. // Handle known fields
  4040. if (field == "event") {
  4041. msg.event = value;
  4042. } else if (field == "data") {
  4043. // Multiple data lines are concatenated with newlines
  4044. if (has_data) { msg.data += "\n"; }
  4045. msg.data += value;
  4046. has_data = true;
  4047. } else if (field == "id") {
  4048. // Empty id is valid (clears the last event ID)
  4049. msg.id = value;
  4050. } else if (field == "retry") {
  4051. // Parse retry interval in milliseconds
  4052. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4053. if (detail::is_numeric(value)) {
  4054. int v = 0;
  4055. auto res =
  4056. detail::from_chars(value.data(), value.data() + value.size(), v);
  4057. if (res.ec == std::errc{}) { retry_ms = v; }
  4058. }
  4059. }
  4060. // Unknown fields are ignored per SSE spec
  4061. return false;
  4062. }
  4063. inline void SSEClient::run_event_loop() {
  4064. auto reconnect_count = 0;
  4065. while (running_.load()) {
  4066. // Build headers, including Last-Event-ID if we have one
  4067. Headers request_headers;
  4068. {
  4069. std::lock_guard<std::mutex> lock(headers_mutex_);
  4070. request_headers = headers_;
  4071. }
  4072. if (!last_event_id_.empty()) {
  4073. request_headers.emplace("Last-Event-ID", last_event_id_);
  4074. }
  4075. // Open streaming connection
  4076. auto result = stream::Get(client_, path_, request_headers);
  4077. // Connection error handling
  4078. if (!result) {
  4079. connected_.store(false);
  4080. if (on_error_) { on_error_(result.error()); }
  4081. if (!should_reconnect(reconnect_count)) { break; }
  4082. wait_for_reconnect();
  4083. reconnect_count++;
  4084. continue;
  4085. }
  4086. if (result.status() != StatusCode::OK_200) {
  4087. connected_.store(false);
  4088. if (on_error_) { on_error_(Error::Connection); }
  4089. // For certain errors, don't reconnect.
  4090. // Note: 401 is intentionally absent so that handlers can refresh
  4091. // credentials via set_headers() and let the client reconnect.
  4092. if (result.status() == StatusCode::NoContent_204 ||
  4093. result.status() == StatusCode::NotFound_404 ||
  4094. result.status() == StatusCode::Forbidden_403) {
  4095. break;
  4096. }
  4097. if (!should_reconnect(reconnect_count)) { break; }
  4098. wait_for_reconnect();
  4099. reconnect_count++;
  4100. continue;
  4101. }
  4102. // Connection successful
  4103. connected_.store(true);
  4104. reconnect_count = 0;
  4105. if (on_open_) { on_open_(); }
  4106. // Event receiving loop
  4107. std::string buffer;
  4108. SSEMessage current_msg;
  4109. bool has_data = false;
  4110. while (running_.load() && result.next()) {
  4111. buffer.append(result.data(), result.size());
  4112. // Process complete lines in the buffer
  4113. size_t line_start = 0;
  4114. size_t newline_pos;
  4115. while ((newline_pos = buffer.find('\n', line_start)) !=
  4116. std::string::npos) {
  4117. auto line = buffer.substr(line_start, newline_pos - line_start);
  4118. line_start = newline_pos + 1;
  4119. // Strip the \r of a CRLF line ending so that every field, including
  4120. // one without a colon, sees the same line
  4121. if (!line.empty() && line.back() == '\r') { line.pop_back(); }
  4122. // Parse the line and check if event is complete
  4123. auto event_complete =
  4124. parse_sse_line(line, current_msg, reconnect_interval_ms_, has_data);
  4125. if (event_complete) {
  4126. // Update last_event_id for reconnection, even for an event that
  4127. // has no data
  4128. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  4129. // An event without a data field is not dispatched
  4130. if (has_data) { dispatch_event(current_msg); }
  4131. // Reset the message for the next event either way
  4132. current_msg.clear();
  4133. has_data = false;
  4134. }
  4135. }
  4136. // Keep unprocessed data in buffer
  4137. buffer.erase(0, line_start);
  4138. }
  4139. // Connection ended
  4140. connected_.store(false);
  4141. if (!running_.load()) { break; }
  4142. // Check for read errors
  4143. if (result.has_read_error()) {
  4144. if (on_error_) { on_error_(result.read_error()); }
  4145. }
  4146. if (!should_reconnect(reconnect_count)) { break; }
  4147. wait_for_reconnect();
  4148. reconnect_count++;
  4149. }
  4150. connected_.store(false);
  4151. }
  4152. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4153. // Check for specific event type handler first
  4154. auto it = event_handlers_.find(msg.event);
  4155. if (it != event_handlers_.end()) {
  4156. it->second(msg);
  4157. return;
  4158. }
  4159. // Fall back to generic message handler
  4160. if (on_message_) { on_message_(msg); }
  4161. }
  4162. inline bool SSEClient::should_reconnect(int count) const {
  4163. if (!running_.load()) { return false; }
  4164. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4165. return count < max_reconnect_attempts_;
  4166. }
  4167. inline void SSEClient::wait_for_reconnect() {
  4168. // Use small increments to check running_ flag frequently.
  4169. // Always wait at least one increment, so that a zero interval (e.g.
  4170. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4171. const auto step_ms = 100;
  4172. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4173. auto waited = 0;
  4174. while (running_.load() && waited < interval_ms) {
  4175. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4176. waited += step_ms;
  4177. }
  4178. }
  4179. } // namespace sse
  4180. #ifdef CPPHTTPLIB_SSL_ENABLED
  4181. /*
  4182. * TLS abstraction layer - internal function declarations
  4183. * These are implementation details and not part of the public API.
  4184. */
  4185. namespace tls {
  4186. // Client context
  4187. ctx_t create_client_context();
  4188. void free_context(ctx_t ctx);
  4189. bool set_min_version(ctx_t ctx, Version version);
  4190. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4191. bool load_ca_file(ctx_t ctx, const char *file_path);
  4192. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4193. bool load_system_certs(ctx_t ctx);
  4194. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4195. const char *password);
  4196. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4197. const char *key_path, const char *password);
  4198. // Server context
  4199. ctx_t create_server_context();
  4200. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4201. const char *password);
  4202. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4203. const char *key_path, const char *password);
  4204. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4205. void set_verify_client(ctx_t ctx, bool require);
  4206. // Session management
  4207. session_t create_session(ctx_t ctx, socket_t sock);
  4208. void free_session(session_t session);
  4209. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4210. // Handshake (non-blocking capable)
  4211. TlsError connect(session_t session);
  4212. TlsError accept(session_t session);
  4213. // Handshake with timeout (blocking until timeout)
  4214. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4215. time_t timeout_usec, TlsError *err);
  4216. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4217. time_t timeout_usec, TlsError *err);
  4218. // I/O (non-blocking capable)
  4219. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4220. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4221. int pending(const_session_t session);
  4222. void shutdown(session_t session, bool graceful);
  4223. // Connection state
  4224. bool is_peer_closed(session_t session, socket_t sock);
  4225. // Certificate verification
  4226. cert_t get_peer_cert(const_session_t session);
  4227. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4228. // do not use them after free_session(), as with get_peer_cert().
  4229. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4230. void free_cert(cert_t cert);
  4231. bool verify_hostname(cert_t cert, const char *hostname);
  4232. uint64_t hostname_mismatch_code();
  4233. long get_verify_result(const_session_t session);
  4234. // Certificate introspection
  4235. std::string get_cert_subject_cn(cert_t cert);
  4236. std::string get_cert_issuer_name(cert_t cert);
  4237. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4238. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4239. std::string get_cert_serial(cert_t cert);
  4240. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4241. const char *get_sni(const_session_t session);
  4242. // CA store management
  4243. ca_store_t create_ca_store(const char *pem, size_t len);
  4244. void free_ca_store(ca_store_t store);
  4245. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4246. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4247. std::vector<std::string> get_ca_names(ctx_t ctx);
  4248. // Dynamic certificate update (for servers)
  4249. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4250. const char *password);
  4251. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4252. // Certificate verification callback
  4253. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4254. long get_verify_error(const_session_t session);
  4255. std::string verify_error_string(long error_code);
  4256. // TlsError information
  4257. uint64_t peek_error();
  4258. uint64_t get_error();
  4259. std::string error_string(uint64_t code);
  4260. } // namespace tls
  4261. #endif // CPPHTTPLIB_SSL_ENABLED
  4262. /*
  4263. * Group 1: detail namespace - Non-SSL utilities
  4264. */
  4265. namespace detail {
  4266. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4267. const void *optval, socklen_t optlen) {
  4268. return setsockopt(sock, level, optname,
  4269. #ifdef _WIN32
  4270. reinterpret_cast<const char *>(optval),
  4271. #else
  4272. optval,
  4273. #endif
  4274. optlen) == 0;
  4275. }
  4276. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4277. time_t sec, time_t usec) {
  4278. #ifdef _WIN32
  4279. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4280. #else
  4281. timeval timeout;
  4282. timeout.tv_sec = static_cast<long>(sec);
  4283. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4284. #endif
  4285. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4286. }
  4287. inline bool is_hex(char c, int &v) {
  4288. if (is_ascii_digit(c)) {
  4289. v = c - '0';
  4290. return true;
  4291. } else if ('A' <= c && c <= 'F') {
  4292. v = c - 'A' + 10;
  4293. return true;
  4294. } else if ('a' <= c && c <= 'f') {
  4295. v = c - 'a' + 10;
  4296. return true;
  4297. }
  4298. return false;
  4299. }
  4300. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4301. int &val) {
  4302. if (i >= s.size()) { return false; }
  4303. val = 0;
  4304. for (; cnt; i++, cnt--) {
  4305. if (!s[i]) { return false; }
  4306. auto v = 0;
  4307. if (is_hex(s[i], v)) {
  4308. val = val * 16 + v;
  4309. } else {
  4310. return false;
  4311. }
  4312. }
  4313. return true;
  4314. }
  4315. inline std::string from_i_to_hex(size_t n) {
  4316. static const auto charset = "0123456789abcdef";
  4317. std::string ret;
  4318. do {
  4319. ret = charset[n & 15] + ret;
  4320. n >>= 4;
  4321. } while (n > 0);
  4322. return ret;
  4323. }
  4324. inline std::string compute_etag(const FileStat &fs,
  4325. const std::string &suffix = std::string()) {
  4326. if (!fs.is_file()) { return std::string(); }
  4327. // If mtime cannot be determined (negative value indicates an error
  4328. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4329. // value like 0 could collide with a real file that legitimately has
  4330. // mtime == 0 (epoch) and lead to misleading validators.
  4331. auto mtime_raw = fs.mtime();
  4332. if (mtime_raw < 0) { return std::string(); }
  4333. auto mtime = static_cast<size_t>(mtime_raw);
  4334. auto size = fs.size();
  4335. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4336. from_i_to_hex(size) + suffix + "\"";
  4337. }
  4338. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4339. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4340. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4341. inline std::string file_mtime_to_http_date(time_t mtime) {
  4342. if (mtime < 0) { return std::string(); }
  4343. struct tm tm_buf;
  4344. #ifdef _WIN32
  4345. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4346. #else
  4347. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4348. #endif
  4349. char buf[64];
  4350. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4351. return std::string();
  4352. }
  4353. return std::string(buf);
  4354. }
  4355. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4356. inline time_t parse_http_date(const std::string &date_str) {
  4357. struct tm tm_buf;
  4358. // Create a classic locale object once for all parsing attempts
  4359. const std::locale classic_locale = std::locale::classic();
  4360. // Try to parse using std::get_time (C++11, cross-platform)
  4361. auto try_parse = [&](const char *fmt) -> bool {
  4362. std::istringstream ss(date_str);
  4363. ss.imbue(classic_locale);
  4364. memset(&tm_buf, 0, sizeof(tm_buf));
  4365. ss >> std::get_time(&tm_buf, fmt);
  4366. return !ss.fail();
  4367. };
  4368. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4369. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4370. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4371. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4372. // asctime format: "Sun Nov 6 08:49:37 1994"
  4373. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4374. return static_cast<time_t>(-1);
  4375. }
  4376. }
  4377. }
  4378. #ifdef _WIN32
  4379. return _mkgmtime(&tm_buf);
  4380. #elif defined _AIX
  4381. return mktime(&tm_buf);
  4382. #else
  4383. return timegm(&tm_buf);
  4384. #endif
  4385. }
  4386. inline bool is_weak_etag(const std::string &s) {
  4387. // Check if the string is a weak ETag (starts with 'W/"')
  4388. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4389. }
  4390. inline bool is_strong_etag(const std::string &s) {
  4391. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4392. // chars)
  4393. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4394. }
  4395. inline size_t to_utf8(int code, char *buff) {
  4396. if (code < 0x0080) {
  4397. buff[0] = static_cast<char>(code & 0x7F);
  4398. return 1;
  4399. } else if (code < 0x0800) {
  4400. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4401. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4402. return 2;
  4403. } else if (code < 0xD800) {
  4404. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4405. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4406. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4407. return 3;
  4408. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4409. return 0;
  4410. } else if (code < 0x10000) {
  4411. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4412. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4413. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4414. return 3;
  4415. } else if (code < 0x110000) {
  4416. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4417. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4418. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4419. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4420. return 4;
  4421. }
  4422. // NOTREACHED
  4423. return 0;
  4424. }
  4425. } // namespace detail
  4426. namespace ws {
  4427. namespace impl {
  4428. inline bool is_valid_utf8(const std::string &s) {
  4429. size_t i = 0;
  4430. auto n = s.size();
  4431. while (i < n) {
  4432. auto c = static_cast<unsigned char>(s[i]);
  4433. size_t len;
  4434. uint32_t cp;
  4435. if (c < 0x80) {
  4436. i++;
  4437. continue;
  4438. } else if ((c & 0xE0) == 0xC0) {
  4439. len = 2;
  4440. cp = c & 0x1F;
  4441. } else if ((c & 0xF0) == 0xE0) {
  4442. len = 3;
  4443. cp = c & 0x0F;
  4444. } else if ((c & 0xF8) == 0xF0) {
  4445. len = 4;
  4446. cp = c & 0x07;
  4447. } else {
  4448. return false;
  4449. }
  4450. if (i + len > n) { return false; }
  4451. for (size_t j = 1; j < len; j++) {
  4452. auto b = static_cast<unsigned char>(s[i + j]);
  4453. if ((b & 0xC0) != 0x80) { return false; }
  4454. cp = (cp << 6) | (b & 0x3F);
  4455. }
  4456. // Overlong encoding check
  4457. if (len == 2 && cp < 0x80) { return false; }
  4458. if (len == 3 && cp < 0x800) { return false; }
  4459. if (len == 4 && cp < 0x10000) { return false; }
  4460. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4461. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4462. if (cp > 0x10FFFF) { return false; }
  4463. i += len;
  4464. }
  4465. return true;
  4466. }
  4467. } // namespace impl
  4468. } // namespace ws
  4469. namespace detail {
  4470. // NOTE: This code came up with the following stackoverflow post:
  4471. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4472. inline std::string base64_encode(const std::string &in) {
  4473. static const auto lookup =
  4474. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4475. std::string out;
  4476. out.reserve(in.size());
  4477. // Unsigned: the accumulator is never masked, so with a signed int the
  4478. // `val << 8` below overflows once enough bytes are folded in (undefined
  4479. // behaviour before C++20). Only the low bits are ever emitted, so the
  4480. // wrap-around of an unsigned accumulator does not affect the output.
  4481. uint32_t val = 0;
  4482. auto valb = -6;
  4483. for (auto c : in) {
  4484. val = (val << 8) + static_cast<uint8_t>(c);
  4485. valb += 8;
  4486. while (valb >= 0) {
  4487. out.push_back(lookup[(val >> valb) & 0x3F]);
  4488. valb -= 6;
  4489. }
  4490. }
  4491. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4492. while (out.size() % 4) {
  4493. out.push_back('=');
  4494. }
  4495. return out;
  4496. }
  4497. inline std::string sha1(const std::string &input) {
  4498. // RFC 3174 SHA-1 implementation
  4499. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4500. return (x << n) | (x >> (32 - n));
  4501. };
  4502. uint32_t h0 = 0x67452301;
  4503. uint32_t h1 = 0xEFCDAB89;
  4504. uint32_t h2 = 0x98BADCFE;
  4505. uint32_t h3 = 0x10325476;
  4506. uint32_t h4 = 0xC3D2E1F0;
  4507. // Pre-processing: adding padding bits
  4508. std::string msg = input;
  4509. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4510. msg.push_back(static_cast<char>(0x80u));
  4511. while (msg.size() % 64 != 56) {
  4512. msg.push_back(0);
  4513. }
  4514. // Append original length in bits as 64-bit big-endian
  4515. for (int i = 56; i >= 0; i -= 8) {
  4516. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4517. }
  4518. // Process each 512-bit chunk
  4519. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4520. uint32_t w[80];
  4521. for (size_t i = 0; i < 16; i++) {
  4522. w[i] =
  4523. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4524. << 24) |
  4525. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4526. << 16) |
  4527. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4528. << 8) |
  4529. (static_cast<uint32_t>(
  4530. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4531. }
  4532. for (int i = 16; i < 80; i++) {
  4533. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4534. }
  4535. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4536. for (int i = 0; i < 80; i++) {
  4537. uint32_t f, k;
  4538. if (i < 20) {
  4539. f = (b & c) | ((~b) & d);
  4540. k = 0x5A827999;
  4541. } else if (i < 40) {
  4542. f = b ^ c ^ d;
  4543. k = 0x6ED9EBA1;
  4544. } else if (i < 60) {
  4545. f = (b & c) | (b & d) | (c & d);
  4546. k = 0x8F1BBCDC;
  4547. } else {
  4548. f = b ^ c ^ d;
  4549. k = 0xCA62C1D6;
  4550. }
  4551. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4552. e = d;
  4553. d = c;
  4554. c = left_rotate(b, 30);
  4555. b = a;
  4556. a = temp;
  4557. }
  4558. h0 += a;
  4559. h1 += b;
  4560. h2 += c;
  4561. h3 += d;
  4562. h4 += e;
  4563. }
  4564. // Produce the final hash as a 20-byte binary string
  4565. std::string hash(20, '\0');
  4566. for (size_t i = 0; i < 4; i++) {
  4567. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4568. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4569. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4570. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4571. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4572. }
  4573. return hash;
  4574. }
  4575. inline std::string websocket_accept_key(const std::string &client_key) {
  4576. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4577. return base64_encode(sha1(client_key + magic));
  4578. }
  4579. inline bool is_websocket_upgrade(const Request &req) {
  4580. if (req.method != "GET") { return false; }
  4581. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4582. // list of protocols and asks recipients to match each name
  4583. // case-insensitively, so look for the token rather than compare the whole
  4584. // field value.
  4585. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4586. // Check Connection: Upgrade
  4587. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4588. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4589. // RFC 6455 Section 4.2.1
  4590. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4591. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4592. return false;
  4593. }
  4594. static const std::string b64chars =
  4595. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4596. for (size_t i = 0; i < 22; i++) {
  4597. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4598. }
  4599. // Check Sec-WebSocket-Version: 13
  4600. auto version = req.get_header_value("Sec-WebSocket-Version");
  4601. if (version != "13") { return false; }
  4602. return true;
  4603. }
  4604. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4605. const char *data, size_t len, bool fin,
  4606. bool mask) {
  4607. // First byte: FIN + opcode
  4608. uint8_t header[2];
  4609. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4610. (static_cast<uint8_t>(opcode) & 0x0F));
  4611. // Second byte: MASK + payload length
  4612. if (len < 126) {
  4613. header[1] = static_cast<uint8_t>(len);
  4614. if (mask) { header[1] |= 0x80; }
  4615. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4616. } else if (len <= 0xFFFF) {
  4617. header[1] = 126;
  4618. if (mask) { header[1] |= 0x80; }
  4619. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4620. uint8_t ext[2];
  4621. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4622. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4623. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4624. } else {
  4625. header[1] = 127;
  4626. if (mask) { header[1] |= 0x80; }
  4627. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4628. uint8_t ext[8];
  4629. for (int i = 7; i >= 0; i--) {
  4630. ext[7 - i] =
  4631. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4632. }
  4633. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4634. }
  4635. if (mask) {
  4636. // Generate random mask key
  4637. thread_local std::mt19937 rng(std::random_device{}());
  4638. uint8_t mask_key[4];
  4639. auto r = rng();
  4640. std::memcpy(mask_key, &r, 4);
  4641. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4642. // Write masked payload in chunks
  4643. const size_t chunk_size = 4096;
  4644. std::vector<char> buf((std::min)(len, chunk_size));
  4645. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4646. size_t n = (std::min)(chunk_size, len - offset);
  4647. for (size_t i = 0; i < n; i++) {
  4648. buf[i] =
  4649. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4650. }
  4651. if (strm.write(buf.data(), n) < 0) { return false; }
  4652. }
  4653. } else {
  4654. if (len > 0) {
  4655. if (strm.write(data, len) < 0) { return false; }
  4656. }
  4657. }
  4658. return true;
  4659. }
  4660. } // namespace detail
  4661. namespace ws {
  4662. namespace impl {
  4663. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4664. // hands back whatever its buffer already holds -- so every multi-byte field has
  4665. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4666. // header straddles the read buffer's boundary.
  4667. //
  4668. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4669. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4670. // there is a failure like any other. (When read() fails it always records why,
  4671. // so the error belongs to this call and not to an earlier one.)
  4672. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4673. auto p = static_cast<char *>(buf);
  4674. size_t total = 0;
  4675. while (total < size) {
  4676. auto n = strm.read(p + total, size - total);
  4677. if (n <= 0) {
  4678. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4679. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4680. }
  4681. total += static_cast<size_t>(n);
  4682. }
  4683. return FrameRead::Ok;
  4684. }
  4685. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4686. std::string &payload, bool &fin,
  4687. bool expect_masked, size_t max_len) {
  4688. // Read first 2 bytes. This is the only read that may report a timeout: it
  4689. // sits on a frame boundary, where nothing has been consumed yet.
  4690. uint8_t header[2];
  4691. FrameRead first = read_exact(strm, header, 2);
  4692. if (first != FrameRead::Ok) { return first; }
  4693. fin = (header[0] & 0x80) != 0;
  4694. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4695. if (header[0] & 0x70) { return FrameRead::Fail; }
  4696. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4697. bool masked = (header[1] & 0x80) != 0;
  4698. uint64_t payload_len = header[1] & 0x7F;
  4699. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4700. // MUST have a payload length of 125 bytes or less
  4701. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4702. if (is_control) {
  4703. if (!fin) { return FrameRead::Fail; }
  4704. if (payload_len > 125) { return FrameRead::Fail; }
  4705. }
  4706. if (masked != expect_masked) { return FrameRead::Fail; }
  4707. // Extended payload length
  4708. if (payload_len == 126) {
  4709. uint8_t ext[2];
  4710. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4711. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4712. } else if (payload_len == 127) {
  4713. uint8_t ext[8];
  4714. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4715. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4716. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4717. payload_len = 0;
  4718. for (int i = 0; i < 8; i++) {
  4719. payload_len = (payload_len << 8) | ext[i];
  4720. }
  4721. }
  4722. if (payload_len > max_len) { return FrameRead::Fail; }
  4723. // Read mask key if present
  4724. uint8_t mask_key[4] = {0};
  4725. if (masked) {
  4726. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4727. return FrameRead::Fail;
  4728. }
  4729. }
  4730. // Read payload
  4731. payload.resize(static_cast<size_t>(payload_len));
  4732. if (payload_len > 0 &&
  4733. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4734. FrameRead::Ok) {
  4735. return FrameRead::Fail;
  4736. }
  4737. // Unmask if needed
  4738. if (masked) {
  4739. for (size_t i = 0; i < payload.size(); i++) {
  4740. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4741. }
  4742. }
  4743. return FrameRead::Ok;
  4744. }
  4745. } // namespace impl
  4746. } // namespace ws
  4747. namespace detail {
  4748. inline bool is_valid_path(const std::string &path) {
  4749. size_t level = 0;
  4750. size_t i = 0;
  4751. // Skip slash
  4752. while (i < path.size() && path[i] == '/') {
  4753. i++;
  4754. }
  4755. while (i < path.size()) {
  4756. // Read component
  4757. auto beg = i;
  4758. while (i < path.size() && path[i] != '/') {
  4759. if (path[i] == '\0') {
  4760. return false;
  4761. } else if (path[i] == '\\') {
  4762. return false;
  4763. }
  4764. i++;
  4765. }
  4766. auto len = i - beg;
  4767. assert(len > 0);
  4768. if (!path.compare(beg, len, ".")) {
  4769. ;
  4770. } else if (!path.compare(beg, len, "..")) {
  4771. if (level == 0) { return false; }
  4772. level--;
  4773. } else {
  4774. level++;
  4775. }
  4776. // Skip slash
  4777. while (i < path.size() && path[i] == '/') {
  4778. i++;
  4779. }
  4780. }
  4781. return true;
  4782. }
  4783. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4784. #if defined(_WIN32)
  4785. char buf[_MAX_PATH];
  4786. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4787. resolved = buf;
  4788. #elif defined(PATH_MAX)
  4789. char buf[PATH_MAX];
  4790. if (realpath(path, buf) == nullptr) { return false; }
  4791. resolved = buf;
  4792. #else
  4793. auto buf = realpath(path, nullptr);
  4794. auto guard = scope_exit([&]() { std::free(buf); });
  4795. if (buf == nullptr) { return false; }
  4796. resolved = buf;
  4797. #endif
  4798. return true;
  4799. }
  4800. inline bool is_path_within_base(const std::string &resolved_path,
  4801. const std::string &resolved_base) {
  4802. #if defined(_WIN32)
  4803. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4804. resolved_base.size()) == 0;
  4805. #else
  4806. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4807. resolved_base.size()) == 0;
  4808. #endif
  4809. }
  4810. inline FileStat::FileStat(const std::string &path) {
  4811. #if defined(_WIN32)
  4812. auto wpath = u8string_to_wstring(path.c_str());
  4813. ret_ = _wstat(wpath.c_str(), &st_);
  4814. #else
  4815. ret_ = stat(path.c_str(), &st_);
  4816. #endif
  4817. }
  4818. inline bool FileStat::is_file() const {
  4819. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4820. }
  4821. inline bool FileStat::is_dir() const {
  4822. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4823. }
  4824. inline time_t FileStat::mtime() const {
  4825. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4826. : static_cast<time_t>(-1);
  4827. }
  4828. inline size_t FileStat::size() const {
  4829. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4830. }
  4831. inline std::string encode_path(const std::string &s) {
  4832. std::string result;
  4833. result.reserve(s.size());
  4834. for (size_t i = 0; s[i]; i++) {
  4835. switch (s[i]) {
  4836. case ' ': result += "%20"; break;
  4837. case '+': result += "%2B"; break;
  4838. case '\'': result += "%27"; break;
  4839. case ',': result += "%2C"; break;
  4840. // case ':': result += "%3A"; break; // ok? probably...
  4841. case ';': result += "%3B"; break;
  4842. default:
  4843. auto c = static_cast<uint8_t>(s[i]);
  4844. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4845. // in a request-target as-is.
  4846. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4847. result += '%';
  4848. char hex[4];
  4849. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4850. assert(len == 2);
  4851. result.append(hex, static_cast<size_t>(len));
  4852. } else {
  4853. result += s[i];
  4854. }
  4855. break;
  4856. }
  4857. }
  4858. return result;
  4859. }
  4860. inline std::string file_extension(const std::string &path) {
  4861. std::smatch m;
  4862. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4863. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4864. return std::string();
  4865. }
  4866. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4867. template <typename T>
  4868. inline bool parse_header(const char *beg, const char *end, T fn);
  4869. template <typename T>
  4870. inline bool parse_header(const char *beg, const char *end, T fn) {
  4871. // Skip trailing spaces and tabs.
  4872. while (beg < end && is_space_or_tab(end[-1])) {
  4873. end--;
  4874. }
  4875. auto p = beg;
  4876. while (p < end && *p != ':') {
  4877. p++;
  4878. }
  4879. auto name = std::string(beg, p);
  4880. if (!detail::fields::is_field_name(name)) { return false; }
  4881. if (p == end) { return false; }
  4882. auto key_end = p;
  4883. if (*p++ != ':') { return false; }
  4884. while (p < end && is_space_or_tab(*p)) {
  4885. p++;
  4886. }
  4887. if (p <= end) {
  4888. auto key_len = key_end - beg;
  4889. if (!key_len) { return false; }
  4890. auto key = std::string(beg, key_end);
  4891. auto val = std::string(p, end);
  4892. if (!detail::fields::is_field_value(val)) { return false; }
  4893. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4894. // percent-decoded by the recipient. Applications that need to interpret a
  4895. // value as a URI component should call httplib::decode_uri_component()
  4896. // (or decode_path_component()) explicitly.
  4897. fn(key, val);
  4898. return true;
  4899. }
  4900. return false;
  4901. }
  4902. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4903. const Headers &src_headers) {
  4904. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4905. // transfer coding is complete when a chunk with a chunk-size of zero is
  4906. // received, possibly followed by a trailer section, and finally terminated by
  4907. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4908. //
  4909. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4910. // doesn't care for the existence of the final CRLF. In other words, it seems
  4911. // to be ok whether the final CRLF exists or not in the chunked data.
  4912. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4913. //
  4914. // According to the reference code in RFC 9112, cpp-httplib now allows
  4915. // chunked transfer coding data without the final CRLF.
  4916. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4917. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4918. "transfer-encoding",
  4919. "content-length",
  4920. "host",
  4921. "authorization",
  4922. "www-authenticate",
  4923. "proxy-authenticate",
  4924. "proxy-authorization",
  4925. "cookie",
  4926. "set-cookie",
  4927. "cache-control",
  4928. "expect",
  4929. "max-forwards",
  4930. "pragma",
  4931. "range",
  4932. "te",
  4933. "age",
  4934. "expires",
  4935. "date",
  4936. "location",
  4937. "retry-after",
  4938. "vary",
  4939. "warning",
  4940. "content-encoding",
  4941. "content-type",
  4942. "content-range",
  4943. "trailer"};
  4944. case_ignore::unordered_set<std::string> declared_trailers;
  4945. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4946. if (!trailer_header.empty()) {
  4947. // split() trims each token and skips empty ones, so the name arrives ready
  4948. // to look up.
  4949. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4950. ',', [&](const char *b, const char *e) {
  4951. // A legitimate message declares only a handful of trailers. Cap the
  4952. // set so a peer cannot grow it without bound: an oversized set only
  4953. // arises from an attempt to force many colliding names into
  4954. // quadratic lookups (case_ignore::hash is unkeyed).
  4955. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  4956. return;
  4957. }
  4958. std::string key(b, e);
  4959. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4960. declared_trailers.insert(key);
  4961. }
  4962. });
  4963. }
  4964. size_t trailer_header_count = 0;
  4965. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4966. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4967. // Count every received trailer field, not only the declared ones stored in
  4968. // dest, so undeclared fields cannot keep this loop running past the limit.
  4969. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4970. constexpr auto line_terminator_len = 2;
  4971. auto line_beg = line_reader.ptr();
  4972. auto line_end =
  4973. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4974. if (!parse_header(line_beg, line_end,
  4975. [&](const std::string &key, const std::string &val) {
  4976. if (declared_trailers.find(key) !=
  4977. declared_trailers.end()) {
  4978. dest.emplace(key, val);
  4979. }
  4980. })) {
  4981. return false;
  4982. }
  4983. trailer_header_count++;
  4984. if (!line_reader.getline()) { return false; }
  4985. }
  4986. return true;
  4987. }
  4988. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4989. size_t right) {
  4990. while (b + left < e && is_space_or_tab(b[left])) {
  4991. left++;
  4992. }
  4993. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4994. right--;
  4995. }
  4996. return std::make_pair(left, right);
  4997. }
  4998. inline std::string trim_copy(const std::string &s) {
  4999. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5000. return s.substr(r.first, r.second - r.first);
  5001. }
  5002. inline std::string trim_double_quotes_copy(const std::string &s) {
  5003. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5004. return s.substr(1, s.size() - 2);
  5005. }
  5006. return s;
  5007. }
  5008. inline void
  5009. divide(const char *data, std::size_t size, char d,
  5010. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5011. fn) {
  5012. const auto it = std::find(data, data + size, d);
  5013. const auto found = static_cast<std::size_t>(it != data + size);
  5014. const auto lhs_data = data;
  5015. const auto lhs_size = static_cast<std::size_t>(it - data);
  5016. const auto rhs_data = it + found;
  5017. const auto rhs_size = size - lhs_size - found;
  5018. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5019. }
  5020. inline void
  5021. divide(const std::string &str, char d,
  5022. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5023. fn) {
  5024. divide(str.data(), str.size(), d, std::move(fn));
  5025. }
  5026. inline void split(const char *b, const char *e, char d,
  5027. std::function<void(const char *, const char *)> fn) {
  5028. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5029. }
  5030. inline void split(const char *b, const char *e, char d, size_t m,
  5031. std::function<void(const char *, const char *)> fn) {
  5032. size_t i = 0;
  5033. size_t beg = 0;
  5034. size_t count = 1;
  5035. while (e ? (b + i < e) : (b[i] != '\0')) {
  5036. if (b[i] == d && count < m) {
  5037. auto r = trim(b, e, beg, i);
  5038. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5039. beg = i + 1;
  5040. count++;
  5041. }
  5042. i++;
  5043. }
  5044. if (i) {
  5045. auto r = trim(b, e, beg, i);
  5046. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5047. }
  5048. }
  5049. // Same contract as split(), except that a delimiter inside a quoted-string is
  5050. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5051. // quoted-string, and ';' and '=' are legal characters inside one.
  5052. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5053. std::function<void(const char *, const char *)> fn) {
  5054. size_t i = 0;
  5055. size_t beg = 0;
  5056. size_t count = 1;
  5057. auto in_quotes = false;
  5058. while (e ? (b + i < e) : (b[i] != '\0')) {
  5059. if (b[i] == '"') {
  5060. in_quotes = !in_quotes;
  5061. } else if (b[i] == d && !in_quotes && count < m) {
  5062. auto r = trim(b, e, beg, i);
  5063. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5064. beg = i + 1;
  5065. count++;
  5066. }
  5067. i++;
  5068. }
  5069. if (i) {
  5070. auto r = trim(b, e, beg, i);
  5071. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5072. }
  5073. }
  5074. inline void split_unquoted(const char *b, const char *e, char d,
  5075. std::function<void(const char *, const char *)> fn) {
  5076. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5077. std::move(fn));
  5078. }
  5079. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5080. // key a token, so the first '=' is the separator even when the value is a
  5081. // quoted-string carrying more of them.
  5082. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5083. std::string &val) {
  5084. divide(
  5085. b, static_cast<std::size_t>(e - b), '=',
  5086. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5087. const auto kr = trim(kb, kb + klen, 0, klen);
  5088. key.assign(kb + kr.first, kb + kr.second);
  5089. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5090. val.assign(vb + vr.first, vb + vr.second);
  5091. });
  5092. }
  5093. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5094. std::function<bool(const char *, const char *)> fn) {
  5095. size_t i = 0;
  5096. size_t beg = 0;
  5097. size_t count = 1;
  5098. while (e ? (b + i < e) : (b[i] != '\0')) {
  5099. if (b[i] == d && count < m) {
  5100. auto r = trim(b, e, beg, i);
  5101. if (r.first < r.second) {
  5102. auto found = fn(&b[r.first], &b[r.second]);
  5103. if (found) { return true; }
  5104. }
  5105. beg = i + 1;
  5106. count++;
  5107. }
  5108. i++;
  5109. }
  5110. if (i) {
  5111. auto r = trim(b, e, beg, i);
  5112. if (r.first < r.second) {
  5113. auto found = fn(&b[r.first], &b[r.second]);
  5114. if (found) { return true; }
  5115. }
  5116. }
  5117. return false;
  5118. }
  5119. inline bool split_find(const char *b, const char *e, char d,
  5120. std::function<bool(const char *, const char *)> fn) {
  5121. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5122. std::move(fn));
  5123. }
  5124. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5125. size_t fixed_buffer_size)
  5126. : strm_(strm), fixed_buffer_(fixed_buffer),
  5127. fixed_buffer_size_(fixed_buffer_size) {}
  5128. inline const char *stream_line_reader::ptr() const {
  5129. if (growable_buffer_.empty()) {
  5130. return fixed_buffer_;
  5131. } else {
  5132. return growable_buffer_.data();
  5133. }
  5134. }
  5135. inline size_t stream_line_reader::size() const {
  5136. if (growable_buffer_.empty()) {
  5137. return fixed_buffer_used_size_;
  5138. } else {
  5139. return growable_buffer_.size();
  5140. }
  5141. }
  5142. inline bool stream_line_reader::end_with_crlf() const {
  5143. auto end = ptr() + size();
  5144. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5145. }
  5146. inline bool stream_line_reader::getline() {
  5147. fixed_buffer_used_size_ = 0;
  5148. growable_buffer_.clear();
  5149. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5150. char prev_byte = 0;
  5151. #endif
  5152. for (size_t i = 0;; i++) {
  5153. // Fast path: whatever the stream has already buffered can be scanned for
  5154. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5155. // call, a bounds check and a one-byte copy per character of the request.
  5156. size_t buffered_size = 0;
  5157. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5158. auto take = buffered_size;
  5159. auto terminated = false;
  5160. for (size_t at = 0; at < buffered_size;) {
  5161. auto nl = static_cast<const char *>(
  5162. memchr(buffered + at, '\n', buffered_size - at));
  5163. if (!nl) { break; }
  5164. auto pos = static_cast<size_t>(nl - buffered);
  5165. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5166. take = pos + 1;
  5167. terminated = true;
  5168. break;
  5169. #else
  5170. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5171. // be the last byte of an earlier chunk, hence prev_byte.
  5172. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5173. take = pos + 1;
  5174. terminated = true;
  5175. break;
  5176. }
  5177. at = pos + 1;
  5178. #endif
  5179. }
  5180. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5181. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5182. prev_byte = buffered[take - 1];
  5183. #endif
  5184. append(buffered, take);
  5185. strm_.consume_buffered(take);
  5186. i += take;
  5187. if (terminated) { return true; }
  5188. continue;
  5189. }
  5190. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5191. // Treat exceptionally long lines as an error to
  5192. // prevent infinite loops/memory exhaustion
  5193. return false;
  5194. }
  5195. char byte;
  5196. auto n = strm_.read(&byte, 1);
  5197. if (n < 0) {
  5198. return false;
  5199. } else if (n == 0) {
  5200. if (i == 0) {
  5201. return false;
  5202. } else {
  5203. break;
  5204. }
  5205. }
  5206. append(byte);
  5207. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5208. if (byte == '\n') { break; }
  5209. #else
  5210. if (prev_byte == '\r' && byte == '\n') { break; }
  5211. prev_byte = byte;
  5212. #endif
  5213. }
  5214. return true;
  5215. }
  5216. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5217. inline void stream_line_reader::append(const char *data, size_t size) {
  5218. // Once the line has outgrown the fixed buffer everything must keep going to
  5219. // the growable one, even if a later chunk would have fit. Without the
  5220. // emptiness check a short append after a long one would land in the fixed
  5221. // buffer, which ptr() and size() no longer look at, and be lost.
  5222. if (growable_buffer_.empty() &&
  5223. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5224. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5225. fixed_buffer_used_size_ += size;
  5226. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5227. } else {
  5228. // Unlike the per-character overload, this can be the very first append of
  5229. // the line, so the fixed buffer may hold nothing and carry no terminator
  5230. // yet. assign() takes an explicit length and does not need one.
  5231. if (growable_buffer_.empty()) {
  5232. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5233. }
  5234. growable_buffer_.append(data, size);
  5235. }
  5236. }
  5237. inline mmap::mmap(const char *path) { open(path); }
  5238. inline mmap::~mmap() { close(); }
  5239. inline bool mmap::open(const char *path) {
  5240. close();
  5241. #if defined(_WIN32)
  5242. auto wpath = u8string_to_wstring(path);
  5243. if (wpath.empty()) { return false; }
  5244. hFile_ =
  5245. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5246. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5247. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5248. LARGE_INTEGER size{};
  5249. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5250. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5251. // See:
  5252. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5253. if (static_cast<ULONGLONG>(size.QuadPart) >
  5254. (std::numeric_limits<decltype(size_)>::max)()) {
  5255. // `size_t` might be 32-bits, on 32-bits Windows.
  5256. return false;
  5257. }
  5258. size_ = static_cast<size_t>(size.QuadPart);
  5259. hMapping_ =
  5260. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5261. // Special treatment for an empty file...
  5262. if (hMapping_ == NULL && size_ == 0) {
  5263. close();
  5264. is_open_empty_file = true;
  5265. return true;
  5266. }
  5267. if (hMapping_ == NULL) {
  5268. close();
  5269. return false;
  5270. }
  5271. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5272. if (addr_ == nullptr) {
  5273. close();
  5274. return false;
  5275. }
  5276. #else
  5277. fd_ = ::open(path, O_RDONLY);
  5278. if (fd_ == -1) { return false; }
  5279. struct stat sb;
  5280. if (fstat(fd_, &sb) == -1) {
  5281. close();
  5282. return false;
  5283. }
  5284. size_ = static_cast<size_t>(sb.st_size);
  5285. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5286. // Special treatment for an empty file...
  5287. if (addr_ == MAP_FAILED && size_ == 0) {
  5288. close();
  5289. is_open_empty_file = true;
  5290. return false;
  5291. }
  5292. if (addr_ == MAP_FAILED) {
  5293. // Clear the sentinel before `close()`, since `is_open()` only checks
  5294. // `addr_` against nullptr and `munmap()` must not be called with it.
  5295. addr_ = nullptr;
  5296. close();
  5297. return false;
  5298. }
  5299. #endif
  5300. return true;
  5301. }
  5302. inline bool mmap::is_open() const {
  5303. return is_open_empty_file ? true : addr_ != nullptr;
  5304. }
  5305. inline size_t mmap::size() const { return size_; }
  5306. inline const char *mmap::data() const {
  5307. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5308. }
  5309. inline void mmap::close() {
  5310. #if defined(_WIN32)
  5311. if (addr_) {
  5312. ::UnmapViewOfFile(addr_);
  5313. addr_ = nullptr;
  5314. }
  5315. if (hMapping_) {
  5316. ::CloseHandle(hMapping_);
  5317. hMapping_ = NULL;
  5318. }
  5319. if (hFile_ != INVALID_HANDLE_VALUE) {
  5320. ::CloseHandle(hFile_);
  5321. hFile_ = INVALID_HANDLE_VALUE;
  5322. }
  5323. is_open_empty_file = false;
  5324. #else
  5325. if (addr_ != nullptr) {
  5326. munmap(addr_, size_);
  5327. addr_ = nullptr;
  5328. }
  5329. if (fd_ != -1) {
  5330. ::close(fd_);
  5331. fd_ = -1;
  5332. }
  5333. #endif
  5334. size_ = 0;
  5335. }
  5336. inline int close_socket(socket_t sock) noexcept {
  5337. #ifdef _WIN32
  5338. return closesocket(sock);
  5339. #else
  5340. return close(sock);
  5341. #endif
  5342. }
  5343. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5344. ssize_t res = 0;
  5345. while (true) {
  5346. res = fn();
  5347. if (res < 0 && errno == EINTR) {
  5348. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5349. continue;
  5350. }
  5351. break;
  5352. }
  5353. return res;
  5354. }
  5355. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5356. return handle_EINTR([&]() {
  5357. return recv(sock,
  5358. #ifdef _WIN32
  5359. static_cast<char *>(ptr), static_cast<int>(size),
  5360. #else
  5361. ptr, size,
  5362. #endif
  5363. flags);
  5364. });
  5365. }
  5366. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5367. int flags) {
  5368. return handle_EINTR([&]() {
  5369. return send(sock,
  5370. #ifdef _WIN32
  5371. static_cast<const char *>(ptr), static_cast<int>(size),
  5372. #else
  5373. ptr, size,
  5374. #endif
  5375. flags);
  5376. });
  5377. }
  5378. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5379. #ifdef _WIN32
  5380. return ::WSAPoll(fds, nfds, timeout);
  5381. #else
  5382. return ::poll(fds, nfds, timeout);
  5383. #endif
  5384. }
  5385. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5386. time_t usec) {
  5387. struct pollfd pfd;
  5388. pfd.fd = sock;
  5389. pfd.events = events;
  5390. pfd.revents = 0;
  5391. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5392. // "return immediately", which callers here rely on to probe a socket.
  5393. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5394. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5395. }
  5396. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5397. return select_impl(sock, POLLIN, sec, usec);
  5398. }
  5399. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5400. return select_impl(sock, POLLOUT, sec, usec);
  5401. }
  5402. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5403. time_t usec) {
  5404. struct pollfd pfd_read;
  5405. pfd_read.fd = sock;
  5406. pfd_read.events = POLLIN | POLLOUT;
  5407. pfd_read.revents = 0;
  5408. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5409. auto poll_res =
  5410. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5411. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5412. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5413. auto error = 0;
  5414. socklen_t len = sizeof(error);
  5415. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5416. reinterpret_cast<char *>(&error), &len);
  5417. auto successful = res >= 0 && !error;
  5418. return successful ? Error::Success : Error::Connection;
  5419. }
  5420. return Error::Connection;
  5421. }
  5422. inline bool is_socket_alive(socket_t sock) {
  5423. const auto val = detail::select_read(sock, 0, 0);
  5424. if (val == 0) {
  5425. return true;
  5426. } else if (val < 0 && errno == EBADF) {
  5427. return false;
  5428. }
  5429. char buf[1];
  5430. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5431. }
  5432. class SocketStream final : public Stream {
  5433. public:
  5434. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5435. time_t write_timeout_sec, time_t write_timeout_usec,
  5436. time_t max_timeout_msec = 0,
  5437. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5438. (std::chrono::steady_clock::time_point::min)());
  5439. ~SocketStream() override;
  5440. bool is_readable() const override;
  5441. bool wait_readable() const override;
  5442. bool wait_writable() const override;
  5443. bool is_peer_alive() const override;
  5444. ssize_t read(char *ptr, size_t size) override;
  5445. ssize_t write(const char *ptr, size_t size) override;
  5446. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5447. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5448. socket_t socket() const override;
  5449. time_t duration() const override;
  5450. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5451. const char *buffered_data(size_t &size) const override;
  5452. void consume_buffered(size_t size) override;
  5453. // The caller has just seen this socket become readable. Lets the next read
  5454. // skip its own readiness wait, which would otherwise ask the kernel a
  5455. // question that was answered a moment ago. Consumed by that read.
  5456. void set_readable_hint() { readable_hint_ = true; }
  5457. private:
  5458. bool ensure_readable();
  5459. socket_t sock_;
  5460. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5461. // thread while a read is in flight -- that is the point of it, for a caller
  5462. // holding one connection and wanting control back to send on it.
  5463. std::atomic<time_t> read_timeout_sec_;
  5464. std::atomic<time_t> read_timeout_usec_;
  5465. time_t write_timeout_sec_;
  5466. time_t write_timeout_usec_;
  5467. time_t max_timeout_msec_;
  5468. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5469. std::vector<char> read_buff_;
  5470. size_t read_buff_off_ = 0;
  5471. size_t read_buff_content_size_ = 0;
  5472. bool readable_hint_ = false;
  5473. static const size_t read_buff_size_ = 1024l * 4;
  5474. };
  5475. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5476. time_t keep_alive_timeout_sec) {
  5477. using namespace std::chrono;
  5478. const auto interval_usec =
  5479. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5480. // Avoid expensive `steady_clock::now()` call for the first time
  5481. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5482. const auto start = steady_clock::now() - microseconds{interval_usec};
  5483. const auto timeout = seconds{keep_alive_timeout_sec};
  5484. while (true) {
  5485. if (svr_sock == INVALID_SOCKET) {
  5486. break; // Server socket is closed
  5487. }
  5488. auto val = select_read(sock, 0, interval_usec);
  5489. if (val < 0) {
  5490. break; // Ssocket error
  5491. } else if (val == 0) {
  5492. if (steady_clock::now() - start > timeout) {
  5493. break; // Timeout
  5494. }
  5495. } else {
  5496. return true; // Ready for read
  5497. }
  5498. }
  5499. return false;
  5500. }
  5501. template <typename T>
  5502. inline bool
  5503. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5504. size_t keep_alive_max_count,
  5505. time_t keep_alive_timeout_sec, T callback) {
  5506. assert(keep_alive_max_count > 0);
  5507. auto ret = false;
  5508. auto count = keep_alive_max_count;
  5509. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5510. auto close_connection = count == 1;
  5511. auto connection_closed = false;
  5512. ret = callback(close_connection, connection_closed);
  5513. if (!ret || connection_closed) { break; }
  5514. count--;
  5515. }
  5516. return ret;
  5517. }
  5518. template <typename T>
  5519. inline bool
  5520. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5521. size_t keep_alive_max_count,
  5522. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5523. time_t read_timeout_usec, time_t write_timeout_sec,
  5524. time_t write_timeout_usec, T callback) {
  5525. return process_server_socket_core(
  5526. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5527. [&](bool close_connection, bool &connection_closed) {
  5528. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5529. write_timeout_sec, write_timeout_usec);
  5530. // process_server_socket_core() only gets here once keep_alive() has
  5531. // seen the socket go readable.
  5532. strm.set_readable_hint();
  5533. return callback(strm, close_connection, connection_closed);
  5534. });
  5535. }
  5536. inline bool process_client_socket(
  5537. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5538. time_t write_timeout_sec, time_t write_timeout_usec,
  5539. time_t max_timeout_msec,
  5540. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5541. std::function<bool(Stream &)> callback) {
  5542. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5543. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5544. start_time);
  5545. return callback(strm);
  5546. }
  5547. inline int shutdown_socket(socket_t sock) noexcept {
  5548. #ifdef _WIN32
  5549. return shutdown(sock, SD_BOTH);
  5550. #else
  5551. return shutdown(sock, SHUT_RDWR);
  5552. #endif
  5553. }
  5554. // Half-closes the write side and drains any in-flight/queued bytes before
  5555. // the final shutdown+close. Closing with unread data in the receive queue
  5556. // (or bytes arriving after the receive side is closed) makes the stack send
  5557. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5558. // response as a failed read even though it was fully written.
  5559. inline void drain_and_close_socket(socket_t sock) noexcept {
  5560. #ifdef _WIN32
  5561. shutdown(sock, SD_SEND);
  5562. #else
  5563. shutdown(sock, SHUT_WR);
  5564. #endif
  5565. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5566. size_t total = 0;
  5567. const auto deadline = std::chrono::steady_clock::now() +
  5568. std::chrono::milliseconds(100); // bound #1
  5569. while (total < size_t(1024u * 1024u)) { // bound #2
  5570. const auto remaining =
  5571. std::chrono::duration_cast<std::chrono::microseconds>(
  5572. deadline - std::chrono::steady_clock::now())
  5573. .count();
  5574. if (remaining <= 0) { break; }
  5575. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5576. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5577. if (n <= 0) { break; }
  5578. total += static_cast<size_t>(n);
  5579. }
  5580. shutdown_socket(sock);
  5581. close_socket(sock);
  5582. }
  5583. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5584. if (s.size() > 1 && s[0] == '\0') {
  5585. auto ret = s;
  5586. ret[0] = '@';
  5587. return ret;
  5588. }
  5589. return s;
  5590. }
  5591. inline std::string
  5592. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5593. if (s.size() > 1 && s[0] == '@') {
  5594. auto ret = s;
  5595. ret[0] = '\0';
  5596. return ret;
  5597. }
  5598. return s;
  5599. }
  5600. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5601. const struct addrinfo *hints,
  5602. struct addrinfo **res, time_t timeout_sec) {
  5603. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5604. if (timeout_sec <= 0) {
  5605. // No timeout specified, use standard getaddrinfo
  5606. return getaddrinfo(node, service, hints, res);
  5607. }
  5608. #ifdef _WIN32
  5609. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5610. OVERLAPPED overlapped = {};
  5611. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5612. if (!event) { return EAI_FAIL; }
  5613. overlapped.hEvent = event;
  5614. PADDRINFOEXW result_addrinfo = nullptr;
  5615. HANDLE cancel_handle = nullptr;
  5616. ADDRINFOEXW hints_ex = {};
  5617. if (hints) {
  5618. hints_ex.ai_flags = hints->ai_flags;
  5619. hints_ex.ai_family = hints->ai_family;
  5620. hints_ex.ai_socktype = hints->ai_socktype;
  5621. hints_ex.ai_protocol = hints->ai_protocol;
  5622. }
  5623. auto wnode = u8string_to_wstring(node);
  5624. auto wservice = u8string_to_wstring(service);
  5625. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5626. hints ? &hints_ex : nullptr, &result_addrinfo,
  5627. nullptr, &overlapped, nullptr, &cancel_handle);
  5628. if (ret == WSA_IO_PENDING) {
  5629. auto wait_result =
  5630. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5631. if (wait_result == WAIT_TIMEOUT) {
  5632. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5633. ::CloseHandle(event);
  5634. return EAI_AGAIN;
  5635. }
  5636. DWORD bytes_returned;
  5637. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5638. &bytes_returned, FALSE)) {
  5639. ::CloseHandle(event);
  5640. return ::WSAGetLastError();
  5641. }
  5642. }
  5643. ::CloseHandle(event);
  5644. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5645. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5646. return 0;
  5647. }
  5648. return ret;
  5649. #elif TARGET_OS_MAC && defined(__clang__)
  5650. if (!node) { return EAI_NONAME; }
  5651. // macOS implementation using CFHost API for asynchronous DNS resolution
  5652. CFStringRef hostname_ref = CFStringCreateWithCString(
  5653. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5654. if (!hostname_ref) { return EAI_MEMORY; }
  5655. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5656. CFRelease(hostname_ref);
  5657. if (!host_ref) { return EAI_MEMORY; }
  5658. // Set up context for callback
  5659. struct CFHostContext {
  5660. bool completed = false;
  5661. bool success = false;
  5662. CFArrayRef addresses = nullptr;
  5663. std::mutex mutex;
  5664. std::condition_variable cv;
  5665. } context;
  5666. CFHostClientContext client_context;
  5667. memset(&client_context, 0, sizeof(client_context));
  5668. client_context.info = &context;
  5669. // Set callback
  5670. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5671. const CFStreamError *error, void *info) {
  5672. auto ctx = static_cast<CFHostContext *>(info);
  5673. std::lock_guard<std::mutex> lock(ctx->mutex);
  5674. if (error && error->error != 0) {
  5675. ctx->success = false;
  5676. } else {
  5677. Boolean hasBeenResolved;
  5678. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5679. if (ctx->addresses && hasBeenResolved) {
  5680. CFRetain(ctx->addresses);
  5681. ctx->success = true;
  5682. } else {
  5683. ctx->success = false;
  5684. }
  5685. }
  5686. ctx->completed = true;
  5687. ctx->cv.notify_one();
  5688. };
  5689. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5690. CFRelease(host_ref);
  5691. return EAI_SYSTEM;
  5692. }
  5693. // Schedule on run loop
  5694. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5695. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5696. // Start resolution
  5697. CFStreamError stream_error;
  5698. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5699. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5700. CFRelease(host_ref);
  5701. return EAI_FAIL;
  5702. }
  5703. // Wait for completion with timeout
  5704. auto timeout_time =
  5705. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5706. bool timed_out = false;
  5707. {
  5708. std::unique_lock<std::mutex> lock(context.mutex);
  5709. while (!context.completed) {
  5710. auto now = std::chrono::steady_clock::now();
  5711. if (now >= timeout_time) {
  5712. timed_out = true;
  5713. break;
  5714. }
  5715. // Run the runloop for a short time
  5716. lock.unlock();
  5717. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5718. lock.lock();
  5719. }
  5720. }
  5721. // Clean up
  5722. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5723. CFHostSetClient(host_ref, nullptr, nullptr);
  5724. if (timed_out || !context.completed) {
  5725. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5726. CFRelease(host_ref);
  5727. return EAI_AGAIN;
  5728. }
  5729. if (!context.success || !context.addresses) {
  5730. CFRelease(host_ref);
  5731. return EAI_NODATA;
  5732. }
  5733. // Convert CFArray to addrinfo
  5734. CFIndex count = CFArrayGetCount(context.addresses);
  5735. if (count == 0) {
  5736. CFRelease(context.addresses);
  5737. CFRelease(host_ref);
  5738. return EAI_NODATA;
  5739. }
  5740. struct addrinfo *result_addrinfo = nullptr;
  5741. struct addrinfo **current = &result_addrinfo;
  5742. for (CFIndex i = 0; i < count; i++) {
  5743. CFDataRef addr_data =
  5744. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5745. if (!addr_data) continue;
  5746. const struct sockaddr *sockaddr_ptr =
  5747. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5748. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5749. // Allocate addrinfo structure
  5750. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5751. if (!*current) {
  5752. freeaddrinfo(result_addrinfo);
  5753. CFRelease(context.addresses);
  5754. CFRelease(host_ref);
  5755. return EAI_MEMORY;
  5756. }
  5757. memset(*current, 0, sizeof(struct addrinfo));
  5758. // Set up addrinfo fields
  5759. (*current)->ai_family = sockaddr_ptr->sa_family;
  5760. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5761. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5762. (*current)->ai_addrlen = sockaddr_len;
  5763. // Copy sockaddr
  5764. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5765. if (!(*current)->ai_addr) {
  5766. freeaddrinfo(result_addrinfo);
  5767. CFRelease(context.addresses);
  5768. CFRelease(host_ref);
  5769. return EAI_MEMORY;
  5770. }
  5771. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5772. // Set port if service is specified
  5773. if (service && *service) {
  5774. int port = 0;
  5775. if (parse_port(service, strlen(service), port)) {
  5776. if (sockaddr_ptr->sa_family == AF_INET) {
  5777. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5778. ->sin_port = htons(static_cast<uint16_t>(port));
  5779. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5780. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5781. ->sin6_port = htons(static_cast<uint16_t>(port));
  5782. }
  5783. }
  5784. }
  5785. current = &((*current)->ai_next);
  5786. }
  5787. CFRelease(context.addresses);
  5788. CFRelease(host_ref);
  5789. *res = result_addrinfo;
  5790. return 0;
  5791. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5792. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5793. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5794. // the resolver worker still references the stack-local gaicb. The cancel
  5795. // path therefore waits (gai_suspend with no timeout) for the worker to
  5796. // actually finish before letting the stack frame go. The trade-off is that
  5797. // a wedged DNS server can hold this thread for the system resolver timeout
  5798. // (~30s by default) past the caller's connection timeout.
  5799. struct gaicb request{};
  5800. struct gaicb *requests[1] = {&request};
  5801. struct sigevent sevp{};
  5802. struct timespec timeout{timeout_sec, 0};
  5803. request.ar_name = node;
  5804. request.ar_service = service;
  5805. request.ar_request = hints;
  5806. sevp.sigev_notify = SIGEV_NONE;
  5807. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5808. if (rc != 0) { return rc; }
  5809. auto cleanup = scope_exit([&] {
  5810. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5811. });
  5812. int wait_result = gai_suspend(requests, 1, &timeout);
  5813. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5814. int gai_result = gai_error(&request);
  5815. if (gai_result == 0) {
  5816. *res = request.ar_result;
  5817. request.ar_result = nullptr;
  5818. return 0;
  5819. }
  5820. return gai_result;
  5821. }
  5822. gai_cancel(&request);
  5823. while (gai_error(&request) == EAI_INPROGRESS) {
  5824. gai_suspend(requests, 1, nullptr);
  5825. }
  5826. return wait_result;
  5827. #else
  5828. // Fallback implementation using thread-based timeout for other Unix systems.
  5829. struct GetAddrInfoState {
  5830. ~GetAddrInfoState() {
  5831. if (info) { freeaddrinfo(info); }
  5832. }
  5833. std::mutex mutex;
  5834. std::condition_variable result_cv;
  5835. bool completed = false;
  5836. int result = EAI_SYSTEM;
  5837. std::string node;
  5838. std::string service;
  5839. struct addrinfo hints;
  5840. struct addrinfo *info = nullptr;
  5841. };
  5842. // Allocate on the heap, so the resolver thread can keep using the data.
  5843. auto state = std::make_shared<GetAddrInfoState>();
  5844. if (node) { state->node = node; }
  5845. state->service = service;
  5846. state->hints = *hints;
  5847. std::thread resolve_thread([state]() {
  5848. auto thread_result =
  5849. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5850. &state->info);
  5851. std::lock_guard<std::mutex> lock(state->mutex);
  5852. state->result = thread_result;
  5853. state->completed = true;
  5854. state->result_cv.notify_one();
  5855. });
  5856. // Wait for completion or timeout
  5857. std::unique_lock<std::mutex> lock(state->mutex);
  5858. auto finished =
  5859. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5860. [&] { return state->completed; });
  5861. if (finished) {
  5862. // Operation completed within timeout
  5863. resolve_thread.join();
  5864. *res = state->info;
  5865. state->info = nullptr; // Pass ownership to caller
  5866. return state->result;
  5867. } else {
  5868. // Timeout occurred
  5869. resolve_thread.detach(); // Let the thread finish in background
  5870. return EAI_AGAIN; // Return timeout error
  5871. }
  5872. #endif
  5873. #else
  5874. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5875. return getaddrinfo(node, service, hints, res);
  5876. #endif
  5877. }
  5878. template <typename BindOrConnect>
  5879. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5880. int address_family, int socket_flags, bool tcp_nodelay,
  5881. bool ipv6_v6only, SocketOptions socket_options,
  5882. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5883. // Get address info
  5884. const char *node = nullptr;
  5885. struct addrinfo hints;
  5886. struct addrinfo *result;
  5887. memset(&hints, 0, sizeof(struct addrinfo));
  5888. hints.ai_socktype = SOCK_STREAM;
  5889. hints.ai_protocol = IPPROTO_IP;
  5890. if (!ip.empty()) {
  5891. node = ip.c_str();
  5892. // Ask getaddrinfo to convert IP in c-string to address
  5893. hints.ai_family = AF_UNSPEC;
  5894. hints.ai_flags = AI_NUMERICHOST;
  5895. } else {
  5896. if (!host.empty()) { node = host.c_str(); }
  5897. hints.ai_family = address_family;
  5898. hints.ai_flags = socket_flags;
  5899. }
  5900. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5901. if (hints.ai_family == AF_UNIX) {
  5902. const auto addrlen = host.length();
  5903. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5904. #ifdef SOCK_CLOEXEC
  5905. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5906. hints.ai_protocol);
  5907. #else
  5908. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5909. #endif
  5910. if (sock != INVALID_SOCKET) {
  5911. sockaddr_un addr{};
  5912. addr.sun_family = AF_UNIX;
  5913. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5914. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5915. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5916. hints.ai_addrlen = static_cast<socklen_t>(
  5917. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5918. #ifndef SOCK_CLOEXEC
  5919. #ifndef _WIN32
  5920. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5921. #endif
  5922. #endif
  5923. if (socket_options) { socket_options(sock); }
  5924. #ifdef _WIN32
  5925. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5926. // remove the option.
  5927. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5928. #endif
  5929. bool dummy;
  5930. if (!bind_or_connect(sock, hints, dummy)) {
  5931. close_socket(sock);
  5932. sock = INVALID_SOCKET;
  5933. }
  5934. }
  5935. return sock;
  5936. }
  5937. #endif
  5938. auto service = std::to_string(port);
  5939. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5940. timeout_sec)) {
  5941. #if defined __linux__ && !defined __ANDROID__
  5942. res_init();
  5943. #endif
  5944. return INVALID_SOCKET;
  5945. }
  5946. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5947. for (auto rp = result; rp; rp = rp->ai_next) {
  5948. // Create a socket
  5949. #ifdef _WIN32
  5950. auto sock =
  5951. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5952. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5953. /**
  5954. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5955. * and above the socket creation fails on older Windows Systems.
  5956. *
  5957. * Let's try to create a socket the old way in this case.
  5958. *
  5959. * Reference:
  5960. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5961. *
  5962. * WSA_FLAG_NO_HANDLE_INHERIT:
  5963. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5964. * SP1, and later
  5965. *
  5966. */
  5967. if (sock == INVALID_SOCKET) {
  5968. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5969. }
  5970. #else
  5971. #ifdef SOCK_CLOEXEC
  5972. auto sock =
  5973. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5974. #else
  5975. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5976. #endif
  5977. #endif
  5978. if (sock == INVALID_SOCKET) { continue; }
  5979. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5980. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5981. close_socket(sock);
  5982. continue;
  5983. }
  5984. #endif
  5985. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5986. if (rp->ai_family == AF_INET6) {
  5987. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5988. }
  5989. if (socket_options) { socket_options(sock); }
  5990. // bind or connect
  5991. auto quit = false;
  5992. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5993. close_socket(sock);
  5994. if (quit) { break; }
  5995. }
  5996. return INVALID_SOCKET;
  5997. }
  5998. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5999. #ifdef _WIN32
  6000. auto flags = nonblocking ? 1UL : 0UL;
  6001. ioctlsocket(sock, FIONBIO, &flags);
  6002. #else
  6003. auto flags = fcntl(sock, F_GETFL, 0);
  6004. fcntl(sock, F_SETFL,
  6005. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6006. #endif
  6007. }
  6008. inline bool is_connection_error() {
  6009. #ifdef _WIN32
  6010. return WSAGetLastError() != WSAEWOULDBLOCK;
  6011. #else
  6012. return errno != EINPROGRESS;
  6013. #endif
  6014. }
  6015. // accept() failed because the process or the network stack is temporarily out
  6016. // of resources. The listening socket is still usable, so back off briefly and
  6017. // try again.
  6018. inline bool is_accept_resource_error() {
  6019. #ifdef _WIN32
  6020. auto err = WSAGetLastError();
  6021. return err == WSAEMFILE || err == WSAENOBUFS;
  6022. #else
  6023. auto err = errno;
  6024. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6025. #endif
  6026. }
  6027. // accept() failed for a reason that says nothing about the listening socket:
  6028. // the pending connection went away before it could be accepted, or the call
  6029. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6030. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6031. // connection that way.
  6032. inline bool is_accept_transient_error() {
  6033. #ifdef _WIN32
  6034. auto err = WSAGetLastError();
  6035. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6036. err == WSAECONNABORTED;
  6037. #else
  6038. auto err = errno;
  6039. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6040. err == ECONNABORTED;
  6041. #endif
  6042. }
  6043. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6044. struct addrinfo hints;
  6045. struct addrinfo *result;
  6046. memset(&hints, 0, sizeof(struct addrinfo));
  6047. hints.ai_family = AF_UNSPEC;
  6048. hints.ai_socktype = SOCK_STREAM;
  6049. hints.ai_protocol = 0;
  6050. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6051. return false;
  6052. }
  6053. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6054. auto ret = false;
  6055. for (auto rp = result; rp; rp = rp->ai_next) {
  6056. const auto &ai = *rp;
  6057. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6058. ret = true;
  6059. break;
  6060. }
  6061. }
  6062. return ret;
  6063. }
  6064. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6065. #define USE_IF2IP
  6066. #endif
  6067. #ifdef USE_IF2IP
  6068. inline std::string if2ip(int address_family, const std::string &ifn) {
  6069. struct ifaddrs *ifap;
  6070. getifaddrs(&ifap);
  6071. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6072. std::string addr_candidate;
  6073. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6074. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6075. (AF_UNSPEC == address_family ||
  6076. ifa->ifa_addr->sa_family == address_family)) {
  6077. if (ifa->ifa_addr->sa_family == AF_INET) {
  6078. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6079. char buf[INET_ADDRSTRLEN];
  6080. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6081. return std::string(buf, INET_ADDRSTRLEN);
  6082. }
  6083. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6084. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6085. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6086. char buf[INET6_ADDRSTRLEN] = {};
  6087. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6088. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6089. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6090. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6091. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6092. } else {
  6093. return std::string(buf, INET6_ADDRSTRLEN);
  6094. }
  6095. }
  6096. }
  6097. }
  6098. }
  6099. }
  6100. return addr_candidate;
  6101. }
  6102. #endif
  6103. inline socket_t create_client_socket(
  6104. const std::string &host, const std::string &ip, int port,
  6105. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6106. SocketOptions socket_options, time_t connection_timeout_sec,
  6107. time_t connection_timeout_usec, time_t read_timeout_sec,
  6108. time_t read_timeout_usec, time_t write_timeout_sec,
  6109. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6110. auto sock = create_socket(
  6111. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6112. std::move(socket_options),
  6113. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6114. if (!intf.empty()) {
  6115. #ifdef USE_IF2IP
  6116. auto ip_from_if = if2ip(address_family, intf);
  6117. if (ip_from_if.empty()) { ip_from_if = intf; }
  6118. if (!bind_ip_address(sock2, ip_from_if)) {
  6119. error = Error::BindIPAddress;
  6120. return false;
  6121. }
  6122. #endif
  6123. }
  6124. set_nonblocking(sock2, true);
  6125. auto ret =
  6126. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6127. if (ret < 0) {
  6128. if (is_connection_error()) {
  6129. error = Error::Connection;
  6130. return false;
  6131. }
  6132. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6133. connection_timeout_usec);
  6134. if (error != Error::Success) {
  6135. if (error == Error::ConnectionTimeout) { quit = true; }
  6136. return false;
  6137. }
  6138. }
  6139. set_nonblocking(sock2, false);
  6140. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6141. read_timeout_usec);
  6142. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6143. write_timeout_usec);
  6144. error = Error::Success;
  6145. return true;
  6146. },
  6147. connection_timeout_sec); // Pass DNS timeout
  6148. if (sock != INVALID_SOCKET) {
  6149. error = Error::Success;
  6150. } else {
  6151. if (error == Error::Success) { error = Error::Connection; }
  6152. }
  6153. return sock;
  6154. }
  6155. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6156. socklen_t addr_len, std::string &ip, int &port) {
  6157. if (addr.ss_family == AF_INET) {
  6158. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6159. } else if (addr.ss_family == AF_INET6) {
  6160. port =
  6161. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6162. } else {
  6163. return false;
  6164. }
  6165. std::array<char, NI_MAXHOST> ipstr{};
  6166. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6167. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6168. 0, NI_NUMERICHOST)) {
  6169. return false;
  6170. }
  6171. ip = ipstr.data();
  6172. return true;
  6173. }
  6174. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6175. struct sockaddr_storage addr;
  6176. socklen_t addr_len = sizeof(addr);
  6177. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6178. &addr_len)) {
  6179. get_ip_and_port(addr, addr_len, ip, port);
  6180. }
  6181. }
  6182. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6183. struct sockaddr_storage addr;
  6184. socklen_t addr_len = sizeof(addr);
  6185. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6186. &addr_len)) {
  6187. #ifndef _WIN32
  6188. if (addr.ss_family == AF_UNIX) {
  6189. #if defined(__linux__)
  6190. struct ucred ucred;
  6191. socklen_t len = sizeof(ucred);
  6192. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6193. port = ucred.pid;
  6194. }
  6195. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6196. pid_t pid;
  6197. socklen_t len = sizeof(pid);
  6198. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6199. port = pid;
  6200. }
  6201. #endif
  6202. return;
  6203. }
  6204. #endif
  6205. get_ip_and_port(addr, addr_len, ip, port);
  6206. }
  6207. }
  6208. // Recursive form retained so operator""_t below can compute hashes for
  6209. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6210. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6211. // instead, which is iterative and stack-safe.
  6212. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6213. unsigned int h) {
  6214. return (l == 0)
  6215. ? h
  6216. : str2tag_core(
  6217. s + 1, l - 1,
  6218. // Unsets the 6 high bits of h, therefore no overflow happens
  6219. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6220. h * 33) ^
  6221. static_cast<unsigned char>(*s));
  6222. }
  6223. inline unsigned int str2tag(const std::string &s) {
  6224. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6225. // for compile-time UDL evaluation of short string literals, but at runtime
  6226. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6227. // would blow the stack with one frame per character.
  6228. unsigned int h = 0;
  6229. for (auto c : s) {
  6230. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6231. static_cast<unsigned char>(c);
  6232. }
  6233. return h;
  6234. }
  6235. namespace udl {
  6236. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6237. return str2tag_core(s, l, 0);
  6238. }
  6239. } // namespace udl
  6240. inline std::string
  6241. find_content_type(const std::string &path,
  6242. const std::map<std::string, std::string> &user_data,
  6243. const std::string &default_content_type) {
  6244. auto ext = file_extension(path);
  6245. auto it = user_data.find(ext);
  6246. if (it != user_data.end()) { return it->second; }
  6247. using udl::operator""_t;
  6248. switch (str2tag(ext)) {
  6249. default: return default_content_type;
  6250. case "css"_t: return "text/css";
  6251. case "csv"_t: return "text/csv";
  6252. case "htm"_t:
  6253. case "html"_t: return "text/html";
  6254. case "js"_t:
  6255. case "mjs"_t: return "text/javascript";
  6256. case "txt"_t: return "text/plain";
  6257. case "vtt"_t: return "text/vtt";
  6258. case "apng"_t: return "image/apng";
  6259. case "avif"_t: return "image/avif";
  6260. case "bmp"_t: return "image/bmp";
  6261. case "gif"_t: return "image/gif";
  6262. case "png"_t: return "image/png";
  6263. case "svg"_t: return "image/svg+xml";
  6264. case "webp"_t: return "image/webp";
  6265. case "ico"_t: return "image/x-icon";
  6266. case "tif"_t: return "image/tiff";
  6267. case "tiff"_t: return "image/tiff";
  6268. case "jpg"_t:
  6269. case "jpeg"_t: return "image/jpeg";
  6270. case "mp4"_t: return "video/mp4";
  6271. case "mpeg"_t: return "video/mpeg";
  6272. case "webm"_t: return "video/webm";
  6273. case "mp3"_t: return "audio/mp3";
  6274. case "mpga"_t: return "audio/mpeg";
  6275. case "weba"_t: return "audio/webm";
  6276. case "wav"_t: return "audio/wave";
  6277. case "otf"_t: return "font/otf";
  6278. case "ttf"_t: return "font/ttf";
  6279. case "woff"_t: return "font/woff";
  6280. case "woff2"_t: return "font/woff2";
  6281. case "7z"_t: return "application/x-7z-compressed";
  6282. case "atom"_t: return "application/atom+xml";
  6283. case "pdf"_t: return "application/pdf";
  6284. case "json"_t: return "application/json";
  6285. case "rss"_t: return "application/rss+xml";
  6286. case "tar"_t: return "application/x-tar";
  6287. case "xht"_t:
  6288. case "xhtml"_t: return "application/xhtml+xml";
  6289. case "xslt"_t: return "application/xslt+xml";
  6290. case "xml"_t: return "application/xml";
  6291. case "gz"_t: return "application/gzip";
  6292. case "zip"_t: return "application/zip";
  6293. case "wasm"_t: return "application/wasm";
  6294. }
  6295. }
  6296. inline std::string
  6297. extract_media_type(const std::string &content_type,
  6298. std::map<std::string, std::string> *params = nullptr) {
  6299. // Extract type/subtype from Content-Type value (RFC 2045)
  6300. // e.g. "application/json; charset=utf-8" -> "application/json"
  6301. auto media_type = content_type;
  6302. auto semicolon_pos = media_type.find(';');
  6303. if (semicolon_pos != std::string::npos) {
  6304. auto param_str = media_type.substr(semicolon_pos + 1);
  6305. media_type = media_type.substr(0, semicolon_pos);
  6306. if (params) {
  6307. // Parse parameters: key=value pairs separated by ';'
  6308. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6309. [&](const char *b, const char *e) {
  6310. std::string key;
  6311. std::string val;
  6312. divide_param_pair(b, e, key, val);
  6313. if (!key.empty()) {
  6314. params->emplace(trim_copy(key),
  6315. trim_double_quotes_copy(val));
  6316. }
  6317. });
  6318. }
  6319. }
  6320. // Trim whitespace from media type
  6321. return trim_copy(media_type);
  6322. }
  6323. inline bool can_compress_content_type(const std::string &content_type) {
  6324. using udl::operator""_t;
  6325. auto mime_type = extract_media_type(content_type);
  6326. auto tag = str2tag(mime_type);
  6327. switch (tag) {
  6328. case "image/svg+xml"_t:
  6329. case "application/javascript"_t:
  6330. case "application/x-javascript"_t:
  6331. case "application/json"_t:
  6332. case "application/ld+json"_t:
  6333. case "application/xml"_t:
  6334. case "application/xhtml+xml"_t:
  6335. case "application/rss+xml"_t:
  6336. case "application/atom+xml"_t:
  6337. case "application/xslt+xml"_t:
  6338. case "application/protobuf"_t: return true;
  6339. case "text/event-stream"_t: return false;
  6340. default: return !mime_type.rfind("text/", 0);
  6341. }
  6342. }
  6343. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6344. double &quality) {
  6345. quality = 1.0;
  6346. token.clear();
  6347. // Split on first ';': left = token name, right = parameters
  6348. const char *params_b = nullptr;
  6349. std::size_t params_len = 0;
  6350. divide(
  6351. b, static_cast<std::size_t>(e - b), ';',
  6352. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6353. auto r = trim(lb, lb + llen, 0, llen);
  6354. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6355. params_b = rb;
  6356. params_len = rlen;
  6357. });
  6358. if (token.empty()) { return false; }
  6359. if (params_len == 0) { return true; }
  6360. // Scan parameters for q= (stops on first match)
  6361. bool invalid = false;
  6362. split_find(params_b, params_b + params_len, ';',
  6363. (std::numeric_limits<size_t>::max)(),
  6364. [&](const char *pb, const char *pe) -> bool {
  6365. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6366. auto len = static_cast<size_t>(pe - pb);
  6367. if (len < 2) { return false; }
  6368. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6369. return false;
  6370. }
  6371. // Trim the value portion
  6372. auto r = trim(pb, pe, 2, len);
  6373. if (r.first >= r.second) {
  6374. invalid = true;
  6375. return true;
  6376. }
  6377. double v = 0.0;
  6378. auto res = from_chars(pb + r.first, pb + r.second, v);
  6379. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6380. v < 0.0 || v > 1.0) {
  6381. invalid = true;
  6382. return true;
  6383. }
  6384. quality = v;
  6385. return true;
  6386. });
  6387. return !invalid;
  6388. }
  6389. inline EncodingType encoding_type(const Request &req,
  6390. const std::string &content_type) {
  6391. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6392. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6393. if (s.empty()) { return EncodingType::None; }
  6394. // Single-pass: iterate tokens and track the best supported encoding.
  6395. // Server preference breaks ties (br > gzip > zstd).
  6396. EncodingType best = EncodingType::None;
  6397. double best_q = 0.0; // q=0 means "not acceptable"
  6398. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6399. auto priority = [](EncodingType t) -> int {
  6400. switch (t) {
  6401. case EncodingType::Brotli: return 0;
  6402. case EncodingType::Gzip: return 1;
  6403. case EncodingType::Zstd: return 2;
  6404. default: return 3;
  6405. }
  6406. };
  6407. std::string name;
  6408. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6409. double quality = 1.0;
  6410. if (!parse_quality(b, e, name, quality)) { return; }
  6411. if (quality <= 0.0) { return; }
  6412. EncodingType type = EncodingType::None;
  6413. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6414. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6415. #endif
  6416. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6417. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6418. type = EncodingType::Gzip;
  6419. }
  6420. #endif
  6421. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6422. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6423. type = EncodingType::Zstd;
  6424. }
  6425. #endif
  6426. if (type == EncodingType::None) { return; }
  6427. // Higher q-value wins; for equal q, server preference breaks ties
  6428. if (quality > best_q ||
  6429. (quality == best_q && priority(type) < priority(best))) {
  6430. best_q = quality;
  6431. best = type;
  6432. }
  6433. });
  6434. return best;
  6435. }
  6436. // `content_type` is taken separately because a file-backed response has not
  6437. // been given one yet when its coding has to be decided.
  6438. inline EncodingType encoding_type(const Request &req, const Response &res,
  6439. const std::string &content_type) {
  6440. // The response already names a content coding of its own: a handler serving
  6441. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6442. // point whose headers name the coding its files are stored in. Applying one
  6443. // on top of that would double-encode the body and append a second
  6444. // `Content-Encoding` field line.
  6445. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6446. return encoding_type(req, content_type);
  6447. }
  6448. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6449. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6450. }
  6451. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6452. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6453. if (type == EncodingType::Gzip) {
  6454. return detail::make_unique<gzip_compressor>();
  6455. }
  6456. #endif
  6457. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6458. if (type == EncodingType::Brotli) {
  6459. return detail::make_unique<brotli_compressor>();
  6460. }
  6461. #endif
  6462. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6463. if (type == EncodingType::Zstd) {
  6464. return detail::make_unique<zstd_compressor>();
  6465. }
  6466. #endif
  6467. (void)type;
  6468. return nullptr;
  6469. }
  6470. inline const char *encoding_name(EncodingType type) {
  6471. switch (type) {
  6472. case EncodingType::Gzip: return "gzip";
  6473. case EncodingType::Brotli: return "br";
  6474. case EncodingType::Zstd: return "zstd";
  6475. default: return "";
  6476. }
  6477. }
  6478. inline bool nocompressor::compress(const char *data, size_t data_length,
  6479. bool /*last*/, Callback callback) {
  6480. if (!data_length) { return true; }
  6481. return callback(data, data_length);
  6482. }
  6483. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6484. inline gzip_compressor::gzip_compressor() {
  6485. std::memset(&strm_, 0, sizeof(strm_));
  6486. strm_.zalloc = Z_NULL;
  6487. strm_.zfree = Z_NULL;
  6488. strm_.opaque = Z_NULL;
  6489. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6490. Z_DEFAULT_STRATEGY) == Z_OK;
  6491. }
  6492. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6493. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6494. bool last, Callback callback) {
  6495. assert(is_valid_);
  6496. do {
  6497. constexpr size_t max_avail_in =
  6498. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6499. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6500. (std::min)(data_length, max_avail_in));
  6501. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6502. data_length -= strm_.avail_in;
  6503. data += strm_.avail_in;
  6504. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6505. auto ret = Z_OK;
  6506. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6507. do {
  6508. strm_.avail_out = static_cast<uInt>(buff.size());
  6509. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6510. ret = deflate(&strm_, flush);
  6511. if (ret == Z_STREAM_ERROR) { return false; }
  6512. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6513. return false;
  6514. }
  6515. } while (strm_.avail_out == 0);
  6516. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6517. (flush == Z_NO_FLUSH && ret == Z_OK));
  6518. assert(strm_.avail_in == 0);
  6519. } while (data_length > 0);
  6520. return true;
  6521. }
  6522. inline gzip_decompressor::gzip_decompressor() {
  6523. std::memset(&strm_, 0, sizeof(strm_));
  6524. strm_.zalloc = Z_NULL;
  6525. strm_.zfree = Z_NULL;
  6526. strm_.opaque = Z_NULL;
  6527. // 15 is the value of wbits, which should be at the maximum possible value
  6528. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6529. // that the stream type should be automatically detected either gzip or
  6530. // deflate.
  6531. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6532. }
  6533. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6534. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6535. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6536. Callback callback) {
  6537. assert(is_valid_);
  6538. auto ret = Z_OK;
  6539. do {
  6540. constexpr size_t max_avail_in =
  6541. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6542. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6543. (std::min)(data_length, max_avail_in));
  6544. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6545. data_length -= strm_.avail_in;
  6546. data += strm_.avail_in;
  6547. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6548. while (strm_.avail_in > 0 && ret == Z_OK) {
  6549. strm_.avail_out = static_cast<uInt>(buff.size());
  6550. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6551. ret = inflate(&strm_, Z_NO_FLUSH);
  6552. assert(ret != Z_STREAM_ERROR);
  6553. switch (ret) {
  6554. case Z_NEED_DICT:
  6555. case Z_DATA_ERROR:
  6556. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6557. }
  6558. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6559. return false;
  6560. }
  6561. }
  6562. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6563. } while (data_length > 0);
  6564. return true;
  6565. }
  6566. #endif
  6567. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6568. inline brotli_compressor::brotli_compressor() {
  6569. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6570. }
  6571. inline brotli_compressor::~brotli_compressor() {
  6572. BrotliEncoderDestroyInstance(state_);
  6573. }
  6574. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6575. bool last, Callback callback) {
  6576. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6577. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6578. auto available_in = data_length;
  6579. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6580. for (;;) {
  6581. if (last) {
  6582. if (BrotliEncoderIsFinished(state_)) { break; }
  6583. } else {
  6584. if (!available_in) { break; }
  6585. }
  6586. auto available_out = buff.size();
  6587. auto next_out = buff.data();
  6588. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6589. &available_out, &next_out, nullptr)) {
  6590. return false;
  6591. }
  6592. auto output_bytes = buff.size() - available_out;
  6593. if (output_bytes) {
  6594. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6595. }
  6596. }
  6597. return true;
  6598. }
  6599. inline brotli_decompressor::brotli_decompressor() {
  6600. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6601. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6602. : BROTLI_DECODER_RESULT_ERROR;
  6603. }
  6604. inline brotli_decompressor::~brotli_decompressor() {
  6605. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6606. }
  6607. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6608. inline bool brotli_decompressor::decompress(const char *data,
  6609. size_t data_length,
  6610. Callback callback) {
  6611. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6612. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6613. return 0;
  6614. }
  6615. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6616. size_t avail_in = data_length;
  6617. size_t total_out;
  6618. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6619. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6620. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6621. char *next_out = buff.data();
  6622. size_t avail_out = buff.size();
  6623. decoder_r = BrotliDecoderDecompressStream(
  6624. decoder_s, &avail_in, &next_in, &avail_out,
  6625. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6626. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6627. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6628. }
  6629. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6630. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6631. }
  6632. #endif
  6633. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6634. inline zstd_compressor::zstd_compressor() {
  6635. ctx_ = ZSTD_createCCtx();
  6636. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6637. }
  6638. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6639. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6640. bool last, Callback callback) {
  6641. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6642. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6643. ZSTD_inBuffer input = {data, data_length, 0};
  6644. bool finished;
  6645. do {
  6646. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6647. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6648. if (ZSTD_isError(remaining)) { return false; }
  6649. if (!callback(buff.data(), output.pos)) { return false; }
  6650. finished = last ? (remaining == 0) : (input.pos == input.size);
  6651. } while (!finished);
  6652. return true;
  6653. }
  6654. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6655. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6656. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6657. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6658. Callback callback) {
  6659. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6660. ZSTD_inBuffer input = {data, data_length, 0};
  6661. while (input.pos < input.size) {
  6662. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6663. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6664. if (ZSTD_isError(remaining)) { return false; }
  6665. if (!callback(buff.data(), output.pos)) { return false; }
  6666. }
  6667. return true;
  6668. }
  6669. #endif
  6670. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6671. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6672. // unknown coding, and its payload would be handed back still compressed.
  6673. inline bool is_zlib_encoding(const std::string &encoding) {
  6674. return case_ignore::equal(encoding, "gzip") ||
  6675. case_ignore::equal(encoding, "deflate");
  6676. }
  6677. inline bool is_brotli_encoding(const std::string &encoding) {
  6678. return case_ignore::equal(encoding, "br");
  6679. }
  6680. inline bool is_zstd_encoding(const std::string &encoding) {
  6681. return case_ignore::equal(encoding, "zstd");
  6682. }
  6683. // Returns true if the content coding is one cpp-httplib is able to decompress
  6684. // when the corresponding support is compiled in.
  6685. inline bool is_known_content_encoding(const std::string &encoding) {
  6686. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6687. is_zstd_encoding(encoding);
  6688. }
  6689. inline std::unique_ptr<decompressor>
  6690. create_decompressor(const std::string &encoding) {
  6691. std::unique_ptr<decompressor> decompressor;
  6692. if (is_zlib_encoding(encoding)) {
  6693. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6694. decompressor = detail::make_unique<gzip_decompressor>();
  6695. #endif
  6696. } else if (is_brotli_encoding(encoding)) {
  6697. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6698. decompressor = detail::make_unique<brotli_decompressor>();
  6699. #endif
  6700. } else if (is_zstd_encoding(encoding)) {
  6701. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6702. decompressor = detail::make_unique<zstd_decompressor>();
  6703. #endif
  6704. }
  6705. return decompressor;
  6706. }
  6707. // Returns the best available compressor and its Content-Encoding name.
  6708. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6709. inline std::pair<std::unique_ptr<compressor>, const char *>
  6710. create_compressor() {
  6711. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6712. return {detail::make_unique<brotli_compressor>(), "br"};
  6713. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6714. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6715. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6716. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6717. #else
  6718. return {nullptr, nullptr};
  6719. #endif
  6720. }
  6721. inline bool is_prohibited_header_name(const std::string &name) {
  6722. using udl::operator""_t;
  6723. switch (str2tag(name)) {
  6724. case "REMOTE_ADDR"_t:
  6725. case "REMOTE_PORT"_t:
  6726. case "LOCAL_ADDR"_t:
  6727. case "LOCAL_PORT"_t: return true;
  6728. default: return false;
  6729. }
  6730. }
  6731. inline bool has_header(const Headers &headers, const std::string &key) {
  6732. if (is_prohibited_header_name(key)) { return false; }
  6733. return headers.find(key) != headers.end();
  6734. }
  6735. inline const char *get_header_value(const Headers &headers,
  6736. const std::string &key, const char *def,
  6737. size_t id) {
  6738. if (is_prohibited_header_name(key)) {
  6739. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6740. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6741. throw std::invalid_argument(msg);
  6742. #else
  6743. return "";
  6744. #endif
  6745. }
  6746. auto rng = headers.equal_range(key);
  6747. auto it = rng.first;
  6748. std::advance(it, static_cast<ssize_t>(id));
  6749. if (it != rng.second) { return it->second.c_str(); }
  6750. return def;
  6751. }
  6752. inline size_t get_header_value_count(const Headers &headers,
  6753. const std::string &key) {
  6754. return headers.count(key);
  6755. }
  6756. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6757. // list may be sent as several field lines, and the combined field value is
  6758. // those values joined by commas in the order they were received. Callers that
  6759. // parse such a list must work on the combined value; reading only the first
  6760. // occurrence silently drops whatever the later field lines carry.
  6761. inline std::string get_combined_header_value(const Headers &headers,
  6762. const std::string &key) {
  6763. std::string combined;
  6764. auto rng = headers.equal_range(key);
  6765. for (auto it = rng.first; it != rng.second; ++it) {
  6766. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6767. // elements, so an empty field line must not contribute a bare comma to the
  6768. // combined value.
  6769. if (it->second.empty()) { continue; }
  6770. if (!combined.empty()) { combined += ", "; }
  6771. combined += it->second;
  6772. }
  6773. return combined;
  6774. }
  6775. inline bool has_header_token(const Headers &headers, const std::string &key,
  6776. const std::string &token) {
  6777. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6778. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6779. // several lines. Match complete tokens rather than searching the raw value,
  6780. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6781. auto rng = headers.equal_range(key);
  6782. for (auto it = rng.first; it != rng.second; ++it) {
  6783. const auto &value = it->second;
  6784. if (split_find(value.data(), value.data() + value.size(), ',',
  6785. [&](const char *b, const char *e) {
  6786. return case_ignore::equal(std::string(b, e), token);
  6787. })) {
  6788. return true;
  6789. }
  6790. }
  6791. return false;
  6792. }
  6793. template <typename Map>
  6794. inline typename Map::mapped_type
  6795. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6796. auto rng = m.equal_range(key);
  6797. auto it = rng.first;
  6798. std::advance(it, static_cast<ssize_t>(id));
  6799. if (it != rng.second) { return it->second; }
  6800. return typename Map::mapped_type();
  6801. }
  6802. inline void set_header(Headers &headers, const std::string &key,
  6803. const std::string &val) {
  6804. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6805. }
  6806. inline bool read_headers(Stream &strm, Headers &headers) {
  6807. const auto bufsiz = 2048;
  6808. char buf[bufsiz];
  6809. stream_line_reader line_reader(strm, buf, bufsiz);
  6810. size_t header_count = 0;
  6811. for (;;) {
  6812. if (!line_reader.getline()) { return false; }
  6813. // Check if the line ends with CRLF.
  6814. auto line_terminator_len = 2;
  6815. if (line_reader.end_with_crlf()) {
  6816. // Blank line indicates end of headers.
  6817. if (line_reader.size() == 2) { break; }
  6818. } else {
  6819. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6820. // Blank line indicates end of headers.
  6821. if (line_reader.size() == 1) { break; }
  6822. line_terminator_len = 1;
  6823. #else
  6824. continue; // Skip invalid line.
  6825. #endif
  6826. }
  6827. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6828. // Check header count limit
  6829. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6830. // Exclude line terminator
  6831. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6832. if (!parse_header(line_reader.ptr(), end,
  6833. [&](const std::string &key, const std::string &val) {
  6834. headers.emplace(key, val);
  6835. })) {
  6836. return false;
  6837. }
  6838. header_count++;
  6839. }
  6840. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6841. // headers that have different values to prevent request smuggling.
  6842. auto cl_range = headers.equal_range("Content-Length");
  6843. if (cl_range.first != cl_range.second) {
  6844. const auto &first_val = cl_range.first->second;
  6845. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6846. if (it->second != first_val) { return false; }
  6847. }
  6848. }
  6849. return true;
  6850. }
  6851. inline bool parse_status_line(const char *line, std::string &version,
  6852. int &status, std::string &reason) {
  6853. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6854. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6855. #else
  6856. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6857. #endif
  6858. std::cmatch m;
  6859. if (!std::regex_match(line, m, re)) { return false; }
  6860. version = std::string(m[1]);
  6861. status = std::stoi(std::string(m[2]));
  6862. reason = std::string(m[3]);
  6863. return true;
  6864. }
  6865. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6866. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6867. struct WebSocketUpgradeResponse {
  6868. Error error = Error::Success;
  6869. int status = -1;
  6870. Headers headers;
  6871. std::string selected_subprotocol;
  6872. };
  6873. inline bool read_websocket_upgrade_response(Stream &strm,
  6874. const std::string &expected_accept,
  6875. WebSocketUpgradeResponse &upgrade) {
  6876. // Read status line
  6877. const auto bufsiz = 2048;
  6878. char buf[bufsiz];
  6879. stream_line_reader line_reader(strm, buf, bufsiz);
  6880. if (!line_reader.getline()) {
  6881. upgrade.error = Error::Read;
  6882. return false;
  6883. }
  6884. std::string version;
  6885. std::string reason;
  6886. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6887. upgrade.error = Error::WebSocketHandshake;
  6888. return false;
  6889. }
  6890. // Read the headers even for a rejection so the caller can see why the
  6891. // server refused the upgrade. A non-101 response may carry a body; it is
  6892. // deliberately left unread since the caller closes the socket right away.
  6893. if (!read_headers(strm, upgrade.headers)) {
  6894. upgrade.error = Error::Read;
  6895. return false;
  6896. }
  6897. const auto &headers = upgrade.headers;
  6898. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6899. upgrade.error = Error::WebSocketHandshake;
  6900. return false;
  6901. }
  6902. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6903. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6904. upgrade.error = Error::WebSocketHandshake;
  6905. return false;
  6906. }
  6907. // Verify Connection: Upgrade
  6908. if (!has_header_token(headers, "Connection", "upgrade")) {
  6909. upgrade.error = Error::WebSocketHandshake;
  6910. return false;
  6911. }
  6912. // Verify Sec-WebSocket-Accept header value
  6913. auto it = headers.find("Sec-WebSocket-Accept");
  6914. if (it == headers.end() || it->second != expected_accept) {
  6915. upgrade.error = Error::WebSocketHandshake;
  6916. return false;
  6917. }
  6918. // Extract negotiated subprotocol
  6919. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6920. if (proto_it != headers.end()) {
  6921. upgrade.selected_subprotocol = proto_it->second;
  6922. }
  6923. return true;
  6924. }
  6925. enum class ReadContentResult {
  6926. Success, // Successfully read the content
  6927. PayloadTooLarge, // The content exceeds the specified payload limit
  6928. Error // An error occurred while reading the content
  6929. };
  6930. inline ReadContentResult read_content_with_length(
  6931. Stream &strm, size_t len, DownloadProgress progress,
  6932. ContentReceiverWithProgress out,
  6933. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6934. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6935. detail::BodyReader br;
  6936. br.stream = &strm;
  6937. br.has_content_length = true;
  6938. br.content_length = len;
  6939. br.payload_max_length = payload_max_length;
  6940. br.chunked = false;
  6941. br.bytes_read = 0;
  6942. br.last_error = Error::Success;
  6943. size_t r = 0;
  6944. while (r < len) {
  6945. auto read_len = static_cast<size_t>(len - r);
  6946. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6947. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6948. if (n <= 0) {
  6949. // Check if it was a payload size error
  6950. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6951. return ReadContentResult::PayloadTooLarge;
  6952. }
  6953. return ReadContentResult::Error;
  6954. }
  6955. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6956. return ReadContentResult::Error;
  6957. }
  6958. r += static_cast<size_t>(n);
  6959. if (progress) {
  6960. if (!progress(r, len)) { return ReadContentResult::Error; }
  6961. }
  6962. }
  6963. return ReadContentResult::Success;
  6964. }
  6965. inline ReadContentResult
  6966. read_content_without_length(Stream &strm, size_t payload_max_length,
  6967. ContentReceiverWithProgress out) {
  6968. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6969. size_t r = 0;
  6970. for (;;) {
  6971. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6972. if (n == 0) { return ReadContentResult::Success; }
  6973. if (n < 0) { return ReadContentResult::Error; }
  6974. // Check if adding this data would exceed the payload limit
  6975. if (r > payload_max_length ||
  6976. payload_max_length - r < static_cast<size_t>(n)) {
  6977. return ReadContentResult::PayloadTooLarge;
  6978. }
  6979. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6980. return ReadContentResult::Error;
  6981. }
  6982. r += static_cast<size_t>(n);
  6983. }
  6984. return ReadContentResult::Success;
  6985. }
  6986. template <typename T>
  6987. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6988. size_t payload_max_length,
  6989. ContentReceiverWithProgress out) {
  6990. detail::ChunkedDecoder dec(strm);
  6991. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6992. size_t total_len = 0;
  6993. for (;;) {
  6994. size_t chunk_offset = 0;
  6995. size_t chunk_total = 0;
  6996. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6997. if (n < 0) { return ReadContentResult::Error; }
  6998. if (n == 0) {
  6999. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7000. return ReadContentResult::Error;
  7001. }
  7002. return ReadContentResult::Success;
  7003. }
  7004. if (total_len > payload_max_length ||
  7005. payload_max_length - total_len < static_cast<size_t>(n)) {
  7006. return ReadContentResult::PayloadTooLarge;
  7007. }
  7008. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7009. return ReadContentResult::Error;
  7010. }
  7011. total_len += static_cast<size_t>(n);
  7012. }
  7013. }
  7014. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7015. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7016. // is the final transfer coding. A single field value may list several
  7017. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7018. // several Transfer-Encoding lines, which combine into one comma-separated
  7019. // list in the order the lines were received. Headers preserves that order,
  7020. // so the final coding is the last token of the last line. Match it
  7021. // case-insensitively rather than comparing the whole value against
  7022. // "chunked".
  7023. //
  7024. // Security: reading a chunked message as unframed leaves its body in the
  7025. // socket, where a keep-alive connection parses it as a smuggled request.
  7026. // Server::process_request() answers 400 and closes when the final coding is
  7027. // not chunked, so a request whose framing cannot be determined never
  7028. // reaches the "no body" path.
  7029. auto rng = headers.equal_range("Transfer-Encoding");
  7030. if (rng.first == rng.second) { return false; }
  7031. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7032. // combined list ending in nothing rather than inheriting the line before it.
  7033. std::string last_coding;
  7034. for (auto it = rng.first; it != rng.second; ++it) {
  7035. const auto &value = it->second;
  7036. last_coding.clear();
  7037. split(value.data(), value.data() + value.size(), ',',
  7038. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7039. }
  7040. return case_ignore::equal(last_coding, "chunked");
  7041. }
  7042. inline bool has_conflicting_content_length(const Headers &headers) {
  7043. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7044. // Content-Length is framed ambiguously. The body readers here delimit it by
  7045. // the transfer coding and drop Content-Length, while an intermediary may do
  7046. // the reverse, so the two disagree on where the body ends and a reused
  7047. // connection is desynchronised (request/response smuggling). Content-Length:
  7048. // 0 is tolerated for compatibility with existing peers.
  7049. return has_header(headers, "Transfer-Encoding") &&
  7050. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7051. }
  7052. template <typename T, typename U>
  7053. bool prepare_content_receiver(T &x, int &status,
  7054. ContentReceiverWithProgress receiver,
  7055. bool decompress, size_t payload_max_length,
  7056. bool &exceed_payload_max_length, U callback) {
  7057. if (decompress) {
  7058. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7059. std::unique_ptr<decompressor> decompressor;
  7060. if (!encoding.empty()) {
  7061. // A coding we know about but were not built with is an error. An
  7062. // unrecognized coding (including "identity") is left alone and the
  7063. // payload is passed through as-is, since some servers misuse the header,
  7064. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7065. decompressor = detail::create_decompressor(encoding);
  7066. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7067. status = StatusCode::UnsupportedMediaType_415;
  7068. return false;
  7069. }
  7070. }
  7071. if (decompressor) {
  7072. if (decompressor->is_valid()) {
  7073. size_t decompressed_size = 0;
  7074. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7075. size_t off, size_t len) {
  7076. return decompressor->decompress(
  7077. buf, n, [&](const char *buf2, size_t n2) {
  7078. // Guard against zip-bomb: check
  7079. // decompressed size against limit.
  7080. if (payload_max_length > 0 &&
  7081. (decompressed_size >= payload_max_length ||
  7082. n2 > payload_max_length - decompressed_size)) {
  7083. exceed_payload_max_length = true;
  7084. return false;
  7085. }
  7086. decompressed_size += n2;
  7087. return receiver(buf2, n2, off, len);
  7088. });
  7089. };
  7090. return callback(std::move(out));
  7091. } else {
  7092. status = StatusCode::InternalServerError_500;
  7093. return false;
  7094. }
  7095. }
  7096. }
  7097. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7098. size_t len) {
  7099. return receiver(buf, n, off, len);
  7100. };
  7101. return callback(std::move(out));
  7102. }
  7103. template <typename T>
  7104. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7105. DownloadProgress progress,
  7106. ContentReceiverWithProgress receiver, bool decompress) {
  7107. bool exceed_payload_max_length = false;
  7108. return prepare_content_receiver(
  7109. x, status, std::move(receiver), decompress, payload_max_length,
  7110. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7111. auto ret = true;
  7112. // Note: exceed_payload_max_length may also be set by the decompressor
  7113. // wrapper in prepare_content_receiver when the decompressed payload
  7114. // size exceeds the limit.
  7115. if (is_chunked_transfer_encoding(x.headers)) {
  7116. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7117. if (result == ReadContentResult::Success) {
  7118. ret = true;
  7119. } else if (result == ReadContentResult::PayloadTooLarge) {
  7120. exceed_payload_max_length = true;
  7121. ret = false;
  7122. } else {
  7123. ret = false;
  7124. }
  7125. } else if (!has_header(x.headers, "Content-Length")) {
  7126. auto result =
  7127. read_content_without_length(strm, payload_max_length, out);
  7128. if (result == ReadContentResult::Success) {
  7129. ret = true;
  7130. } else if (result == ReadContentResult::PayloadTooLarge) {
  7131. exceed_payload_max_length = true;
  7132. ret = false;
  7133. } else {
  7134. ret = false;
  7135. }
  7136. } else {
  7137. auto is_invalid_value = false;
  7138. auto len = get_header_value_u64(x.headers, "Content-Length",
  7139. (std::numeric_limits<size_t>::max)(),
  7140. 0, is_invalid_value);
  7141. if (is_invalid_value) {
  7142. ret = false;
  7143. } else if (len > 0) {
  7144. auto result = read_content_with_length(
  7145. strm, len, std::move(progress), out, payload_max_length);
  7146. ret = (result == ReadContentResult::Success);
  7147. if (result == ReadContentResult::PayloadTooLarge) {
  7148. exceed_payload_max_length = true;
  7149. }
  7150. }
  7151. }
  7152. if (!ret) {
  7153. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7154. : StatusCode::BadRequest_400;
  7155. }
  7156. return ret;
  7157. });
  7158. }
  7159. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7160. const std::string &path) {
  7161. // Neither the method nor the request target may carry CR/LF, SP or other
  7162. // control octets; otherwise a value smuggled into either splits the request
  7163. // line and injects headers or a whole request.
  7164. if (!fields::is_token(method)) { return -1; }
  7165. if (!fields::is_request_target(path)) { return -1; }
  7166. std::string s = method;
  7167. s += ' ';
  7168. s += path;
  7169. s += " HTTP/1.1\r\n";
  7170. return strm.write(s.data(), s.size());
  7171. }
  7172. inline ssize_t write_response_line(Stream &strm, int status) {
  7173. std::string s = "HTTP/1.1 ";
  7174. s += std::to_string(status);
  7175. s += ' ';
  7176. s += httplib::status_message(status);
  7177. s += "\r\n";
  7178. return strm.write(s.data(), s.size());
  7179. }
  7180. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7181. ssize_t write_len = 0;
  7182. for (const auto &x : headers) {
  7183. // Skip fields with invalid names or values to prevent response splitting
  7184. // via CR/LF injection, matching set_header(). The client validates request
  7185. // headers up front in check_and_write_headers, but the server passes
  7186. // res.headers straight to this writer, and res.headers is a public field
  7187. // an application can populate directly with request-derived values.
  7188. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7189. std::string s;
  7190. s = x.first;
  7191. s += ": ";
  7192. s += x.second;
  7193. s += "\r\n";
  7194. auto len = strm.write(s.data(), s.size());
  7195. if (len < 0) { return len; }
  7196. write_len += len;
  7197. }
  7198. auto len = strm.write("\r\n");
  7199. if (len < 0) { return len; }
  7200. write_len += len;
  7201. return write_len;
  7202. }
  7203. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7204. size_t offset = 0;
  7205. while (offset < l) {
  7206. auto length = strm.write(d + offset, l - offset);
  7207. if (length < 0) { return false; }
  7208. offset += static_cast<size_t>(length);
  7209. }
  7210. return true;
  7211. }
  7212. template <typename T>
  7213. inline bool write_content_with_progress(Stream &strm,
  7214. const ContentProvider &content_provider,
  7215. size_t offset, size_t length,
  7216. T is_shutting_down,
  7217. const UploadProgress &upload_progress,
  7218. Error &error) {
  7219. size_t end_offset = offset + length;
  7220. size_t start_offset = offset;
  7221. auto ok = true;
  7222. auto finished = false;
  7223. DataSink data_sink;
  7224. data_sink.write = [&](const char *d, size_t l) -> bool {
  7225. if (ok) {
  7226. if (write_data(strm, d, l)) {
  7227. offset += l;
  7228. if (upload_progress && length > 0) {
  7229. size_t current_written = offset - start_offset;
  7230. if (!upload_progress(current_written, length)) {
  7231. ok = false;
  7232. return false;
  7233. }
  7234. }
  7235. } else {
  7236. ok = false;
  7237. }
  7238. }
  7239. return ok;
  7240. };
  7241. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7242. // The body is framed by `length`, so a provider that reports itself done
  7243. // early has truncated it. Record that and let the short-body check below
  7244. // fail the write, rather than calling the provider again forever.
  7245. data_sink.done = [&]() { finished = true; };
  7246. while (offset < end_offset && !finished && !is_shutting_down()) {
  7247. auto last_offset = offset;
  7248. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7249. error = Error::Write;
  7250. return false;
  7251. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7252. error = Error::Canceled;
  7253. return false;
  7254. } else if (!ok) {
  7255. error = Error::Write;
  7256. return false;
  7257. }
  7258. // A provider that reports success without writing anything and without
  7259. // reporting itself done gets handed the same offset and length again on
  7260. // the next pass, so it would spin here for as long as the peer stays
  7261. // connected. Treat making no progress as a short body, like done() early.
  7262. if (!finished && offset == last_offset) {
  7263. error = Error::Write;
  7264. return false;
  7265. }
  7266. }
  7267. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7268. error = Error::Write;
  7269. return false;
  7270. }
  7271. error = Error::Success;
  7272. return true;
  7273. }
  7274. template <typename T>
  7275. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7276. size_t offset, size_t length, T is_shutting_down,
  7277. Error &error) {
  7278. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7279. is_shutting_down, nullptr, error);
  7280. }
  7281. template <typename T>
  7282. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7283. size_t offset, size_t length,
  7284. const T &is_shutting_down) {
  7285. auto error = Error::Success;
  7286. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7287. error);
  7288. }
  7289. template <typename T>
  7290. inline bool
  7291. write_content_without_length(Stream &strm,
  7292. const ContentProvider &content_provider,
  7293. const T &is_shutting_down) {
  7294. size_t offset = 0;
  7295. auto data_available = true;
  7296. auto ok = true;
  7297. DataSink data_sink;
  7298. data_sink.write = [&](const char *d, size_t l) -> bool {
  7299. if (ok) {
  7300. offset += l;
  7301. if (!write_data(strm, d, l)) { ok = false; }
  7302. }
  7303. return ok;
  7304. };
  7305. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7306. data_sink.done = [&](void) { data_available = false; };
  7307. while (data_available && !is_shutting_down()) {
  7308. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7309. return false;
  7310. } else if (!content_provider(offset, 0, data_sink)) {
  7311. return false;
  7312. } else if (!ok) {
  7313. return false;
  7314. }
  7315. }
  7316. return !data_available; // true only if done() was called, false if shutting
  7317. // down
  7318. }
  7319. // Runs a known-length content provider to completion and compresses what it
  7320. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7321. // by an mmap hands the compressor a pointer straight into the mapping.
  7322. inline bool compress_content_provider(const ContentProvider &content_provider,
  7323. size_t length, compressor &cmp,
  7324. std::string &out) {
  7325. size_t offset = 0;
  7326. auto ok = true;
  7327. auto finished = false;
  7328. DataSink data_sink;
  7329. auto append = [&](const char *data, size_t data_len) {
  7330. out.append(data, data_len);
  7331. return true;
  7332. };
  7333. data_sink.write = [&](const char *d, size_t l) -> bool {
  7334. if (!ok) { return false; }
  7335. offset += l;
  7336. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7337. return ok;
  7338. };
  7339. // The body is framed by `length`, so a provider that reports itself done
  7340. // early has truncated it; the short-body check below turns that into a
  7341. // failure rather than calling the provider again forever.
  7342. data_sink.done = [&]() { finished = true; };
  7343. while (offset < length && !finished) {
  7344. auto prev_offset = offset;
  7345. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7346. return false;
  7347. }
  7348. // No Stream to block on here, so a provider that keeps returning true
  7349. // without writing would spin. Treat a pass that made no progress as a
  7350. // failure.
  7351. if (offset == prev_offset) { return false; }
  7352. }
  7353. if (offset != length) { return false; }
  7354. return cmp.compress(nullptr, 0, true, append);
  7355. }
  7356. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7357. // and the file flag, so recording them has to come after; keeping all of it
  7358. // here means a third file-serving path cannot get that order wrong.
  7359. inline void set_file_content_provider(Response &res,
  7360. const std::shared_ptr<mmap> &m,
  7361. const std::string &content_type,
  7362. EncodingType encoding) {
  7363. res.set_content_provider(
  7364. m->size(), content_type,
  7365. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7366. sink.write(m->data() + offset, length);
  7367. return true;
  7368. });
  7369. res.is_file_content_provider_ = true;
  7370. res.content_coding_ = encoding;
  7371. }
  7372. template <typename T, typename U>
  7373. inline bool
  7374. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7375. const T &is_shutting_down, U &compressor, Error &error) {
  7376. size_t offset = 0;
  7377. auto data_available = true;
  7378. auto ok = true;
  7379. DataSink data_sink;
  7380. data_sink.write = [&](const char *d, size_t l) -> bool {
  7381. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7382. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7383. // zero-length chunk is the terminator, so it must not be emitted here.
  7384. if (ok && l > 0) {
  7385. offset += l;
  7386. std::string payload;
  7387. if (compressor.compress(d, l, false,
  7388. [&](const char *data, size_t data_len) {
  7389. payload.append(data, data_len);
  7390. return true;
  7391. })) {
  7392. if (!payload.empty()) {
  7393. // Emit chunked response header and footer for each chunk
  7394. auto chunk =
  7395. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7396. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7397. }
  7398. } else {
  7399. ok = false;
  7400. }
  7401. }
  7402. return ok;
  7403. };
  7404. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7405. auto done_with_trailer = [&](const Headers *trailer) {
  7406. if (!ok) { return; }
  7407. data_available = false;
  7408. std::string payload;
  7409. if (!compressor.compress(nullptr, 0, true,
  7410. [&](const char *data, size_t data_len) {
  7411. payload.append(data, data_len);
  7412. return true;
  7413. })) {
  7414. ok = false;
  7415. return;
  7416. }
  7417. if (!payload.empty()) {
  7418. // Emit chunked response header and footer for each chunk
  7419. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7420. if (!write_data(strm, chunk.data(), chunk.size())) {
  7421. ok = false;
  7422. return;
  7423. }
  7424. }
  7425. constexpr const char done_marker[] = "0\r\n";
  7426. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7427. // Trailer
  7428. if (trailer) {
  7429. for (const auto &kv : *trailer) {
  7430. // Skip fields with invalid names or values to prevent response
  7431. // splitting via CR/LF injection, matching set_header().
  7432. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7433. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7434. if (!write_data(strm, field_line.data(), field_line.size())) {
  7435. ok = false;
  7436. }
  7437. }
  7438. }
  7439. constexpr const char crlf[] = "\r\n";
  7440. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7441. };
  7442. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7443. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7444. done_with_trailer(&trailer);
  7445. };
  7446. while (data_available && !is_shutting_down()) {
  7447. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7448. error = Error::Write;
  7449. return false;
  7450. } else if (!content_provider(offset, 0, data_sink)) {
  7451. error = Error::Canceled;
  7452. return false;
  7453. } else if (!ok) {
  7454. error = Error::Write;
  7455. return false;
  7456. }
  7457. }
  7458. if (data_available) { // exited due to is_shutting_down(), not done()
  7459. error = Error::Write;
  7460. return false;
  7461. }
  7462. error = Error::Success;
  7463. return true;
  7464. }
  7465. template <typename T, typename U>
  7466. inline bool write_content_chunked(Stream &strm,
  7467. const ContentProvider &content_provider,
  7468. const T &is_shutting_down, U &compressor) {
  7469. auto error = Error::Success;
  7470. return write_content_chunked(strm, content_provider, is_shutting_down,
  7471. compressor, error);
  7472. }
  7473. template <typename T>
  7474. inline bool redirect(T &cli, Request &req, Response &res,
  7475. const std::string &path, const std::string &location,
  7476. Error &error) {
  7477. Request new_req = req;
  7478. new_req.path = path;
  7479. new_req.redirect_count_ -= 1;
  7480. if (res.status == StatusCode::SeeOther_303 &&
  7481. (req.method != "GET" && req.method != "HEAD")) {
  7482. new_req.method = "GET";
  7483. new_req.body.clear();
  7484. new_req.headers.clear();
  7485. }
  7486. Response new_res;
  7487. auto ret = cli.send(new_req, new_res, error);
  7488. if (ret) {
  7489. req = std::move(new_req);
  7490. res = std::move(new_res);
  7491. if (res.location.empty()) { res.location = location; }
  7492. }
  7493. return ret;
  7494. }
  7495. inline std::string params_to_query_str(const Params &params) {
  7496. std::string query;
  7497. for (auto it = params.begin(); it != params.end(); ++it) {
  7498. if (it != params.begin()) { query += '&'; }
  7499. query += encode_query_component(it->first);
  7500. query += '=';
  7501. query += encode_query_component(it->second);
  7502. }
  7503. return query;
  7504. }
  7505. // Splits one "key=value" span of a query string at its first '='. A span with
  7506. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7507. // "?flag" keeps its name.
  7508. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7509. std::string &val) {
  7510. divide(b, static_cast<std::size_t>(e - b), '=',
  7511. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7512. std::size_t rhs_size) {
  7513. key.assign(lhs_data, lhs_size);
  7514. val.assign(rhs_data, rhs_size);
  7515. });
  7516. }
  7517. inline void parse_query_text(const char *data, std::size_t size,
  7518. Params &params) {
  7519. std::set<std::string> cache;
  7520. split(data, data + size, '&', [&](const char *b, const char *e) {
  7521. std::string kv(b, e);
  7522. if (cache.find(kv) != cache.end()) { return; }
  7523. cache.insert(std::move(kv));
  7524. std::string key;
  7525. std::string val;
  7526. divide_query_pair(b, e, key, val);
  7527. if (!key.empty()) {
  7528. params.emplace(decode_query_component(key), decode_query_component(val));
  7529. }
  7530. });
  7531. }
  7532. inline void parse_query_text(const std::string &s, Params &params) {
  7533. parse_query_text(s.data(), s.size(), params);
  7534. }
  7535. // Normalize a query string by decoding and re-encoding each key/value pair
  7536. // while preserving the original parameter order. This avoids double-encoding
  7537. // and ensures consistent encoding. It works on the raw string rather than
  7538. // parsing into Params and re-serializing, because that round trip cannot
  7539. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7540. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7541. // duplicated pairs.
  7542. inline std::string normalize_query_string(const std::string &query) {
  7543. std::string result;
  7544. split(query.data(), query.data() + query.size(), '&',
  7545. [&](const char *b, const char *e) {
  7546. std::string key;
  7547. std::string val;
  7548. divide_query_pair(b, e, key, val);
  7549. if (!key.empty()) {
  7550. auto dec_key = decode_query_component(key);
  7551. auto dec_val = decode_query_component(val);
  7552. if (!result.empty()) { result += '&'; }
  7553. result += encode_query_component(dec_key);
  7554. if (!val.empty() || std::find(b, e, '=') != e) {
  7555. result += '=';
  7556. result += encode_query_component(dec_val);
  7557. }
  7558. }
  7559. });
  7560. return result;
  7561. }
  7562. // Build the request target that goes on the wire from a caller-supplied path.
  7563. // Shared by the buffered send path and the streaming API so that both put the
  7564. // same bytes in the request line for the same input.
  7565. inline std::string encode_request_target(const std::string &target,
  7566. bool path_encode) {
  7567. // `substr(0, npos)` yields the whole string, which is what the no-query
  7568. // case needs.
  7569. auto query_pos = target.find('?');
  7570. auto path_part = target.substr(0, query_pos);
  7571. std::string query_part;
  7572. if (query_pos != std::string::npos) {
  7573. query_part = target.substr(query_pos + 1);
  7574. }
  7575. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7576. if (!query_part.empty()) {
  7577. // When path encoding is disabled the caller has supplied an already-encoded
  7578. // target and expects the exact bytes to be sent on the wire, so skip
  7579. // normalization for the query too. Normalizing would decode-then-re-encode
  7580. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7581. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7582. if (path_encode) {
  7583. auto normalized = normalize_query_string(query_part);
  7584. if (!normalized.empty()) {
  7585. result += '?';
  7586. result += normalized;
  7587. }
  7588. } else {
  7589. result += '?';
  7590. result += query_part;
  7591. }
  7592. }
  7593. return result;
  7594. }
  7595. inline bool parse_multipart_boundary(const std::string &content_type,
  7596. std::string &boundary) {
  7597. std::map<std::string, std::string> params;
  7598. extract_media_type(content_type, &params);
  7599. auto it = params.find("boundary");
  7600. if (it == params.end()) { return false; }
  7601. boundary = it->second;
  7602. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7603. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7604. // bytes costs a nearly full comparison at nearly every position: the
  7605. // boundary's length multiplies the worst-case cost of scanning a body.
  7606. return !boundary.empty() && boundary.size() <= 70;
  7607. }
  7608. inline void parse_disposition_params(const std::string &s, Params &params) {
  7609. std::set<std::string> cache;
  7610. split_unquoted(s.data(), s.data() + s.size(), ';',
  7611. [&](const char *b, const char *e) {
  7612. std::string kv(b, e);
  7613. if (cache.find(kv) != cache.end()) { return; }
  7614. cache.insert(kv);
  7615. std::string key;
  7616. std::string val;
  7617. divide_param_pair(b, e, key, val);
  7618. if (!key.empty()) {
  7619. params.emplace(trim_double_quotes_copy(key),
  7620. trim_double_quotes_copy(val));
  7621. }
  7622. });
  7623. }
  7624. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7625. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7626. #else
  7627. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7628. #endif
  7629. auto is_valid = [](const std::string &str) {
  7630. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7631. };
  7632. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7633. const auto pos = static_cast<size_t>(6);
  7634. const auto len = static_cast<size_t>(s.size() - 6);
  7635. auto all_valid_ranges = true;
  7636. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7637. if (!all_valid_ranges) { return; }
  7638. const auto it = std::find(b, e, '-');
  7639. if (it == e) {
  7640. all_valid_ranges = false;
  7641. return;
  7642. }
  7643. const auto lhs = std::string(b, it);
  7644. const auto rhs = std::string(it + 1, e);
  7645. if (!is_valid(lhs) || !is_valid(rhs)) {
  7646. all_valid_ranges = false;
  7647. return;
  7648. }
  7649. ssize_t first = -1;
  7650. if (!lhs.empty()) {
  7651. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7652. // would turn the range into a suffix range.
  7653. auto res =
  7654. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7655. if (res.ec != std::errc{}) {
  7656. all_valid_ranges = false;
  7657. return;
  7658. }
  7659. }
  7660. ssize_t last = -1;
  7661. if (!rhs.empty()) {
  7662. // An overflowing last-byte-pos is past any content length, so keeping
  7663. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7664. ssize_t v;
  7665. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7666. if (res.ec == std::errc{}) { last = v; }
  7667. }
  7668. if ((first == -1 && last == -1) ||
  7669. (first != -1 && last != -1 && first > last)) {
  7670. all_valid_ranges = false;
  7671. return;
  7672. }
  7673. ranges.emplace_back(first, last);
  7674. });
  7675. return all_valid_ranges && !ranges.empty();
  7676. }
  7677. return false;
  7678. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7679. }
  7680. #else
  7681. } catch (...) { return false; }
  7682. #endif
  7683. inline bool parse_accept_header(const std::string &s,
  7684. std::vector<std::string> &content_types) {
  7685. content_types.clear();
  7686. // Empty string is considered valid (no preference)
  7687. if (s.empty()) { return true; }
  7688. struct AcceptEntry {
  7689. std::string media_type;
  7690. double quality;
  7691. int order;
  7692. };
  7693. std::vector<AcceptEntry> entries;
  7694. int order = 0;
  7695. bool has_invalid_entry = false;
  7696. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7697. // has to parse and ignore empty list elements, so a leading, trailing or
  7698. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7699. // split() skips them, and the header length limit bounds how many a sender
  7700. // can send, so ignoring all of them cannot be used as a denial-of-service
  7701. // vector.
  7702. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7703. std::string entry(b, e);
  7704. entry = trim_copy(entry);
  7705. AcceptEntry accept_entry;
  7706. accept_entry.order = order++;
  7707. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7708. accept_entry.media_type, accept_entry.quality)) {
  7709. has_invalid_entry = true;
  7710. return;
  7711. }
  7712. // Remove additional parameters from media type
  7713. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7714. // Basic validation of media type format
  7715. if (accept_entry.media_type.empty()) {
  7716. has_invalid_entry = true;
  7717. return;
  7718. }
  7719. // Check for basic media type format (should contain '/' or be '*')
  7720. if (accept_entry.media_type != "*" &&
  7721. accept_entry.media_type.find('/') == std::string::npos) {
  7722. has_invalid_entry = true;
  7723. return;
  7724. }
  7725. entries.push_back(std::move(accept_entry));
  7726. });
  7727. // Return false if any invalid entry was found
  7728. if (has_invalid_entry) { return false; }
  7729. // Sort by quality (descending), then by original order (ascending)
  7730. std::sort(entries.begin(), entries.end(),
  7731. [](const AcceptEntry &a, const AcceptEntry &b) {
  7732. if (a.quality != b.quality) {
  7733. return a.quality > b.quality; // Higher quality first
  7734. }
  7735. return a.order < b.order; // Earlier order first for same quality
  7736. });
  7737. // Extract sorted media types
  7738. content_types.reserve(entries.size());
  7739. for (auto &entry : entries) {
  7740. content_types.push_back(std::move(entry.media_type));
  7741. }
  7742. return true;
  7743. }
  7744. class FormDataParser {
  7745. public:
  7746. FormDataParser() = default;
  7747. void set_boundary(std::string &&boundary) {
  7748. boundary_ = std::move(boundary);
  7749. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7750. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7751. }
  7752. bool is_valid() const { return is_valid_; }
  7753. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7754. const ContentReceiver &content_callback) {
  7755. // Once the close delimiter has been seen the rest of the body is epilogue
  7756. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7757. // spread across reads is not copied in only to be erased right away.
  7758. if (state_ == 5) { return true; }
  7759. buf_append(buf, n);
  7760. while (buf_size() > 0) {
  7761. switch (state_) {
  7762. case 0: { // Initial boundary
  7763. auto pos = buf_find(dash_boundary_crlf_);
  7764. if (pos == buf_size()) {
  7765. // Not found yet: keep only a possible partial boundary at the tail so
  7766. // that a body which never contains the boundary cannot grow the
  7767. // buffer (and get rescanned from the start) without bound.
  7768. auto keep = dash_boundary_crlf_.size() - 1;
  7769. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7770. return true;
  7771. }
  7772. buf_erase(pos + dash_boundary_crlf_.size());
  7773. state_ = 1;
  7774. break;
  7775. }
  7776. case 1: { // New entry
  7777. clear_file_info();
  7778. state_ = 2;
  7779. break;
  7780. }
  7781. case 2: { // Headers
  7782. auto pos = buf_find(crlf_);
  7783. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7784. while (pos < buf_size()) {
  7785. // Empty line
  7786. if (pos == 0) {
  7787. if (!header_callback(file_)) {
  7788. is_valid_ = false;
  7789. return false;
  7790. }
  7791. buf_erase(crlf_.size());
  7792. state_ = 3;
  7793. break;
  7794. }
  7795. // Check header count limit
  7796. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7797. is_valid_ = false;
  7798. return false;
  7799. }
  7800. header_count_++;
  7801. const auto header = buf_head(pos);
  7802. if (!parse_header(header.data(), header.data() + header.size(),
  7803. [&](const std::string &, const std::string &) {})) {
  7804. is_valid_ = false;
  7805. return false;
  7806. }
  7807. // Parse and emplace space trimmed headers into a map
  7808. if (!parse_header(
  7809. header.data(), header.data() + header.size(),
  7810. [&](const std::string &key, const std::string &val) {
  7811. file_.headers.emplace(key, val);
  7812. })) {
  7813. is_valid_ = false;
  7814. return false;
  7815. }
  7816. constexpr const char header_content_type[] = "Content-Type:";
  7817. if (start_with_case_ignore(header, header_content_type)) {
  7818. file_.content_type =
  7819. trim_copy(header.substr(str_len(header_content_type)));
  7820. } else {
  7821. std::string disposition_params;
  7822. if (parse_content_disposition(header, disposition_params)) {
  7823. Params params;
  7824. parse_disposition_params(disposition_params, params);
  7825. auto it = params.find("name");
  7826. if (it != params.end()) {
  7827. file_.name = it->second;
  7828. } else {
  7829. is_valid_ = false;
  7830. return false;
  7831. }
  7832. it = params.find("filename");
  7833. if (it != params.end()) { file_.filename = it->second; }
  7834. it = params.find("filename*");
  7835. if (it != params.end()) {
  7836. // RFC 5987: only UTF-8 encoding is allowed
  7837. const auto &val = it->second;
  7838. constexpr const char utf8_prefix[] = "UTF-8''";
  7839. constexpr size_t prefix_len = str_len(utf8_prefix);
  7840. if (val.size() > prefix_len &&
  7841. start_with_case_ignore(val, utf8_prefix)) {
  7842. file_.filename = decode_path_component(
  7843. val.substr(prefix_len)); // override...
  7844. } else {
  7845. is_valid_ = false;
  7846. return false;
  7847. }
  7848. }
  7849. }
  7850. }
  7851. buf_erase(pos + crlf_.size());
  7852. pos = buf_find(crlf_);
  7853. }
  7854. if (state_ != 3) { return true; }
  7855. break;
  7856. }
  7857. case 3: { // Body
  7858. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7859. auto pos = buf_find(crlf_dash_boundary_);
  7860. if (pos < buf_size()) {
  7861. if (!content_callback(buf_data(), pos)) {
  7862. is_valid_ = false;
  7863. return false;
  7864. }
  7865. buf_erase(pos + crlf_dash_boundary_.size());
  7866. state_ = 4;
  7867. } else {
  7868. auto len = buf_size() - crlf_dash_boundary_.size();
  7869. if (len > 0) {
  7870. if (!content_callback(buf_data(), len)) {
  7871. is_valid_ = false;
  7872. return false;
  7873. }
  7874. buf_erase(len);
  7875. }
  7876. return true;
  7877. }
  7878. break;
  7879. }
  7880. case 4: { // Boundary
  7881. if (crlf_.size() > buf_size()) { return true; }
  7882. if (buf_start_with(crlf_)) {
  7883. buf_erase(crlf_.size());
  7884. state_ = 1;
  7885. } else if (buf_start_with(dash_)) {
  7886. buf_erase(dash_.size());
  7887. is_valid_ = true;
  7888. state_ = 5;
  7889. } else {
  7890. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7891. // accepted after a boundary; RFC 2046 allows transport-padding in
  7892. // between, but this parser has never supported it. Either way the
  7893. // body is already destined to be rejected, so fail now instead of
  7894. // buffering the rest of it. Both are two bytes, so the check above
  7895. // already guarantees enough buffered data to decide.
  7896. is_valid_ = false;
  7897. return false;
  7898. }
  7899. break;
  7900. }
  7901. case 5: { // Epilogue
  7902. buf_erase(buf_size());
  7903. break;
  7904. }
  7905. }
  7906. }
  7907. return true;
  7908. }
  7909. private:
  7910. void clear_file_info() {
  7911. file_.name.clear();
  7912. file_.filename.clear();
  7913. file_.content_type.clear();
  7914. file_.headers.clear();
  7915. header_count_ = 0;
  7916. }
  7917. bool start_with_case_ignore(const std::string &a, const char *b,
  7918. size_t offset = 0) const {
  7919. const auto b_len = strlen(b);
  7920. if (a.size() < offset + b_len) { return false; }
  7921. for (size_t i = 0; i < b_len; i++) {
  7922. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7923. return false;
  7924. }
  7925. }
  7926. return true;
  7927. }
  7928. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7929. // Returns true if header matches, with the params portion in `params_out`.
  7930. bool parse_content_disposition(const std::string &header,
  7931. std::string &params_out) const {
  7932. constexpr const char prefix[] = "Content-Disposition:";
  7933. constexpr size_t prefix_len = str_len(prefix);
  7934. if (!start_with_case_ignore(header, prefix)) { return false; }
  7935. // Skip whitespace after "Content-Disposition:"
  7936. auto pos = prefix_len;
  7937. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7938. pos++;
  7939. }
  7940. // Match "form-data;" (case-insensitive)
  7941. constexpr const char form_data[] = "form-data;";
  7942. constexpr size_t form_data_len = str_len(form_data);
  7943. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7944. pos += form_data_len;
  7945. // Skip whitespace after "form-data;"
  7946. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7947. pos++;
  7948. }
  7949. params_out = header.substr(pos);
  7950. return true;
  7951. }
  7952. const std::string dash_ = "--";
  7953. const std::string crlf_ = "\r\n";
  7954. std::string boundary_;
  7955. std::string dash_boundary_crlf_;
  7956. std::string crlf_dash_boundary_;
  7957. size_t state_ = 0;
  7958. bool is_valid_ = false;
  7959. FormData file_;
  7960. size_t header_count_ = 0;
  7961. // Buffer
  7962. bool start_with(const std::string &a, size_t spos, size_t epos,
  7963. const std::string &b) const {
  7964. if (epos - spos < b.size()) { return false; }
  7965. for (size_t i = 0; i < b.size(); i++) {
  7966. if (a[i + spos] != b[i]) { return false; }
  7967. }
  7968. return true;
  7969. }
  7970. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7971. const char *buf_data() const { return &buf_[buf_spos_]; }
  7972. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7973. bool buf_start_with(const std::string &s) const {
  7974. return start_with(buf_, buf_spos_, buf_epos_, s);
  7975. }
  7976. size_t buf_find(const std::string &s) const {
  7977. auto c = s.front();
  7978. size_t off = buf_spos_;
  7979. while (off < buf_epos_) {
  7980. auto pos = off;
  7981. while (true) {
  7982. if (pos == buf_epos_) { return buf_size(); }
  7983. if (buf_[pos] == c) { break; }
  7984. pos++;
  7985. }
  7986. auto remaining_size = buf_epos_ - pos;
  7987. if (s.size() > remaining_size) { return buf_size(); }
  7988. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7989. off = pos + 1;
  7990. }
  7991. return buf_size();
  7992. }
  7993. void buf_append(const char *data, size_t n) {
  7994. auto remaining_size = buf_size();
  7995. if (remaining_size > 0 && buf_spos_ > 0) {
  7996. for (size_t i = 0; i < remaining_size; i++) {
  7997. buf_[i] = buf_[buf_spos_ + i];
  7998. }
  7999. }
  8000. buf_spos_ = 0;
  8001. buf_epos_ = remaining_size;
  8002. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8003. for (size_t i = 0; i < n; i++) {
  8004. buf_[buf_epos_ + i] = data[i];
  8005. }
  8006. buf_epos_ += n;
  8007. }
  8008. void buf_erase(size_t size) { buf_spos_ += size; }
  8009. std::string buf_;
  8010. size_t buf_spos_ = 0;
  8011. size_t buf_epos_ = 0;
  8012. };
  8013. inline std::string random_string(size_t length) {
  8014. constexpr const char data[] =
  8015. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8016. thread_local auto engine([]() {
  8017. // std::random_device might actually be deterministic on some
  8018. // platforms, but due to lack of support in the c++ standard library,
  8019. // doing better requires either some ugly hacks or breaking portability.
  8020. std::random_device seed_gen;
  8021. // Request 128 bits of entropy for initialization
  8022. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  8023. return std::mt19937(seed_sequence);
  8024. }());
  8025. std::string result;
  8026. for (size_t i = 0; i < length; i++) {
  8027. result += data[engine() % (sizeof(data) - 1)];
  8028. }
  8029. return result;
  8030. }
  8031. inline std::string make_multipart_data_boundary() {
  8032. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8033. }
  8034. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8035. auto valid = true;
  8036. for (size_t i = 0; i < boundary.size(); i++) {
  8037. auto c = boundary[i];
  8038. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8039. valid = false;
  8040. break;
  8041. }
  8042. }
  8043. return valid;
  8044. }
  8045. // Escape a multipart field name/filename following the WHATWG HTML standard
  8046. // ("escape a multipart form-data name"), which is what browsers send:
  8047. // '"' -> %22, CR -> %0D, LF -> %0A
  8048. // With escape_quote = false, only CR and LF are escaped; this is for header
  8049. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8050. inline std::string escape_multipart_field(const std::string &s,
  8051. bool escape_quote = true) {
  8052. std::string result;
  8053. result.reserve(s.size());
  8054. for (auto c : s) {
  8055. switch (c) {
  8056. case '"':
  8057. if (escape_quote) {
  8058. result += "%22";
  8059. } else {
  8060. result += c;
  8061. }
  8062. break;
  8063. case '\r': result += "%0D"; break;
  8064. case '\n': result += "%0A"; break;
  8065. default: result += c; break;
  8066. }
  8067. }
  8068. return result;
  8069. }
  8070. template <typename T>
  8071. inline std::string
  8072. serialize_multipart_formdata_item_begin(const T &item,
  8073. const std::string &boundary) {
  8074. std::string body = "--" + boundary + "\r\n";
  8075. body += "Content-Disposition: form-data; name=\"" +
  8076. escape_multipart_field(item.name) + "\"";
  8077. if (!item.filename.empty()) {
  8078. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8079. }
  8080. body += "\r\n";
  8081. if (!item.content_type.empty()) {
  8082. body +=
  8083. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8084. "\r\n";
  8085. }
  8086. body += "\r\n";
  8087. return body;
  8088. }
  8089. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8090. inline std::string
  8091. serialize_multipart_formdata_finish(const std::string &boundary) {
  8092. return "--" + boundary + "--\r\n";
  8093. }
  8094. inline std::string
  8095. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8096. return "multipart/form-data; boundary=" + boundary;
  8097. }
  8098. inline std::string
  8099. serialize_multipart_formdata(const UploadFormDataItems &items,
  8100. const std::string &boundary, bool finish = true) {
  8101. std::string body;
  8102. for (const auto &item : items) {
  8103. body += serialize_multipart_formdata_item_begin(item, boundary);
  8104. body += item.content + serialize_multipart_formdata_item_end();
  8105. }
  8106. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8107. return body;
  8108. }
  8109. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8110. const std::string &boundary) {
  8111. size_t total = 0;
  8112. for (const auto &item : items) {
  8113. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8114. total += item.content.size();
  8115. total += serialize_multipart_formdata_item_end().size();
  8116. }
  8117. total += serialize_multipart_formdata_finish(boundary).size();
  8118. return total;
  8119. }
  8120. struct MultipartSegment {
  8121. const char *data;
  8122. size_t size;
  8123. };
  8124. // NOTE: items must outlive the returned ContentProvider
  8125. // (safe for synchronous use inside Post/Put/Patch)
  8126. inline ContentProvider
  8127. make_multipart_content_provider(const UploadFormDataItems &items,
  8128. const std::string &boundary) {
  8129. // Own the per-item header strings and the finish string
  8130. std::vector<std::string> owned;
  8131. owned.reserve(items.size() + 1);
  8132. for (const auto &item : items)
  8133. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8134. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8135. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8136. std::vector<MultipartSegment> segs;
  8137. segs.reserve(items.size() * 3 + 1);
  8138. static const char crlf[] = "\r\n";
  8139. for (size_t i = 0; i < items.size(); i++) {
  8140. segs.push_back({owned[i].data(), owned[i].size()});
  8141. segs.push_back({items[i].content.data(), items[i].content.size()});
  8142. segs.push_back({crlf, 2});
  8143. }
  8144. segs.push_back({owned.back().data(), owned.back().size()});
  8145. struct MultipartState {
  8146. std::vector<std::string> owned;
  8147. std::vector<MultipartSegment> segs;
  8148. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8149. };
  8150. auto state = std::make_shared<MultipartState>();
  8151. state->owned = std::move(owned);
  8152. // `segs` holds raw pointers into owned strings; std::string move preserves
  8153. // the data pointer, so these pointers remain valid after the move above.
  8154. state->segs = std::move(segs);
  8155. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8156. // Buffer multiple small segments into fewer, larger writes to avoid
  8157. // excessive TCP packets when there are many form data items (#2410)
  8158. auto &buf = state->buf;
  8159. auto buf_size = buf.size();
  8160. size_t buf_len = 0;
  8161. size_t remaining = length;
  8162. // Find the first segment containing 'offset'
  8163. size_t pos = 0;
  8164. size_t seg_idx = 0;
  8165. for (; seg_idx < state->segs.size(); seg_idx++) {
  8166. const auto &seg = state->segs[seg_idx];
  8167. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8168. pos += seg.size;
  8169. }
  8170. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8171. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8172. const auto &seg = state->segs[seg_idx];
  8173. size_t available = seg.size - seg_offset;
  8174. size_t to_copy = (std::min)(available, remaining);
  8175. const char *src = seg.data + seg_offset;
  8176. seg_offset = 0; // only the first segment has a non-zero offset
  8177. while (to_copy > 0) {
  8178. size_t space = buf_size - buf_len;
  8179. size_t chunk = (std::min)(to_copy, space);
  8180. std::memcpy(buf.data() + buf_len, src, chunk);
  8181. buf_len += chunk;
  8182. src += chunk;
  8183. to_copy -= chunk;
  8184. remaining -= chunk;
  8185. if (buf_len == buf_size) {
  8186. if (!sink.write(buf.data(), buf_len)) { return false; }
  8187. buf_len = 0;
  8188. }
  8189. }
  8190. }
  8191. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8192. return true;
  8193. };
  8194. }
  8195. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8196. if (ranges.size() <= 1) return;
  8197. // Sort ranges by start position
  8198. std::sort(ranges.begin(), ranges.end(),
  8199. [](const Range &a, const Range &b) { return a.first < b.first; });
  8200. Ranges coalesced;
  8201. coalesced.reserve(ranges.size());
  8202. for (auto &r : ranges) {
  8203. auto first_pos = r.first;
  8204. auto last_pos = r.second;
  8205. // Handle special cases like in range_error
  8206. if (first_pos == -1 && last_pos == -1) {
  8207. first_pos = 0;
  8208. last_pos = static_cast<ssize_t>(content_length);
  8209. }
  8210. if (first_pos == -1) {
  8211. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8212. last_pos = static_cast<ssize_t>(content_length) - 1;
  8213. }
  8214. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8215. last_pos = static_cast<ssize_t>(content_length) - 1;
  8216. }
  8217. // Skip invalid ranges
  8218. if (!(0 <= first_pos && first_pos <= last_pos &&
  8219. last_pos < static_cast<ssize_t>(content_length))) {
  8220. continue;
  8221. }
  8222. // Coalesce with previous range if overlapping or adjacent (but not
  8223. // identical)
  8224. if (!coalesced.empty()) {
  8225. auto &prev = coalesced.back();
  8226. // Check if current range overlaps or is adjacent to previous range
  8227. // but don't coalesce identical ranges (allow duplicates)
  8228. if (first_pos <= prev.second + 1 &&
  8229. !(first_pos == prev.first && last_pos == prev.second)) {
  8230. // Extend the previous range
  8231. prev.second = (std::max)(prev.second, last_pos);
  8232. continue;
  8233. }
  8234. }
  8235. // Add new range
  8236. coalesced.emplace_back(first_pos, last_pos);
  8237. }
  8238. ranges = std::move(coalesced);
  8239. }
  8240. inline bool range_error(Request &req, Response &res) {
  8241. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8242. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8243. req.ranges.clear();
  8244. if (res.status == StatusCode::PartialContent_206) {
  8245. res.status = StatusCode::OK_200;
  8246. }
  8247. return false;
  8248. }
  8249. ssize_t content_len = static_cast<ssize_t>(
  8250. res.content_length_ ? res.content_length_ : res.body.size());
  8251. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8252. size_t overwrapping_count = 0;
  8253. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8254. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8255. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8256. // Too many ranges
  8257. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8258. for (auto &r : req.ranges) {
  8259. auto &first_pos = r.first;
  8260. auto &last_pos = r.second;
  8261. if (first_pos == -1 && last_pos == -1) {
  8262. first_pos = 0;
  8263. last_pos = content_len;
  8264. }
  8265. if (first_pos == -1) {
  8266. first_pos = content_len - last_pos;
  8267. last_pos = content_len - 1;
  8268. }
  8269. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8270. // A client can limit the number of bytes requested without knowing the
  8271. // size of the selected representation. If the last-pos value is absent,
  8272. // or if the value is greater than or equal to the current length of the
  8273. // representation data, the byte range is interpreted as the remainder of
  8274. // the representation (i.e., the server replaces the value of last-pos
  8275. // with a value that is one less than the current length of the selected
  8276. // representation).
  8277. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8278. if (last_pos == -1 || last_pos >= content_len) {
  8279. last_pos = content_len - 1;
  8280. }
  8281. // Range must be within content length
  8282. if (!(0 <= first_pos && first_pos <= last_pos &&
  8283. last_pos <= content_len - 1)) {
  8284. return true;
  8285. }
  8286. // Request must not have more than two overlapping ranges
  8287. for (const auto &processed_range : processed_ranges) {
  8288. if (!(last_pos < processed_range.first ||
  8289. first_pos > processed_range.second)) {
  8290. overwrapping_count++;
  8291. if (overwrapping_count > 2) { return true; }
  8292. break; // Only count once per range
  8293. }
  8294. }
  8295. processed_ranges.emplace_back(first_pos, last_pos);
  8296. }
  8297. // After validation, coalesce overlapping ranges as per RFC 9110
  8298. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8299. }
  8300. return false;
  8301. }
  8302. inline std::pair<size_t, size_t>
  8303. get_range_offset_and_length(Range r, size_t content_length) {
  8304. assert(r.first != -1 && r.second != -1);
  8305. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8306. assert(r.first <= r.second &&
  8307. r.second < static_cast<ssize_t>(content_length));
  8308. (void)(content_length);
  8309. return std::make_pair(static_cast<size_t>(r.first),
  8310. static_cast<size_t>(r.second - r.first) + 1);
  8311. }
  8312. inline std::string make_content_range_header_field(
  8313. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8314. auto st = offset_and_length.first;
  8315. auto ed = st + offset_and_length.second - 1;
  8316. std::string field = "bytes ";
  8317. field += std::to_string(st);
  8318. field += '-';
  8319. field += std::to_string(ed);
  8320. field += '/';
  8321. field += std::to_string(content_length);
  8322. return field;
  8323. }
  8324. template <typename SToken, typename CToken, typename Content>
  8325. bool process_multipart_ranges_data(const Request &req,
  8326. const std::string &boundary,
  8327. const std::string &content_type,
  8328. size_t content_length, SToken stoken,
  8329. CToken ctoken, Content content) {
  8330. for (size_t i = 0; i < req.ranges.size(); i++) {
  8331. ctoken("--");
  8332. stoken(boundary);
  8333. ctoken("\r\n");
  8334. if (!content_type.empty()) {
  8335. ctoken("Content-Type: ");
  8336. stoken(content_type);
  8337. ctoken("\r\n");
  8338. }
  8339. auto offset_and_length =
  8340. get_range_offset_and_length(req.ranges[i], content_length);
  8341. ctoken("Content-Range: ");
  8342. stoken(make_content_range_header_field(offset_and_length, content_length));
  8343. ctoken("\r\n");
  8344. ctoken("\r\n");
  8345. if (!content(offset_and_length.first, offset_and_length.second)) {
  8346. return false;
  8347. }
  8348. ctoken("\r\n");
  8349. }
  8350. ctoken("--");
  8351. stoken(boundary);
  8352. ctoken("--");
  8353. return true;
  8354. }
  8355. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8356. const std::string &boundary,
  8357. const std::string &content_type,
  8358. size_t content_length,
  8359. std::string &data) {
  8360. process_multipart_ranges_data(
  8361. req, boundary, content_type, content_length,
  8362. [&](const std::string &token) { data += token; },
  8363. [&](const std::string &token) { data += token; },
  8364. [&](size_t offset, size_t length) {
  8365. assert(offset + length <= content_length);
  8366. data += res.body.substr(offset, length);
  8367. return true;
  8368. });
  8369. }
  8370. inline size_t get_multipart_ranges_data_length(const Request &req,
  8371. const std::string &boundary,
  8372. const std::string &content_type,
  8373. size_t content_length) {
  8374. size_t data_length = 0;
  8375. process_multipart_ranges_data(
  8376. req, boundary, content_type, content_length,
  8377. [&](const std::string &token) { data_length += token.size(); },
  8378. [&](const std::string &token) { data_length += token.size(); },
  8379. [&](size_t /*offset*/, size_t length) {
  8380. data_length += length;
  8381. return true;
  8382. });
  8383. return data_length;
  8384. }
  8385. template <typename T>
  8386. inline bool
  8387. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8388. const std::string &boundary,
  8389. const std::string &content_type,
  8390. size_t content_length, const T &is_shutting_down) {
  8391. return process_multipart_ranges_data(
  8392. req, boundary, content_type, content_length,
  8393. [&](const std::string &token) { strm.write(token); },
  8394. [&](const std::string &token) { strm.write(token); },
  8395. [&](size_t offset, size_t length) {
  8396. return write_content(strm, res.content_provider_, offset, length,
  8397. is_shutting_down);
  8398. });
  8399. }
  8400. inline bool has_framed_body(const Request &req) {
  8401. return is_chunked_transfer_encoding(req.headers) ||
  8402. req.get_header_value_u64("Content-Length") > 0;
  8403. }
  8404. inline bool is_connection_persistent(const Request &req) {
  8405. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8406. if (req.version == "HTTP/1.0" &&
  8407. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8408. return false;
  8409. }
  8410. return true;
  8411. }
  8412. inline bool expect_content(const Request &req) {
  8413. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8414. req.method == "DELETE") {
  8415. return true;
  8416. }
  8417. return has_framed_body(req);
  8418. }
  8419. #ifdef _WIN32
  8420. class WSInit {
  8421. public:
  8422. WSInit() {
  8423. WSADATA wsaData;
  8424. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8425. }
  8426. ~WSInit() {
  8427. if (is_valid_) WSACleanup();
  8428. }
  8429. bool is_valid_ = false;
  8430. };
  8431. static WSInit wsinit_;
  8432. #endif
  8433. // RFC 9110 Section 11.6.1 defines a challenge list as
  8434. // WWW-Authenticate = #challenge
  8435. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8436. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8437. // so a server may offer several schemes, each with its own comma-separated
  8438. // auth-param list, in either order and either as separate field lines or
  8439. // packed into one. Splitting on every comma would break apart a challenge's
  8440. // own param list; splitting only on the first space would miss a Digest
  8441. // challenge that isn't first. Split on commas that aren't inside a
  8442. // quoted-string instead, then track which scheme each resulting segment
  8443. // belongs to: a segment whose text before "=" contains whitespace (or that
  8444. // has no "=" at all) starts a new challenge named by its leading token.
  8445. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8446. std::vector<std::string> segments;
  8447. size_t start = 0;
  8448. auto in_quotes = false;
  8449. for (size_t i = 0; i < s.size(); i++) {
  8450. auto c = s[i];
  8451. if (in_quotes) {
  8452. if (c == '\\' && i + 1 < s.size()) {
  8453. i++;
  8454. } else if (c == '"') {
  8455. in_quotes = false;
  8456. }
  8457. } else if (c == '"') {
  8458. in_quotes = true;
  8459. } else if (c == ',') {
  8460. segments.push_back(s.substr(start, i - start));
  8461. start = i + 1;
  8462. }
  8463. }
  8464. segments.push_back(s.substr(start));
  8465. return segments;
  8466. }
  8467. inline std::string unescape_quoted_pairs(const std::string &s) {
  8468. std::string out;
  8469. out.reserve(s.size());
  8470. for (size_t i = 0; i < s.size(); i++) {
  8471. if (s[i] == '\\' && i + 1 < s.size()) {
  8472. out += s[++i];
  8473. } else {
  8474. out += s[i];
  8475. }
  8476. }
  8477. return out;
  8478. }
  8479. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8480. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8481. // quoted-pair, so the recipient recovers the original value.
  8482. inline std::string escape_quoted_pairs(const std::string &s) {
  8483. std::string out;
  8484. out.reserve(s.size());
  8485. for (auto c : s) {
  8486. if (c == '\\' || c == '"') { out += '\\'; }
  8487. out += c;
  8488. }
  8489. return out;
  8490. }
  8491. inline bool parse_www_authenticate(const Response &res,
  8492. std::map<std::string, std::string> &auth,
  8493. bool is_proxy) {
  8494. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8495. auto combined = get_combined_header_value(res.headers, auth_key);
  8496. if (combined.empty()) { return false; }
  8497. auto found_digest = false;
  8498. auto in_digest_challenge = false;
  8499. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8500. auto segment = trim_copy(raw_segment);
  8501. if (segment.empty()) { continue; }
  8502. auto eq_pos = segment.find('=');
  8503. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8504. // for the first segment of a challenge, "<scheme> <key>") must be
  8505. // trimmed before its boundaries are inspected.
  8506. auto key_part = trim_copy(
  8507. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8508. auto space_pos = key_part.find_last_of(" \t");
  8509. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8510. // "<scheme>[ <key>]" starts a new challenge.
  8511. auto scheme_end =
  8512. space_pos == std::string::npos ? key_part.size() : space_pos;
  8513. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8514. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8515. // from one challenge is never paired with another's algorithm.
  8516. in_digest_challenge =
  8517. !found_digest &&
  8518. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8519. if (in_digest_challenge) { found_digest = true; }
  8520. if (space_pos == std::string::npos) {
  8521. // Bare scheme (or a token68), no auth-param on this segment.
  8522. continue;
  8523. }
  8524. key_part = key_part.substr(space_pos + 1);
  8525. }
  8526. if (!in_digest_challenge) { continue; }
  8527. auto val = trim_copy(segment.substr(eq_pos + 1));
  8528. auto unquoted = trim_double_quotes_copy(val);
  8529. if (unquoted.size() != val.size()) {
  8530. unquoted = unescape_quoted_pairs(unquoted);
  8531. }
  8532. auth[std::move(key_part)] = std::move(unquoted);
  8533. }
  8534. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8535. // make_digest_authentication_header() dereferences both unconditionally, so
  8536. // a challenge missing either can't produce a usable Authorization header.
  8537. // Treat it the same as no Digest challenge at all.
  8538. return found_digest && auth.find("realm") != auth.end() &&
  8539. auth.find("nonce") != auth.end();
  8540. }
  8541. class ContentProviderAdapter {
  8542. public:
  8543. explicit ContentProviderAdapter(
  8544. ContentProviderWithoutLength &&content_provider)
  8545. : content_provider_(std::move(content_provider)) {}
  8546. bool operator()(size_t offset, size_t, DataSink &sink) {
  8547. return content_provider_(offset, sink);
  8548. }
  8549. private:
  8550. ContentProviderWithoutLength content_provider_;
  8551. };
  8552. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8553. namespace fields {
  8554. inline bool is_token_char(char c) {
  8555. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8556. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8557. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8558. }
  8559. inline bool is_token(const std::string &s) {
  8560. if (s.empty()) { return false; }
  8561. for (auto c : s) {
  8562. if (!is_token_char(c)) { return false; }
  8563. }
  8564. return true;
  8565. }
  8566. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8567. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8568. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8569. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8570. inline bool is_field_content(const std::string &s) {
  8571. if (s.empty()) { return true; }
  8572. if (s.size() == 1) {
  8573. return is_field_vchar(s[0]);
  8574. } else if (s.size() == 2) {
  8575. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8576. } else {
  8577. size_t i = 0;
  8578. if (!is_field_vchar(s[i])) { return false; }
  8579. i++;
  8580. while (i < s.size() - 1) {
  8581. auto c = s[i++];
  8582. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8583. } else {
  8584. return false;
  8585. }
  8586. }
  8587. return is_field_vchar(s[i]);
  8588. }
  8589. }
  8590. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8591. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8592. return is_field_name(name) && is_field_value(value);
  8593. }
  8594. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8595. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8596. inline bool is_request_target(const std::string &s) {
  8597. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8598. }
  8599. } // namespace fields
  8600. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8601. WebSocketUpgradeResponse &upgrade) {
  8602. // Generate random Sec-WebSocket-Key
  8603. thread_local std::mt19937 rng(std::random_device{}());
  8604. std::string key_bytes(16, '\0');
  8605. for (size_t i = 0; i < 16; i += 4) {
  8606. auto r = rng();
  8607. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8608. }
  8609. auto client_key = base64_encode(key_bytes);
  8610. req.headers.erase("Upgrade");
  8611. req.headers.erase("Connection");
  8612. req.headers.erase("Sec-WebSocket-Key");
  8613. req.headers.erase("Sec-WebSocket-Version");
  8614. req.headers.emplace("Upgrade", "websocket");
  8615. req.headers.emplace("Connection", "Upgrade");
  8616. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8617. req.headers.emplace("Sec-WebSocket-Version", "13");
  8618. // Build the request in memory first, like ClientImpl::write_request does.
  8619. // Writing straight to the socket would leak a request line onto the wire
  8620. // before check_and_write_headers gets a chance to reject an invalid header,
  8621. // and would emit one small write per header.
  8622. BufferStream bstrm;
  8623. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8624. upgrade.error = Error::Write;
  8625. return false;
  8626. }
  8627. auto error = Error::Success;
  8628. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8629. upgrade.error = error;
  8630. return false;
  8631. }
  8632. const auto &data = bstrm.get_buffer();
  8633. if (!write_data(strm, data.data(), data.size())) {
  8634. upgrade.error = Error::Write;
  8635. return false;
  8636. }
  8637. // Verify 101 response and Sec-WebSocket-Accept header
  8638. auto expected_accept = websocket_accept_key(client_key);
  8639. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8640. }
  8641. inline bool is_ip_address(const std::string &host) {
  8642. struct in_addr addr4;
  8643. struct in6_addr addr6;
  8644. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8645. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8646. }
  8647. // Resolve where a client should connect for `host`, honoring a user-supplied
  8648. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8649. // supplying the Host header and SNI; only the connection target changes.
  8650. //
  8651. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8652. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8653. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8654. // absent or empty mapping leaves `host` as the connection target; without the
  8655. // empty check the value would reach getaddrinfo as a null node and silently
  8656. // resolve to loopback.
  8657. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8658. const std::string &host, std::string &connect_host,
  8659. std::string &ip) {
  8660. connect_host = host;
  8661. ip.clear();
  8662. auto it = addr_map.find(host);
  8663. if (it == addr_map.end() || it->second.empty()) { return; }
  8664. if (is_ip_address(it->second)) {
  8665. ip = it->second;
  8666. } else {
  8667. connect_host = it->second;
  8668. }
  8669. }
  8670. } // namespace detail
  8671. /*
  8672. * Group 2: detail namespace - SSL common utilities
  8673. */
  8674. #ifdef CPPHTTPLIB_SSL_ENABLED
  8675. namespace detail {
  8676. class SSLSocketStream final : public Stream {
  8677. public:
  8678. SSLSocketStream(
  8679. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8680. time_t read_timeout_usec, time_t write_timeout_sec,
  8681. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8682. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8683. (std::chrono::steady_clock::time_point::min)());
  8684. ~SSLSocketStream() override;
  8685. bool is_readable() const override;
  8686. bool wait_readable() const override;
  8687. bool wait_writable() const override;
  8688. bool is_peer_alive() const override;
  8689. ssize_t read(char *ptr, size_t size) override;
  8690. ssize_t write(const char *ptr, size_t size) override;
  8691. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8692. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8693. socket_t socket() const override;
  8694. time_t duration() const override;
  8695. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8696. // See SocketStream::set_readable_hint().
  8697. void set_readable_hint() { readable_hint_ = true; }
  8698. private:
  8699. bool ensure_readable();
  8700. socket_t sock_;
  8701. tls::session_t session_;
  8702. time_t read_timeout_sec_;
  8703. time_t read_timeout_usec_;
  8704. time_t write_timeout_sec_;
  8705. time_t write_timeout_usec_;
  8706. time_t max_timeout_msec_;
  8707. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8708. bool readable_hint_ = false;
  8709. };
  8710. // A TLS stream for WebSocket connections, where the receive path and the
  8711. // send path (application send() plus the heartbeat ping thread) run on
  8712. // different threads. A single TLS session must never be entered
  8713. // concurrently, so every call into the session is serialized by one mutex.
  8714. //
  8715. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8716. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8717. // call under the lock, then waits for readiness with select() outside the
  8718. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8719. // blocked waiting for data never stalls a concurrent sender.
  8720. //
  8721. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8722. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8723. class WebSocketSSLStream final : public Stream {
  8724. public:
  8725. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8726. time_t read_timeout_sec, time_t read_timeout_usec,
  8727. time_t write_timeout_sec, time_t write_timeout_usec);
  8728. ~WebSocketSSLStream() override;
  8729. bool is_readable() const override;
  8730. bool wait_readable() const override;
  8731. bool wait_writable() const override;
  8732. ssize_t read(char *ptr, size_t size) override;
  8733. ssize_t write(const char *ptr, size_t size) override;
  8734. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8735. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8736. socket_t socket() const override;
  8737. time_t duration() const override;
  8738. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8739. private:
  8740. mutable std::mutex session_mutex_;
  8741. socket_t sock_;
  8742. tls::session_t session_;
  8743. // WebSocket::close() shortens the read timeout from the closing thread
  8744. // while the receive thread is inside wait_readable(), so these two are read
  8745. // and written concurrently. The write timeouts are never mutated.
  8746. std::atomic<time_t> read_timeout_sec_;
  8747. std::atomic<time_t> read_timeout_usec_;
  8748. time_t write_timeout_sec_;
  8749. time_t write_timeout_usec_;
  8750. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8751. };
  8752. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8753. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8754. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8755. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8756. unsigned int hash_length = 0;
  8757. unsigned char hash[EVP_MAX_MD_SIZE];
  8758. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8759. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8760. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8761. std::stringstream ss;
  8762. for (auto i = 0u; i < hash_length; ++i) {
  8763. ss << std::hex << std::setw(2) << std::setfill('0')
  8764. << static_cast<unsigned int>(hash[i]);
  8765. }
  8766. return ss.str();
  8767. }
  8768. inline std::string MD5(const std::string &s) {
  8769. return message_digest(s, EVP_md5());
  8770. }
  8771. inline std::string SHA_256(const std::string &s) {
  8772. return message_digest(s, EVP_sha256());
  8773. }
  8774. inline std::string SHA_512(const std::string &s) {
  8775. return message_digest(s, EVP_sha512());
  8776. }
  8777. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8778. namespace {
  8779. template <size_t N>
  8780. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8781. std::stringstream ss;
  8782. for (size_t i = 0; i < N; ++i) {
  8783. ss << std::hex << std::setw(2) << std::setfill('0')
  8784. << static_cast<unsigned int>(hash[i]);
  8785. }
  8786. return ss.str();
  8787. }
  8788. } // namespace
  8789. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8790. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8791. // initialized once. PSA state is process-global; do not free it.
  8792. inline bool ensure_mbedtls_psa_crypto() {
  8793. static std::once_flag once;
  8794. static bool ok = false;
  8795. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8796. return ok;
  8797. }
  8798. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8799. unsigned char *out, size_t out_size) {
  8800. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8801. size_t olen = 0;
  8802. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8803. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8804. olen == out_size;
  8805. }
  8806. #endif
  8807. inline std::string MD5(const std::string &s) {
  8808. unsigned char hash[16];
  8809. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8810. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8811. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8812. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8813. hash);
  8814. #else
  8815. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8816. hash);
  8817. #endif
  8818. return hash_to_hex(hash);
  8819. }
  8820. inline std::string SHA_256(const std::string &s) {
  8821. unsigned char hash[32];
  8822. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8823. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8824. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8825. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8826. hash, 0);
  8827. #else
  8828. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8829. s.size(), hash, 0);
  8830. #endif
  8831. return hash_to_hex(hash);
  8832. }
  8833. inline std::string SHA_512(const std::string &s) {
  8834. unsigned char hash[64];
  8835. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8836. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8837. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8838. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8839. hash, 0);
  8840. #else
  8841. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8842. s.size(), hash, 0);
  8843. #endif
  8844. return hash_to_hex(hash);
  8845. }
  8846. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8847. namespace {
  8848. template <size_t N>
  8849. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8850. std::stringstream ss;
  8851. for (size_t i = 0; i < N; ++i) {
  8852. ss << std::hex << std::setw(2) << std::setfill('0')
  8853. << static_cast<unsigned int>(hash[i]);
  8854. }
  8855. return ss.str();
  8856. }
  8857. } // namespace
  8858. inline std::string MD5(const std::string &s) {
  8859. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8860. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8861. static_cast<word32>(s.size()), hash);
  8862. return hash_to_hex(hash);
  8863. }
  8864. inline std::string SHA_256(const std::string &s) {
  8865. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8866. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8867. static_cast<word32>(s.size()), hash);
  8868. return hash_to_hex(hash);
  8869. }
  8870. inline std::string SHA_512(const std::string &s) {
  8871. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8872. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8873. static_cast<word32>(s.size()), hash);
  8874. return hash_to_hex(hash);
  8875. }
  8876. #endif
  8877. template <typename T>
  8878. inline bool process_server_socket_ssl(
  8879. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8880. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8881. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8882. time_t write_timeout_usec, T callback) {
  8883. return process_server_socket_core(
  8884. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8885. [&](bool close_connection, bool &connection_closed) {
  8886. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8887. write_timeout_sec, write_timeout_usec);
  8888. // See the non-TLS path in process_server_socket().
  8889. strm.set_readable_hint();
  8890. return callback(strm, close_connection, connection_closed);
  8891. });
  8892. }
  8893. template <typename T>
  8894. inline bool process_client_socket_ssl(
  8895. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8896. time_t read_timeout_usec, time_t write_timeout_sec,
  8897. time_t write_timeout_usec, time_t max_timeout_msec,
  8898. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8899. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8900. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8901. start_time);
  8902. return callback(strm);
  8903. }
  8904. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8905. const Request &req, const std::map<std::string, std::string> &auth,
  8906. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8907. const std::string &password, bool is_proxy = false) {
  8908. std::string nc;
  8909. {
  8910. std::stringstream ss;
  8911. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8912. nc = ss.str();
  8913. }
  8914. std::string qop;
  8915. if (auth.find("qop") != auth.end()) {
  8916. qop = auth.at("qop");
  8917. if (qop.find("auth-int") != std::string::npos) {
  8918. qop = "auth-int";
  8919. } else if (qop.find("auth") != std::string::npos) {
  8920. qop = "auth";
  8921. } else {
  8922. qop.clear();
  8923. }
  8924. }
  8925. std::string algo = "MD5";
  8926. if (auth.find("algorithm") != auth.end()) {
  8927. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  8928. // not a token would otherwise be emitted verbatim and could carry commas
  8929. // or quotes that inject further auth-params into the header below.
  8930. const auto &a = auth.at("algorithm");
  8931. if (fields::is_token(a)) { algo = a; }
  8932. }
  8933. std::string response;
  8934. {
  8935. auto H = algo == "SHA-256" ? detail::SHA_256
  8936. : algo == "SHA-512" ? detail::SHA_512
  8937. : detail::MD5;
  8938. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8939. auto A2 = req.method + ":" + req.path;
  8940. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8941. if (qop.empty()) {
  8942. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8943. } else {
  8944. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8945. ":" + qop + ":" + H(A2));
  8946. }
  8947. }
  8948. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8949. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  8950. // close the string early. realm, nonce and opaque come straight from the
  8951. // server's challenge (parse_www_authenticate() already de-escaped them), so
  8952. // without this a crafted challenge injects extra auth-params into the header.
  8953. auto field =
  8954. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  8955. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  8956. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  8957. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  8958. "\", algorithm=" + algo +
  8959. (qop.empty() ? ", response=\""
  8960. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  8961. "\", response=\"") +
  8962. response + "\"" +
  8963. (opaque.empty()
  8964. ? ""
  8965. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  8966. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8967. return std::make_pair(key, field);
  8968. }
  8969. inline bool match_hostname(const std::string &pattern,
  8970. const std::string &hostname) {
  8971. // Exact match (case-insensitive)
  8972. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8973. // Split both pattern and hostname into components by '.'
  8974. std::vector<std::string> pattern_components;
  8975. if (!pattern.empty()) {
  8976. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8977. [&](const char *b, const char *e) {
  8978. pattern_components.emplace_back(b, e);
  8979. });
  8980. }
  8981. std::vector<std::string> host_components;
  8982. if (!hostname.empty()) {
  8983. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8984. [&](const char *b, const char *e) {
  8985. host_components.emplace_back(b, e);
  8986. });
  8987. }
  8988. // Component count must match
  8989. if (host_components.size() != pattern_components.size()) { return false; }
  8990. // Compare each component with wildcard support
  8991. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8992. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8993. auto itr = pattern_components.begin();
  8994. for (const auto &h : host_components) {
  8995. auto &p = *itr;
  8996. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8997. bool partial_match = false;
  8998. if (!p.empty() && p[p.size() - 1] == '*') {
  8999. const auto prefix_length = p.size() - 1;
  9000. if (prefix_length == 0) {
  9001. partial_match = true;
  9002. } else if (h.size() >= prefix_length) {
  9003. partial_match =
  9004. std::equal(p.begin(),
  9005. p.begin() + static_cast<std::string::difference_type>(
  9006. prefix_length),
  9007. h.begin(), [](const char ca, const char cb) {
  9008. return detail::case_ignore::to_lower(ca) ==
  9009. detail::case_ignore::to_lower(cb);
  9010. });
  9011. }
  9012. }
  9013. if (!partial_match) { return false; }
  9014. }
  9015. ++itr;
  9016. }
  9017. return true;
  9018. }
  9019. #ifdef _WIN32
  9020. // Verify certificate using Windows CertGetCertificateChain API.
  9021. // This provides real-time certificate validation with Windows Update
  9022. // integration, independent of the TLS backend.
  9023. inline bool verify_cert_with_windows_schannel(
  9024. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9025. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9026. if (der_cert.empty()) { return false; }
  9027. out_error = 0;
  9028. // Create Windows certificate context from DER data
  9029. auto cert_context = CertCreateCertificateContext(
  9030. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9031. static_cast<DWORD>(der_cert.size()));
  9032. if (!cert_context) {
  9033. out_error = GetLastError();
  9034. return false;
  9035. }
  9036. auto cert_guard =
  9037. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9038. // Give CryptoAPI the certificates the server sent. Without them it follows
  9039. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9040. std::vector<tls::cert_t> peer_certs;
  9041. tls::get_peer_certs(session, peer_certs);
  9042. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9043. auto store_guard = scope_exit([&] {
  9044. for (auto cert : peer_certs) {
  9045. tls::free_cert(cert);
  9046. }
  9047. if (store) { CertCloseStore(store, 0); }
  9048. });
  9049. for (auto cert : peer_certs) {
  9050. std::vector<unsigned char> der;
  9051. if (store && tls::get_cert_der(cert, der)) {
  9052. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9053. static_cast<DWORD>(der.size()),
  9054. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9055. }
  9056. }
  9057. // Setup chain parameters
  9058. CERT_CHAIN_PARA chain_para = {};
  9059. chain_para.cbSize = sizeof(chain_para);
  9060. // Require the server authentication usage along the chain, which also
  9061. // rejects roots that Windows trusts only for other purposes.
  9062. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9063. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9064. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9065. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9066. // Build certificate chain with revocation checking
  9067. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9068. auto chain_result = CertGetCertificateChain(
  9069. nullptr, cert_context, nullptr, store, &chain_para,
  9070. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9071. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9072. nullptr, &chain_context);
  9073. if (!chain_result || !chain_context) {
  9074. out_error = GetLastError();
  9075. return false;
  9076. }
  9077. auto chain_guard =
  9078. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9079. // Check if chain has errors
  9080. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  9081. out_error = chain_context->TrustStatus.dwErrorStatus;
  9082. return false;
  9083. }
  9084. // Verify SSL policy
  9085. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9086. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9087. #ifdef AUTHTYPE_SERVER
  9088. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9089. #endif
  9090. std::wstring whost;
  9091. if (verify_hostname) {
  9092. whost = u8string_to_wstring(hostname.c_str());
  9093. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9094. }
  9095. CERT_CHAIN_POLICY_PARA policy_para = {};
  9096. policy_para.cbSize = sizeof(policy_para);
  9097. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9098. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9099. #else
  9100. policy_para.dwFlags = 0;
  9101. #endif
  9102. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9103. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9104. policy_status.cbSize = sizeof(policy_status);
  9105. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9106. &policy_para, &policy_status)) {
  9107. out_error = GetLastError();
  9108. return false;
  9109. }
  9110. if (policy_status.dwError != 0) {
  9111. out_error = policy_status.dwError;
  9112. return false;
  9113. }
  9114. return true;
  9115. }
  9116. #endif // _WIN32
  9117. // Loads CA file/dir configuration and applies the system CA policy to a
  9118. // client TLS context. PEM data and native stores are applied to the context
  9119. // directly at set time; has_custom_store reflects them for the Auto policy
  9120. // decision.
  9121. inline bool load_client_ca_config(tls::ctx_t ctx,
  9122. const std::string &ca_cert_file_path,
  9123. const std::string &ca_cert_dir_path,
  9124. bool has_custom_store, SystemCAMode mode,
  9125. uint64_t &backend_error) {
  9126. auto ret = true;
  9127. if (!ca_cert_file_path.empty()) {
  9128. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9129. backend_error = tls::get_error();
  9130. ret = false;
  9131. }
  9132. } else if (!ca_cert_dir_path.empty()) {
  9133. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9134. backend_error = tls::get_error();
  9135. ret = false;
  9136. }
  9137. }
  9138. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9139. !ca_cert_dir_path.empty() || has_custom_store;
  9140. if (mode == SystemCAMode::Enabled ||
  9141. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9142. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9143. }
  9144. return ret;
  9145. }
  9146. // The parts of session setup that only SSLClient needs, plus the handful
  9147. // WebSocketClient also exposes; everything else takes the defaults, which is
  9148. // what keeps the two clients on one implementation.
  9149. struct ClientTlsSessionOptions {
  9150. // Both SSLClient and WebSocketClient expose this independently of
  9151. // certificate verification.
  9152. bool server_hostname_verification = true;
  9153. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9154. // When non-null, guards session creation against concurrent use of the
  9155. // context. A WebSocketClient is not safe to use from several threads to
  9156. // begin with, so it passes nothing.
  9157. std::mutex *ctx_mutex = nullptr;
  9158. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9159. // The caller decides whether Schannel has anything to say about this
  9160. // connection; see SSLClient::initialize_ssl().
  9161. bool windows_cert_verification = false;
  9162. // A server certificate verifier works on the backend's chain verification,
  9163. // so the backend keeps deciding and Schannel only adds its own check.
  9164. bool server_certificate_verifier_set = false;
  9165. #endif
  9166. };
  9167. // Filled in on failure for callers that report error details.
  9168. struct ClientTlsSessionError {
  9169. Error error = Error::Success;
  9170. int ssl_error = 0;
  9171. uint64_t backend_error = 0;
  9172. };
  9173. // Establishes a client TLS session on an already connected socket. On failure
  9174. // the session is left for the caller to free: SSLClient frees it right away,
  9175. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9176. inline bool setup_client_tls_session(
  9177. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9178. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9179. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9180. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9181. using namespace tls;
  9182. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9183. if (out_error) {
  9184. out_error->error = error;
  9185. out_error->ssl_error = ssl_error;
  9186. out_error->backend_error = backend_error;
  9187. }
  9188. return false;
  9189. };
  9190. if (!ctx) {
  9191. session = nullptr;
  9192. return fail(Error::SSLConnection, 0, 0);
  9193. }
  9194. // With Windows verification on and no server certificate verifier set,
  9195. // Schannel is the only chain verifier. The backend's trust store is a
  9196. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9197. // demand, so the backend's verdict is not used.
  9198. auto windows_verifies_chain = false;
  9199. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9200. windows_verifies_chain = options.windows_cert_verification &&
  9201. !options.server_certificate_verifier_set;
  9202. #endif
  9203. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9204. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9205. // uses SSL_VERIFY_NONE and does all verification post-handshake. Unless
  9206. // Schannel verifies the chain instead, chain verification happens during
  9207. // the handshake even for IP hosts; the certificate identity is verified
  9208. // post-handshake via verify_hostname().
  9209. set_verify_client(ctx,
  9210. server_certificate_verification && !windows_verifies_chain);
  9211. #endif
  9212. {
  9213. std::unique_lock<std::mutex> guard;
  9214. if (options.ctx_mutex) {
  9215. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9216. }
  9217. session = create_session(ctx, sock);
  9218. }
  9219. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9220. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9221. // their identity is checked post-handshake below instead. On Mbed TLS and
  9222. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9223. // options.server_hostname_verification is threaded through here.
  9224. if (!is_ip_address(host)) {
  9225. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9226. return fail(Error::SSLConnection, 0, get_error());
  9227. }
  9228. }
  9229. TlsError tls_err;
  9230. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9231. &tls_err)) {
  9232. auto error = Error::SSLConnection;
  9233. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9234. error = Error::SSLServerVerification;
  9235. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9236. error = Error::SSLServerHostnameVerification;
  9237. }
  9238. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9239. }
  9240. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9241. if (options.session_verifier) {
  9242. verification_status = options.session_verifier(session);
  9243. }
  9244. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9245. return fail(Error::SSLServerVerification, 0, get_error());
  9246. }
  9247. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9248. server_certificate_verification) {
  9249. if (!windows_verifies_chain) {
  9250. auto verify_result = get_verify_result(session);
  9251. if (verify_result != 0) {
  9252. return fail(Error::SSLServerVerification, 0,
  9253. static_cast<uint64_t>(verify_result));
  9254. }
  9255. }
  9256. auto server_cert = get_peer_cert(session);
  9257. if (!server_cert) {
  9258. return fail(Error::SSLServerVerification, 0, get_error());
  9259. }
  9260. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9261. // Identity check against the peer certificate, post-handshake for all
  9262. // backends. For IP hosts this is the only identity verification, since no
  9263. // hostname is bound during the handshake.
  9264. if (options.server_hostname_verification) {
  9265. if (!verify_hostname(server_cert, host.c_str())) {
  9266. return fail(Error::SSLServerHostnameVerification, 0,
  9267. hostname_mismatch_code());
  9268. }
  9269. }
  9270. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9271. // Windows Schannel verification, which lets Windows fetch missing roots
  9272. // and intermediates on demand. It must not be skipped: unless a server
  9273. // certificate verifier is set, it is the only chain check.
  9274. if (options.windows_cert_verification) {
  9275. std::vector<unsigned char> der;
  9276. uint64_t wincrypt_error = 0;
  9277. if (!get_cert_der(server_cert, der) ||
  9278. !verify_cert_with_windows_schannel(
  9279. der, host, options.server_hostname_verification, wincrypt_error,
  9280. session)) {
  9281. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9282. }
  9283. }
  9284. #endif
  9285. }
  9286. return true;
  9287. }
  9288. } // namespace detail
  9289. #endif // CPPHTTPLIB_SSL_ENABLED
  9290. /*
  9291. * Group 3: httplib namespace - Non-SSL public API implementations
  9292. */
  9293. inline void default_socket_options(socket_t sock) {
  9294. set_socket_opt(sock, SOL_SOCKET,
  9295. #ifdef SO_REUSEPORT
  9296. SO_REUSEPORT,
  9297. #else
  9298. SO_REUSEADDR,
  9299. #endif
  9300. 1);
  9301. }
  9302. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9303. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9304. sizeof(optval));
  9305. }
  9306. inline std::string get_bearer_token_auth(const Request &req) {
  9307. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9308. // than the prefix carries no token.
  9309. constexpr const char bearer_prefix[] = "Bearer ";
  9310. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9311. auto value = req.get_header_value("Authorization");
  9312. if (value.size() >= bearer_prefix_len &&
  9313. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9314. bearer_prefix)) {
  9315. return value.substr(bearer_prefix_len);
  9316. }
  9317. return "";
  9318. }
  9319. inline const char *status_message(int status) {
  9320. switch (status) {
  9321. case StatusCode::Continue_100: return "Continue";
  9322. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9323. case StatusCode::Processing_102: return "Processing";
  9324. case StatusCode::EarlyHints_103: return "Early Hints";
  9325. case StatusCode::OK_200: return "OK";
  9326. case StatusCode::Created_201: return "Created";
  9327. case StatusCode::Accepted_202: return "Accepted";
  9328. case StatusCode::NonAuthoritativeInformation_203:
  9329. return "Non-Authoritative Information";
  9330. case StatusCode::NoContent_204: return "No Content";
  9331. case StatusCode::ResetContent_205: return "Reset Content";
  9332. case StatusCode::PartialContent_206: return "Partial Content";
  9333. case StatusCode::MultiStatus_207: return "Multi-Status";
  9334. case StatusCode::AlreadyReported_208: return "Already Reported";
  9335. case StatusCode::IMUsed_226: return "IM Used";
  9336. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9337. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9338. case StatusCode::Found_302: return "Found";
  9339. case StatusCode::SeeOther_303: return "See Other";
  9340. case StatusCode::NotModified_304: return "Not Modified";
  9341. case StatusCode::UseProxy_305: return "Use Proxy";
  9342. case StatusCode::unused_306: return "unused";
  9343. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9344. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9345. case StatusCode::BadRequest_400: return "Bad Request";
  9346. case StatusCode::Unauthorized_401: return "Unauthorized";
  9347. case StatusCode::PaymentRequired_402: return "Payment Required";
  9348. case StatusCode::Forbidden_403: return "Forbidden";
  9349. case StatusCode::NotFound_404: return "Not Found";
  9350. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9351. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9352. case StatusCode::ProxyAuthenticationRequired_407:
  9353. return "Proxy Authentication Required";
  9354. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9355. case StatusCode::Conflict_409: return "Conflict";
  9356. case StatusCode::Gone_410: return "Gone";
  9357. case StatusCode::LengthRequired_411: return "Length Required";
  9358. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9359. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9360. case StatusCode::UriTooLong_414: return "URI Too Long";
  9361. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9362. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9363. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9364. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9365. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9366. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9367. case StatusCode::Locked_423: return "Locked";
  9368. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9369. case StatusCode::TooEarly_425: return "Too Early";
  9370. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9371. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9372. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9373. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9374. return "Request Header Fields Too Large";
  9375. case StatusCode::UnavailableForLegalReasons_451:
  9376. return "Unavailable For Legal Reasons";
  9377. case StatusCode::NotImplemented_501: return "Not Implemented";
  9378. case StatusCode::BadGateway_502: return "Bad Gateway";
  9379. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9380. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9381. case StatusCode::HttpVersionNotSupported_505:
  9382. return "HTTP Version Not Supported";
  9383. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9384. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9385. case StatusCode::LoopDetected_508: return "Loop Detected";
  9386. case StatusCode::NotExtended_510: return "Not Extended";
  9387. case StatusCode::NetworkAuthenticationRequired_511:
  9388. return "Network Authentication Required";
  9389. default:
  9390. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9391. }
  9392. }
  9393. inline std::string to_string(const Error error) {
  9394. switch (error) {
  9395. case Error::Success: return "Success (no error)";
  9396. case Error::Unknown: return "Unknown";
  9397. case Error::Connection: return "Could not establish connection";
  9398. case Error::BindIPAddress: return "Failed to bind IP address";
  9399. case Error::Read: return "Failed to read connection";
  9400. case Error::Write: return "Failed to write connection";
  9401. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9402. case Error::Canceled: return "Connection handling canceled";
  9403. case Error::SSLConnection: return "SSL connection failed";
  9404. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9405. case Error::SSLServerVerification: return "SSL server verification failed";
  9406. case Error::SSLServerHostnameVerification:
  9407. return "SSL server hostname verification failed";
  9408. case Error::UnsupportedMultipartBoundaryChars:
  9409. return "Unsupported HTTP multipart boundary characters";
  9410. case Error::Compression: return "Compression failed";
  9411. case Error::ConnectionTimeout: return "Connection timed out";
  9412. case Error::ProxyConnection: return "Proxy connection failed";
  9413. case Error::ConnectionClosed: return "Connection closed by server";
  9414. case Error::Timeout: return "Read timeout";
  9415. case Error::ResourceExhaustion: return "Resource exhaustion";
  9416. case Error::TooManyFormDataFiles: return "Too many form data files";
  9417. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9418. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9419. case Error::ExceedMaxSocketDescriptorCount:
  9420. return "Exceeded maximum socket descriptor count";
  9421. case Error::InvalidRequestLine: return "Invalid request line";
  9422. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9423. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9424. case Error::InvalidHeaders: return "Invalid headers";
  9425. case Error::MultipartParsing: return "Multipart parsing failed";
  9426. case Error::OpenFile: return "Failed to open file";
  9427. case Error::Listen: return "Failed to listen on socket";
  9428. case Error::GetSockName: return "Failed to get socket name";
  9429. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9430. case Error::HTTPParsing: return "HTTP parsing failed";
  9431. case Error::InvalidRangeHeader: return "Invalid Range header";
  9432. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9433. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9434. case Error::UserCallbackException: return "User callback threw an exception";
  9435. default: break;
  9436. }
  9437. return "Invalid";
  9438. }
  9439. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9440. os << to_string(obj);
  9441. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9442. return os;
  9443. }
  9444. inline std::string hosted_at(const std::string &hostname) {
  9445. std::vector<std::string> addrs;
  9446. hosted_at(hostname, addrs);
  9447. if (addrs.empty()) { return std::string(); }
  9448. return addrs[0];
  9449. }
  9450. inline void hosted_at(const std::string &hostname,
  9451. std::vector<std::string> &addrs) {
  9452. struct addrinfo hints;
  9453. struct addrinfo *result;
  9454. memset(&hints, 0, sizeof(struct addrinfo));
  9455. hints.ai_family = AF_UNSPEC;
  9456. hints.ai_socktype = SOCK_STREAM;
  9457. hints.ai_protocol = 0;
  9458. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9459. &result, 0)) {
  9460. #if defined __linux__ && !defined __ANDROID__
  9461. res_init();
  9462. #endif
  9463. return;
  9464. }
  9465. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9466. for (auto rp = result; rp; rp = rp->ai_next) {
  9467. const auto &addr =
  9468. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9469. std::string ip;
  9470. auto dummy = -1;
  9471. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9472. dummy)) {
  9473. addrs.emplace_back(std::move(ip));
  9474. }
  9475. }
  9476. }
  9477. inline std::string encode_uri_component(const std::string &value) {
  9478. std::ostringstream escaped;
  9479. escaped.fill('0');
  9480. escaped << std::hex;
  9481. for (auto c : value) {
  9482. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9483. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9484. escaped << c;
  9485. } else {
  9486. escaped << std::uppercase;
  9487. escaped << '%' << std::setw(2)
  9488. << static_cast<int>(static_cast<unsigned char>(c));
  9489. escaped << std::nouppercase;
  9490. }
  9491. }
  9492. return escaped.str();
  9493. }
  9494. inline std::string encode_uri(const std::string &value) {
  9495. std::ostringstream escaped;
  9496. escaped.fill('0');
  9497. escaped << std::hex;
  9498. for (auto c : value) {
  9499. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9500. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9501. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9502. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9503. escaped << c;
  9504. } else {
  9505. escaped << std::uppercase;
  9506. escaped << '%' << std::setw(2)
  9507. << static_cast<int>(static_cast<unsigned char>(c));
  9508. escaped << std::nouppercase;
  9509. }
  9510. }
  9511. return escaped.str();
  9512. }
  9513. inline std::string decode_uri_component(const std::string &value) {
  9514. std::string result;
  9515. for (size_t i = 0; i < value.size(); i++) {
  9516. if (value[i] == '%' && i + 2 < value.size()) {
  9517. auto val = 0;
  9518. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9519. result += static_cast<char>(val);
  9520. i += 2;
  9521. } else {
  9522. result += value[i];
  9523. }
  9524. } else {
  9525. result += value[i];
  9526. }
  9527. }
  9528. return result;
  9529. }
  9530. inline std::string decode_uri(const std::string &value) {
  9531. std::string result;
  9532. for (size_t i = 0; i < value.size(); i++) {
  9533. if (value[i] == '%' && i + 2 < value.size()) {
  9534. auto val = 0;
  9535. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9536. auto c = static_cast<char>(val);
  9537. // Keep escapes of the reserved characters that encode_uri leaves
  9538. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9539. // delimiter is not promoted into a real one (as with JS decodeURI).
  9540. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9541. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9542. c == '#') {
  9543. result += value[i];
  9544. result += value[i + 1];
  9545. result += value[i + 2];
  9546. } else {
  9547. result += c;
  9548. }
  9549. i += 2;
  9550. } else {
  9551. result += value[i];
  9552. }
  9553. } else {
  9554. result += value[i];
  9555. }
  9556. }
  9557. return result;
  9558. }
  9559. inline std::string encode_path_component(const std::string &component) {
  9560. std::string result;
  9561. result.reserve(component.size() * 3);
  9562. for (size_t i = 0; i < component.size(); i++) {
  9563. auto c = static_cast<unsigned char>(component[i]);
  9564. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9565. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9566. c == '_' || c == '~') {
  9567. result += static_cast<char>(c);
  9568. }
  9569. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9570. // "," / ";" / "="
  9571. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9572. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9573. c == '=') {
  9574. result += static_cast<char>(c);
  9575. }
  9576. // Colon is allowed in path segments except first segment
  9577. else if (c == ':') {
  9578. result += static_cast<char>(c);
  9579. }
  9580. // @ is allowed in path
  9581. else if (c == '@') {
  9582. result += static_cast<char>(c);
  9583. } else {
  9584. result += '%';
  9585. char hex[3];
  9586. snprintf(hex, sizeof(hex), "%02X", c);
  9587. result.append(hex, 2);
  9588. }
  9589. }
  9590. return result;
  9591. }
  9592. inline std::string decode_path_component(const std::string &component) {
  9593. std::string result;
  9594. result.reserve(component.size());
  9595. for (size_t i = 0; i < component.size(); i++) {
  9596. if (component[i] == '%' && i + 1 < component.size()) {
  9597. if (component[i + 1] == 'u') {
  9598. // Unicode %uXXXX encoding
  9599. auto val = 0;
  9600. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9601. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9602. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9603. char buff[4];
  9604. size_t len = detail::to_utf8(val, buff);
  9605. if (len > 0) { result.append(buff, len); }
  9606. i += 5; // 'u0000'
  9607. } else {
  9608. result += component[i];
  9609. }
  9610. } else {
  9611. // Standard %XX encoding
  9612. auto val = 0;
  9613. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9614. // 2 digits hex codes
  9615. result += static_cast<char>(val);
  9616. i += 2; // 'XX'
  9617. } else {
  9618. result += component[i];
  9619. }
  9620. }
  9621. } else {
  9622. result += component[i];
  9623. }
  9624. }
  9625. return result;
  9626. }
  9627. inline std::string encode_query_component(const std::string &component,
  9628. bool space_as_plus) {
  9629. std::string result;
  9630. result.reserve(component.size() * 3);
  9631. for (size_t i = 0; i < component.size(); i++) {
  9632. auto c = static_cast<unsigned char>(component[i]);
  9633. // Unreserved characters per RFC 3986
  9634. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9635. c == '_' || c == '~') {
  9636. result += static_cast<char>(c);
  9637. }
  9638. // Space handling
  9639. else if (c == ' ') {
  9640. if (space_as_plus) {
  9641. result += '+';
  9642. } else {
  9643. result += "%20";
  9644. }
  9645. }
  9646. // Plus sign handling
  9647. else if (c == '+') {
  9648. if (space_as_plus) {
  9649. result += "%2B";
  9650. } else {
  9651. result += static_cast<char>(c);
  9652. }
  9653. }
  9654. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9655. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9656. c == '*' || c == ',' || c == ';') {
  9657. result += static_cast<char>(c);
  9658. }
  9659. // Colon and @ are allowed in query
  9660. else if (c == ':' || c == '@') {
  9661. result += static_cast<char>(c);
  9662. }
  9663. // Forward slash is allowed in query values
  9664. else if (c == '/') {
  9665. result += static_cast<char>(c);
  9666. }
  9667. // Question mark is allowed in query values (after first ?)
  9668. else if (c == '?') {
  9669. result += static_cast<char>(c);
  9670. } else {
  9671. result += '%';
  9672. char hex[3];
  9673. snprintf(hex, sizeof(hex), "%02X", c);
  9674. result.append(hex, 2);
  9675. }
  9676. }
  9677. return result;
  9678. }
  9679. inline std::string decode_query_component(const std::string &component,
  9680. bool plus_as_space) {
  9681. std::string result;
  9682. result.reserve(component.size());
  9683. for (size_t i = 0; i < component.size(); i++) {
  9684. if (component[i] == '%' && i + 2 < component.size()) {
  9685. auto val = 0;
  9686. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9687. result += static_cast<char>(val);
  9688. i += 2;
  9689. } else {
  9690. result += component[i];
  9691. }
  9692. } else if (component[i] == '+' && plus_as_space) {
  9693. result += ' '; // + becomes space in form-urlencoded
  9694. } else {
  9695. result += component[i];
  9696. }
  9697. }
  9698. return result;
  9699. }
  9700. inline std::string sanitize_filename(const std::string &filename) {
  9701. // Extract basename: find the last path separator (/ or \)
  9702. auto pos = filename.find_last_of("/\\");
  9703. auto result =
  9704. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9705. // Strip null bytes
  9706. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9707. // Trim whitespace
  9708. {
  9709. auto start = result.find_first_not_of(" \t");
  9710. auto end = result.find_last_not_of(" \t");
  9711. result = (start == std::string::npos)
  9712. ? ""
  9713. : result.substr(start, end - start + 1);
  9714. }
  9715. // Reject . and ..
  9716. if (result == "." || result == "..") { return ""; }
  9717. return result;
  9718. }
  9719. inline std::string append_query_params(const std::string &path,
  9720. const Params &params) {
  9721. std::string path_with_query = path;
  9722. thread_local const std::regex re("[^?]+\\?.*");
  9723. auto delm = std::regex_match(path, re) ? '&' : '?';
  9724. path_with_query += delm + detail::params_to_query_str(params);
  9725. return path_with_query;
  9726. }
  9727. // Header utilities
  9728. inline std::pair<std::string, std::string>
  9729. make_range_header(const Ranges &ranges) {
  9730. std::string field = "bytes=";
  9731. auto i = 0;
  9732. for (const auto &r : ranges) {
  9733. if (i != 0) { field += ", "; }
  9734. if (r.first != -1) { field += std::to_string(r.first); }
  9735. field += '-';
  9736. if (r.second != -1) { field += std::to_string(r.second); }
  9737. i++;
  9738. }
  9739. return std::make_pair("Range", std::move(field));
  9740. }
  9741. inline std::pair<std::string, std::string>
  9742. make_basic_authentication_header(const std::string &username,
  9743. const std::string &password, bool is_proxy) {
  9744. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9745. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9746. return std::make_pair(key, std::move(field));
  9747. }
  9748. inline std::pair<std::string, std::string>
  9749. make_bearer_token_authentication_header(const std::string &token,
  9750. bool is_proxy = false) {
  9751. auto field = "Bearer " + token;
  9752. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9753. return std::make_pair(key, std::move(field));
  9754. }
  9755. // Request implementation
  9756. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9757. size_t id) const {
  9758. return detail::get_header_value_u64(headers, key, def, id);
  9759. }
  9760. inline bool Request::has_header(const std::string &key) const {
  9761. return detail::has_header(headers, key);
  9762. }
  9763. inline std::string Request::get_header_value(const std::string &key,
  9764. const char *def, size_t id) const {
  9765. return detail::get_header_value(headers, key, def, id);
  9766. }
  9767. inline size_t Request::get_header_value_count(const std::string &key) const {
  9768. return detail::get_header_value_count(headers, key);
  9769. }
  9770. inline void Request::set_header(const std::string &key,
  9771. const std::string &val) {
  9772. detail::set_header(headers, key, val);
  9773. }
  9774. inline bool Request::has_trailer(const std::string &key) const {
  9775. return trailers.find(key) != trailers.end();
  9776. }
  9777. inline std::string Request::get_trailer_value(const std::string &key,
  9778. size_t id) const {
  9779. return detail::get_multimap_value(trailers, key, id);
  9780. }
  9781. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9782. return trailers.count(key);
  9783. }
  9784. inline bool Request::has_param(const std::string &key) const {
  9785. return params.find(key) != params.end();
  9786. }
  9787. inline std::string Request::get_param_value(const std::string &key,
  9788. size_t id) const {
  9789. return detail::get_multimap_value(params, key, id);
  9790. }
  9791. inline std::vector<std::string>
  9792. Request::get_param_values(const std::string &key) const {
  9793. auto rng = params.equal_range(key);
  9794. std::vector<std::string> values;
  9795. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9796. for (auto it = rng.first; it != rng.second; ++it) {
  9797. values.push_back(it->second);
  9798. }
  9799. return values;
  9800. }
  9801. inline size_t Request::get_param_value_count(const std::string &key) const {
  9802. return params.count(key);
  9803. }
  9804. inline bool Request::is_multipart_form_data() const {
  9805. const auto &content_type = get_header_value("Content-Type");
  9806. return detail::extract_media_type(content_type) == "multipart/form-data";
  9807. }
  9808. // Multipart FormData implementation
  9809. inline std::string MultipartFormData::get_field(const std::string &key,
  9810. size_t id) const {
  9811. auto rng = fields.equal_range(key);
  9812. auto it = rng.first;
  9813. std::advance(it, static_cast<ssize_t>(id));
  9814. if (it != rng.second) { return it->second.content; }
  9815. return std::string();
  9816. }
  9817. inline std::vector<std::string>
  9818. MultipartFormData::get_fields(const std::string &key) const {
  9819. std::vector<std::string> values;
  9820. auto rng = fields.equal_range(key);
  9821. for (auto it = rng.first; it != rng.second; it++) {
  9822. values.push_back(it->second.content);
  9823. }
  9824. return values;
  9825. }
  9826. inline bool MultipartFormData::has_field(const std::string &key) const {
  9827. return fields.find(key) != fields.end();
  9828. }
  9829. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9830. return fields.count(key);
  9831. }
  9832. inline FormData MultipartFormData::get_file(const std::string &key,
  9833. size_t id) const {
  9834. return detail::get_multimap_value(files, key, id);
  9835. }
  9836. inline std::vector<FormData>
  9837. MultipartFormData::get_files(const std::string &key) const {
  9838. std::vector<FormData> values;
  9839. auto rng = files.equal_range(key);
  9840. for (auto it = rng.first; it != rng.second; it++) {
  9841. values.push_back(it->second);
  9842. }
  9843. return values;
  9844. }
  9845. inline bool MultipartFormData::has_file(const std::string &key) const {
  9846. return files.find(key) != files.end();
  9847. }
  9848. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9849. return files.count(key);
  9850. }
  9851. // Multipart FormData writer implementation
  9852. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9853. return detail::is_multipart_boundary_chars_valid(boundary);
  9854. }
  9855. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9856. : boundary_(detail::make_multipart_data_boundary()) {}
  9857. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9858. : boundary_(std::move(boundary)) {}
  9859. inline const std::string &MultipartFormDataWriter::boundary() const {
  9860. return boundary_;
  9861. }
  9862. inline std::string MultipartFormDataWriter::content_type() const {
  9863. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9864. }
  9865. inline std::string
  9866. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9867. return detail::serialize_multipart_formdata(items, boundary_);
  9868. }
  9869. inline size_t MultipartFormDataWriter::content_length(
  9870. const UploadFormDataItems &items) const {
  9871. return detail::get_multipart_content_length(items, boundary_);
  9872. }
  9873. inline std::string
  9874. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9875. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9876. }
  9877. inline std::string MultipartFormDataWriter::item_end() {
  9878. return detail::serialize_multipart_formdata_item_end();
  9879. }
  9880. inline std::string MultipartFormDataWriter::finish() const {
  9881. return detail::serialize_multipart_formdata_finish(boundary_);
  9882. }
  9883. // Response implementation
  9884. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9885. size_t id) const {
  9886. return detail::get_header_value_u64(headers, key, def, id);
  9887. }
  9888. inline bool Response::has_header(const std::string &key) const {
  9889. return headers.find(key) != headers.end();
  9890. }
  9891. inline std::string Response::get_header_value(const std::string &key,
  9892. const char *def,
  9893. size_t id) const {
  9894. return detail::get_header_value(headers, key, def, id);
  9895. }
  9896. inline size_t Response::get_header_value_count(const std::string &key) const {
  9897. return detail::get_header_value_count(headers, key);
  9898. }
  9899. inline void Response::set_header(const std::string &key,
  9900. const std::string &val) {
  9901. detail::set_header(headers, key, val);
  9902. }
  9903. inline bool Response::has_trailer(const std::string &key) const {
  9904. return trailers.find(key) != trailers.end();
  9905. }
  9906. inline std::string Response::get_trailer_value(const std::string &key,
  9907. size_t id) const {
  9908. return detail::get_multimap_value(trailers, key, id);
  9909. }
  9910. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9911. return trailers.count(key);
  9912. }
  9913. inline void Response::set_redirect(const std::string &url, int stat) {
  9914. if (detail::fields::is_field_value(url)) {
  9915. set_header("Location", url);
  9916. if (300 <= stat && stat < 400) {
  9917. this->status = stat;
  9918. } else {
  9919. this->status = StatusCode::Found_302;
  9920. }
  9921. }
  9922. }
  9923. inline void Response::set_content(const char *s, size_t n,
  9924. const std::string &content_type) {
  9925. body.assign(s, n);
  9926. auto rng = headers.equal_range("Content-Type");
  9927. headers.erase(rng.first, rng.second);
  9928. set_header("Content-Type", content_type);
  9929. content_coding_ = detail::EncodingType::None;
  9930. }
  9931. inline void Response::set_content(const std::string &s,
  9932. const std::string &content_type) {
  9933. set_content(s.data(), s.size(), content_type);
  9934. }
  9935. inline void Response::set_content(std::string &&s,
  9936. const std::string &content_type) {
  9937. body = std::move(s);
  9938. auto rng = headers.equal_range("Content-Type");
  9939. headers.erase(rng.first, rng.second);
  9940. set_header("Content-Type", content_type);
  9941. content_coding_ = detail::EncodingType::None;
  9942. }
  9943. inline void Response::set_content_provider(
  9944. size_t in_length, const std::string &content_type, ContentProvider provider,
  9945. ContentProviderResourceReleaser resource_releaser) {
  9946. set_header("Content-Type", content_type);
  9947. content_length_ = in_length;
  9948. if (in_length > 0) { content_provider_ = std::move(provider); }
  9949. content_provider_resource_releaser_ = std::move(resource_releaser);
  9950. is_chunked_content_provider_ = false;
  9951. is_file_content_provider_ = false;
  9952. content_coding_ = detail::EncodingType::None;
  9953. }
  9954. inline void Response::set_content_provider(
  9955. const std::string &content_type, ContentProviderWithoutLength provider,
  9956. ContentProviderResourceReleaser resource_releaser) {
  9957. set_header("Content-Type", content_type);
  9958. content_length_ = 0;
  9959. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9960. content_provider_resource_releaser_ = std::move(resource_releaser);
  9961. is_chunked_content_provider_ = false;
  9962. is_file_content_provider_ = false;
  9963. content_coding_ = detail::EncodingType::None;
  9964. }
  9965. inline void Response::set_chunked_content_provider(
  9966. const std::string &content_type, ContentProviderWithoutLength provider,
  9967. ContentProviderResourceReleaser resource_releaser) {
  9968. set_header("Content-Type", content_type);
  9969. content_length_ = 0;
  9970. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9971. content_provider_resource_releaser_ = std::move(resource_releaser);
  9972. is_chunked_content_provider_ = true;
  9973. is_file_content_provider_ = false;
  9974. content_coding_ = detail::EncodingType::None;
  9975. }
  9976. inline void Response::set_file_content(const std::string &path,
  9977. const std::string &content_type) {
  9978. file_content_path_ = path;
  9979. file_content_content_type_ = content_type;
  9980. }
  9981. inline void Response::set_file_content(const std::string &path) {
  9982. file_content_path_ = path;
  9983. }
  9984. // Result implementation
  9985. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9986. size_t def,
  9987. size_t id) const {
  9988. return detail::get_header_value_u64(request_headers_, key, def, id);
  9989. }
  9990. inline bool Result::has_request_header(const std::string &key) const {
  9991. return request_headers_.find(key) != request_headers_.end();
  9992. }
  9993. inline std::string Result::get_request_header_value(const std::string &key,
  9994. const char *def,
  9995. size_t id) const {
  9996. return detail::get_header_value(request_headers_, key, def, id);
  9997. }
  9998. inline size_t
  9999. Result::get_request_header_value_count(const std::string &key) const {
  10000. return request_headers_.count(key);
  10001. }
  10002. // Stream implementation
  10003. inline ssize_t Stream::write(const char *ptr) {
  10004. return write(ptr, strlen(ptr));
  10005. }
  10006. inline ssize_t Stream::write(const std::string &s) {
  10007. return write(s.data(), s.size());
  10008. }
  10009. // BodyReader implementation
  10010. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10011. if (!stream) {
  10012. last_error = Error::Connection;
  10013. return -1;
  10014. }
  10015. if (eof) { return 0; }
  10016. if (!chunked) {
  10017. // Content-Length based reading
  10018. if (has_content_length && bytes_read >= content_length) {
  10019. eof = true;
  10020. return 0;
  10021. }
  10022. auto to_read = len;
  10023. if (has_content_length) {
  10024. auto remaining = content_length - bytes_read;
  10025. to_read = (std::min)(len, remaining);
  10026. }
  10027. auto n = stream->read(buf, to_read);
  10028. if (n < 0) {
  10029. last_error = stream->get_error();
  10030. if (last_error == Error::Success) { last_error = Error::Read; }
  10031. eof = true;
  10032. return n;
  10033. }
  10034. if (n == 0) {
  10035. // Unexpected EOF before content_length
  10036. last_error = stream->get_error();
  10037. if (last_error == Error::Success) { last_error = Error::Read; }
  10038. eof = true;
  10039. return 0;
  10040. }
  10041. bytes_read += static_cast<size_t>(n);
  10042. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10043. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10044. last_error = Error::ExceedMaxPayloadSize;
  10045. eof = true;
  10046. return -1;
  10047. }
  10048. return n;
  10049. }
  10050. // Chunked transfer encoding: delegate to shared decoder instance.
  10051. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10052. size_t chunk_offset = 0;
  10053. size_t chunk_total = 0;
  10054. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10055. if (n < 0) {
  10056. last_error = stream->get_error();
  10057. if (last_error == Error::Success) { last_error = Error::Read; }
  10058. eof = true;
  10059. return n;
  10060. }
  10061. if (n == 0) {
  10062. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10063. eof = true;
  10064. return 0;
  10065. }
  10066. bytes_read += static_cast<size_t>(n);
  10067. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10068. last_error = Error::ExceedMaxPayloadSize;
  10069. eof = true;
  10070. return -1;
  10071. }
  10072. return n;
  10073. }
  10074. // ThreadPool implementation
  10075. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10076. time_t idle_timeout_sec)
  10077. : base_thread_count_(n), max_queued_requests_(mqr),
  10078. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10079. shutdown_(false) {
  10080. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10081. if (max_n != 0 && max_n < n) {
  10082. std::string msg = "max_threads must be >= base_threads";
  10083. throw std::invalid_argument(msg);
  10084. }
  10085. #endif
  10086. max_thread_count_ = max_n == 0 ? n : max_n;
  10087. threads_.reserve(base_thread_count_);
  10088. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10089. try {
  10090. #endif
  10091. for (size_t i = 0; i < base_thread_count_; i++) {
  10092. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10093. }
  10094. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10095. } catch (...) {
  10096. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10097. // signal the workers we already spawned to exit and join them so the
  10098. // vector destructor does not see joinable threads (which would call
  10099. // std::terminate). Then rethrow so the caller learns of the failure.
  10100. {
  10101. std::unique_lock<std::mutex> lock(mutex_);
  10102. shutdown_ = true;
  10103. }
  10104. cond_.notify_all();
  10105. for (auto &t : threads_) {
  10106. if (t.joinable()) { t.join(); }
  10107. }
  10108. throw;
  10109. }
  10110. #endif
  10111. }
  10112. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10113. {
  10114. std::unique_lock<std::mutex> lock(mutex_);
  10115. if (shutdown_) { return false; }
  10116. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10117. return false;
  10118. }
  10119. jobs_.push_back(std::move(fn));
  10120. // Spawn a dynamic thread if no idle threads and under max
  10121. if (idle_thread_count_ == 0 &&
  10122. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10123. cleanup_finished_threads();
  10124. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10125. }
  10126. }
  10127. cond_.notify_one();
  10128. return true;
  10129. }
  10130. inline void ThreadPool::shutdown() {
  10131. {
  10132. std::unique_lock<std::mutex> lock(mutex_);
  10133. shutdown_ = true;
  10134. }
  10135. cond_.notify_all();
  10136. for (auto &t : threads_) {
  10137. if (t.joinable()) { t.join(); }
  10138. }
  10139. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10140. // with worker threads that call move_to_finished() concurrently.
  10141. std::list<std::thread> remaining_dynamic;
  10142. {
  10143. std::unique_lock<std::mutex> lock(mutex_);
  10144. remaining_dynamic = std::move(dynamic_threads_);
  10145. }
  10146. for (auto &t : remaining_dynamic) {
  10147. if (t.joinable()) { t.join(); }
  10148. }
  10149. std::unique_lock<std::mutex> lock(mutex_);
  10150. cleanup_finished_threads();
  10151. }
  10152. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10153. // Must be called with mutex_ held
  10154. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10155. if (it->get_id() == id) {
  10156. finished_threads_.push_back(std::move(*it));
  10157. dynamic_threads_.erase(it);
  10158. return;
  10159. }
  10160. }
  10161. }
  10162. inline void ThreadPool::cleanup_finished_threads() {
  10163. // Must be called with mutex_ held
  10164. for (auto &t : finished_threads_) {
  10165. if (t.joinable()) { t.join(); }
  10166. }
  10167. finished_threads_.clear();
  10168. }
  10169. inline void ThreadPool::worker(bool is_dynamic) {
  10170. for (;;) {
  10171. std::function<void()> fn;
  10172. {
  10173. std::unique_lock<std::mutex> lock(mutex_);
  10174. idle_thread_count_++;
  10175. if (is_dynamic) {
  10176. auto has_work =
  10177. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10178. [&] { return !jobs_.empty() || shutdown_; });
  10179. if (!has_work) {
  10180. // Timed out with no work - exit this dynamic thread
  10181. idle_thread_count_--;
  10182. move_to_finished(std::this_thread::get_id());
  10183. break;
  10184. }
  10185. } else {
  10186. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10187. }
  10188. idle_thread_count_--;
  10189. if (shutdown_ && jobs_.empty()) { break; }
  10190. fn = std::move(jobs_.front());
  10191. jobs_.pop_front();
  10192. }
  10193. assert(true == static_cast<bool>(fn));
  10194. fn();
  10195. }
  10196. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10197. !defined(LIBRESSL_VERSION_NUMBER)
  10198. OPENSSL_thread_stop();
  10199. #endif
  10200. }
  10201. /*
  10202. * Group 1 (continued): detail namespace - Stream implementations
  10203. */
  10204. namespace detail {
  10205. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10206. time_t timeout_sec, time_t timeout_usec,
  10207. time_t &actual_timeout_sec,
  10208. time_t &actual_timeout_usec) {
  10209. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10210. auto actual_timeout_msec =
  10211. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10212. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10213. actual_timeout_sec = actual_timeout_msec / 1000;
  10214. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10215. }
  10216. // Socket stream implementation
  10217. inline SocketStream::SocketStream(
  10218. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10219. time_t write_timeout_sec, time_t write_timeout_usec,
  10220. time_t max_timeout_msec,
  10221. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10222. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10223. read_timeout_usec_(read_timeout_usec),
  10224. write_timeout_sec_(write_timeout_sec),
  10225. write_timeout_usec_(write_timeout_usec),
  10226. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10227. read_buff_(read_buff_size_, 0) {}
  10228. inline SocketStream::~SocketStream() = default;
  10229. inline bool SocketStream::is_readable() const {
  10230. return read_buff_off_ < read_buff_content_size_;
  10231. }
  10232. inline bool SocketStream::wait_readable() const {
  10233. if (max_timeout_msec_ <= 0) {
  10234. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10235. }
  10236. time_t read_timeout_sec;
  10237. time_t read_timeout_usec;
  10238. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10239. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10240. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10241. }
  10242. inline bool SocketStream::wait_writable() const {
  10243. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10244. }
  10245. inline bool SocketStream::ensure_readable() {
  10246. if (readable_hint_) {
  10247. readable_hint_ = false;
  10248. return true;
  10249. }
  10250. return wait_readable();
  10251. }
  10252. inline const char *SocketStream::buffered_data(size_t &size) const {
  10253. size = read_buff_content_size_ - read_buff_off_;
  10254. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10255. }
  10256. inline void SocketStream::consume_buffered(size_t size) {
  10257. assert(size <= read_buff_content_size_ - read_buff_off_);
  10258. read_buff_off_ += size;
  10259. }
  10260. inline bool SocketStream::is_peer_alive() const {
  10261. return detail::is_socket_alive(sock_);
  10262. }
  10263. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10264. #ifdef _WIN32
  10265. size =
  10266. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10267. #else
  10268. size = (std::min)(size,
  10269. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10270. #endif
  10271. if (read_buff_off_ < read_buff_content_size_) {
  10272. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10273. if (size <= remaining_size) {
  10274. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10275. read_buff_off_ += size;
  10276. return static_cast<ssize_t>(size);
  10277. } else {
  10278. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10279. read_buff_off_ += remaining_size;
  10280. return static_cast<ssize_t>(remaining_size);
  10281. }
  10282. }
  10283. if (!ensure_readable()) {
  10284. error_ = Error::Timeout;
  10285. return -1;
  10286. }
  10287. read_buff_off_ = 0;
  10288. read_buff_content_size_ = 0;
  10289. if (size < read_buff_size_) {
  10290. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10291. CPPHTTPLIB_RECV_FLAGS);
  10292. if (n <= 0) {
  10293. if (n == 0) {
  10294. error_ = Error::ConnectionClosed;
  10295. } else {
  10296. error_ = Error::Read;
  10297. }
  10298. return n;
  10299. } else if (n <= static_cast<ssize_t>(size)) {
  10300. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10301. return n;
  10302. } else {
  10303. memcpy(ptr, read_buff_.data(), size);
  10304. read_buff_off_ = size;
  10305. read_buff_content_size_ = static_cast<size_t>(n);
  10306. return static_cast<ssize_t>(size);
  10307. }
  10308. } else {
  10309. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10310. if (n <= 0) {
  10311. if (n == 0) {
  10312. error_ = Error::ConnectionClosed;
  10313. } else {
  10314. error_ = Error::Read;
  10315. }
  10316. }
  10317. return n;
  10318. }
  10319. }
  10320. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10321. if (!wait_writable()) { return -1; }
  10322. #if defined(_WIN32) && !defined(_WIN64)
  10323. size =
  10324. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10325. #endif
  10326. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10327. }
  10328. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10329. int &port) const {
  10330. return detail::get_remote_ip_and_port(sock_, ip, port);
  10331. }
  10332. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10333. int &port) const {
  10334. return detail::get_local_ip_and_port(sock_, ip, port);
  10335. }
  10336. inline socket_t SocketStream::socket() const { return sock_; }
  10337. inline time_t SocketStream::duration() const {
  10338. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10339. std::chrono::steady_clock::now() - start_time_)
  10340. .count();
  10341. }
  10342. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10343. read_timeout_sec_ = sec;
  10344. read_timeout_usec_ = usec;
  10345. }
  10346. // Buffer stream implementation
  10347. inline bool BufferStream::is_readable() const { return true; }
  10348. inline bool BufferStream::wait_readable() const { return true; }
  10349. inline bool BufferStream::wait_writable() const { return true; }
  10350. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10351. #if defined(_MSC_VER) && _MSC_VER < 1910
  10352. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10353. #else
  10354. auto len_read = buffer.copy(ptr, size, position);
  10355. #endif
  10356. position += static_cast<size_t>(len_read);
  10357. return static_cast<ssize_t>(len_read);
  10358. }
  10359. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10360. buffer.append(ptr, size);
  10361. return static_cast<ssize_t>(size);
  10362. }
  10363. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10364. int & /*port*/) const {}
  10365. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10366. int & /*port*/) const {}
  10367. inline socket_t BufferStream::socket() const { return 0; }
  10368. inline time_t BufferStream::duration() const { return 0; }
  10369. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10370. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10371. : MatcherBase(pattern) {
  10372. constexpr const char marker[] = "/:";
  10373. // One past the last ending position of a path param substring
  10374. std::size_t last_param_end = 0;
  10375. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10376. // Needed to ensure that parameter names are unique during matcher
  10377. // construction
  10378. // If exceptions are disabled, only last duplicate path
  10379. // parameter will be set
  10380. std::unordered_set<std::string> param_name_set;
  10381. #endif
  10382. while (true) {
  10383. const auto marker_pos = pattern.find(
  10384. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10385. if (marker_pos == std::string::npos) { break; }
  10386. static_fragments_.push_back(
  10387. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10388. const auto param_name_start = marker_pos + str_len(marker);
  10389. auto sep_pos = pattern.find(separator, param_name_start);
  10390. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10391. auto param_name =
  10392. pattern.substr(param_name_start, sep_pos - param_name_start);
  10393. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10394. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10395. std::string msg = "Encountered path parameter '" + param_name +
  10396. "' multiple times in route pattern '" + pattern + "'.";
  10397. throw std::invalid_argument(msg);
  10398. }
  10399. #endif
  10400. param_names_.push_back(std::move(param_name));
  10401. last_param_end = sep_pos + 1;
  10402. }
  10403. if (last_param_end < pattern.length()) {
  10404. static_fragments_.push_back(pattern.substr(last_param_end));
  10405. }
  10406. }
  10407. inline bool PathParamsMatcher::match(Request &request) const {
  10408. request.matches = std::smatch();
  10409. request.path_params.clear();
  10410. // A pattern without parameters is just a literal path to compare against
  10411. if (param_names_.empty()) { return request.path == pattern(); }
  10412. request.path_params.reserve(param_names_.size());
  10413. // One past the position at which the path matched the pattern last time
  10414. std::size_t starting_pos = 0;
  10415. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10416. const auto &fragment = static_fragments_[i];
  10417. if (starting_pos + fragment.length() > request.path.length()) {
  10418. return false;
  10419. }
  10420. // Avoid unnecessary allocation by using strncmp instead of substr +
  10421. // comparison
  10422. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10423. fragment.length()) != 0) {
  10424. return false;
  10425. }
  10426. starting_pos += fragment.length();
  10427. // Should only happen when we have a static fragment after a param
  10428. // Example: '/users/:id/subscriptions'
  10429. // The 'subscriptions' fragment here does not have a corresponding param
  10430. if (i >= param_names_.size()) { continue; }
  10431. auto sep_pos = request.path.find(separator, starting_pos);
  10432. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10433. const auto &param_name = param_names_[i];
  10434. request.path_params.emplace(
  10435. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10436. // Mark everything up to '/' as matched
  10437. starting_pos = sep_pos + 1;
  10438. }
  10439. // Returns false if the path is longer than the pattern
  10440. return starting_pos >= request.path.length();
  10441. }
  10442. inline bool RegexMatcher::match(Request &request) const {
  10443. request.path_params.clear();
  10444. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10445. // a non-match rather than risking a stack overflow in std::regex_match.
  10446. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10447. return false;
  10448. }
  10449. return std::regex_match(request.path, request.matches, regex_);
  10450. }
  10451. // Enclose IPv6 address in brackets if needed
  10452. inline std::string prepare_host_string(const std::string &host) {
  10453. // Enclose IPv6 address in brackets (but not if already enclosed)
  10454. if (host.find(':') == std::string::npos ||
  10455. (!host.empty() && host[0] == '[')) {
  10456. // IPv4, hostname, or already bracketed IPv6
  10457. return host;
  10458. } else {
  10459. // IPv6 address without brackets
  10460. return "[" + host + "]";
  10461. }
  10462. }
  10463. inline std::string make_host_and_port_string(const std::string &host, int port,
  10464. bool is_ssl) {
  10465. auto result = prepare_host_string(host);
  10466. // Append port if not default
  10467. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10468. ; // do nothing
  10469. } else {
  10470. result += ":" + std::to_string(port);
  10471. }
  10472. return result;
  10473. }
  10474. // Create "host:port" string always including port number (for CONNECT method)
  10475. inline std::string
  10476. make_host_and_port_string_always_port(const std::string &host, int port) {
  10477. return prepare_host_string(host) + ":" + std::to_string(port);
  10478. }
  10479. // Value for the Host header a client sends when the caller supplied none.
  10480. // Only the value: callers decide where in their header list it goes.
  10481. inline std::string make_default_host_header_value(const std::string &host,
  10482. int port, bool is_ssl,
  10483. int address_family) {
  10484. if (address_family == AF_UNIX) { return "localhost"; }
  10485. return make_host_and_port_string(host, port, is_ssl);
  10486. }
  10487. inline void add_default_user_agent_header(Request &req) {
  10488. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10489. if (!req.has_header("User-Agent")) {
  10490. req.set_header("User-Agent",
  10491. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10492. }
  10493. #else
  10494. (void)req;
  10495. #endif
  10496. }
  10497. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10498. NormalizedTarget normalize_target(const std::string &host);
  10499. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10500. bool host_matches_no_proxy(const NormalizedTarget &target,
  10501. const std::vector<NoProxyEntry> &entries);
  10502. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10503. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10504. if (prefix_bits == 0) { return true; }
  10505. int full_bytes = prefix_bits / 8;
  10506. int rem_bits = prefix_bits % 8;
  10507. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10508. static_cast<size_t>(full_bytes)) != 0) {
  10509. return false;
  10510. }
  10511. if (rem_bits == 0) { return true; }
  10512. auto i = static_cast<size_t>(full_bytes);
  10513. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10514. return (ip[i] & mask) == (net[i] & mask);
  10515. }
  10516. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10517. if (token.empty()) { return false; }
  10518. if (token == "*") {
  10519. out.kind = NoProxyKind::Wildcard;
  10520. return true;
  10521. }
  10522. auto slash = token.find('/');
  10523. std::string addr_part =
  10524. (slash == std::string::npos) ? token : token.substr(0, slash);
  10525. std::string prefix_part =
  10526. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10527. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10528. // don't silently treat it as a /32 (or /128).
  10529. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10530. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10531. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10532. // when brackets are present.
  10533. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10534. addr_part.back() == ']';
  10535. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10536. if (!bracketed) {
  10537. struct in_addr v4;
  10538. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10539. int prefix = 32;
  10540. if (!prefix_part.empty() &&
  10541. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10542. prefix)) {
  10543. return false;
  10544. }
  10545. out.kind = NoProxyKind::IPv4Cidr;
  10546. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10547. out.prefix_bits = prefix;
  10548. return true;
  10549. }
  10550. }
  10551. struct in6_addr v6;
  10552. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10553. int prefix = 128;
  10554. if (!prefix_part.empty() &&
  10555. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10556. prefix)) {
  10557. return false;
  10558. }
  10559. out.kind = NoProxyKind::IPv6Cidr;
  10560. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10561. out.prefix_bits = prefix;
  10562. return true;
  10563. }
  10564. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10565. // the entry is malformed — don't fall through to the hostname branch.
  10566. if (bracketed) { return false; }
  10567. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10568. if (slash != std::string::npos) { return false; }
  10569. // Port-specific entries (host:port) are not supported.
  10570. if (token.find(':') != std::string::npos) { return false; }
  10571. std::string hostname = case_ignore::to_lower(token);
  10572. while (!hostname.empty() && hostname.front() == '.') {
  10573. hostname.erase(hostname.begin());
  10574. }
  10575. while (!hostname.empty() && hostname.back() == '.') {
  10576. hostname.pop_back();
  10577. }
  10578. if (hostname.empty()) { return false; }
  10579. out.kind = NoProxyKind::HostnameSuffix;
  10580. out.hostname_pattern = std::move(hostname);
  10581. return true;
  10582. }
  10583. inline NormalizedTarget normalize_target(const std::string &host) {
  10584. NormalizedTarget t;
  10585. std::string h = host;
  10586. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10587. h = h.substr(1, h.size() - 2);
  10588. }
  10589. // Strip a single trailing dot so "example.com." canonicalizes to
  10590. // "example.com".
  10591. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10592. t.hostname = case_ignore::to_lower(h);
  10593. if (!t.hostname.empty()) {
  10594. struct in_addr v4;
  10595. struct in6_addr v6;
  10596. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10597. t.is_ipv4 = true;
  10598. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10599. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10600. t.is_ipv6 = true;
  10601. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10602. }
  10603. }
  10604. return t;
  10605. }
  10606. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10607. const std::vector<NoProxyEntry> &entries) {
  10608. if (target.hostname.empty()) { return false; }
  10609. for (const auto &e : entries) {
  10610. switch (e.kind) {
  10611. case NoProxyKind::Wildcard: return true;
  10612. case NoProxyKind::IPv4Cidr:
  10613. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10614. return true;
  10615. }
  10616. break;
  10617. case NoProxyKind::IPv6Cidr:
  10618. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10619. return true;
  10620. }
  10621. break;
  10622. case NoProxyKind::HostnameSuffix:
  10623. if (target.is_ipv4 || target.is_ipv6) { break; }
  10624. if (target.hostname == e.hostname_pattern) { return true; }
  10625. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10626. // an entry of "example.com".
  10627. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10628. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10629. if (target.hostname[offset - 1] == '.' &&
  10630. target.hostname.compare(offset, e.hostname_pattern.size(),
  10631. e.hostname_pattern) == 0) {
  10632. return true;
  10633. }
  10634. }
  10635. break;
  10636. }
  10637. }
  10638. return false;
  10639. }
  10640. template <typename T>
  10641. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10642. T header_writer, Error &error) {
  10643. for (const auto &h : headers) {
  10644. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10645. error = Error::InvalidHeaders;
  10646. return false;
  10647. }
  10648. }
  10649. if (header_writer(strm, headers) <= 0) {
  10650. error = Error::Write;
  10651. return false;
  10652. }
  10653. return true;
  10654. }
  10655. } // namespace detail
  10656. /*
  10657. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10658. */
  10659. #ifdef CPPHTTPLIB_SSL_ENABLED
  10660. namespace detail {
  10661. // SSL socket stream implementation
  10662. inline SSLSocketStream::SSLSocketStream(
  10663. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10664. time_t read_timeout_usec, time_t write_timeout_sec,
  10665. time_t write_timeout_usec, time_t max_timeout_msec,
  10666. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10667. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10668. read_timeout_usec_(read_timeout_usec),
  10669. write_timeout_sec_(write_timeout_sec),
  10670. write_timeout_usec_(write_timeout_usec),
  10671. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10672. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10673. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10674. // Note: create_session() also clears this, but SSLClient currently
  10675. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10676. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10677. // SSL session was created.
  10678. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10679. #endif
  10680. }
  10681. inline SSLSocketStream::~SSLSocketStream() = default;
  10682. inline bool SSLSocketStream::is_readable() const {
  10683. return tls::pending(session_) > 0;
  10684. }
  10685. inline bool SSLSocketStream::wait_readable() const {
  10686. if (max_timeout_msec_ <= 0) {
  10687. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10688. }
  10689. time_t read_timeout_sec;
  10690. time_t read_timeout_usec;
  10691. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10692. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10693. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10694. }
  10695. inline bool SSLSocketStream::wait_writable() const {
  10696. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10697. !tls::is_peer_closed(session_, sock_);
  10698. }
  10699. inline bool SSLSocketStream::ensure_readable() {
  10700. if (readable_hint_) {
  10701. readable_hint_ = false;
  10702. return true;
  10703. }
  10704. return wait_readable();
  10705. }
  10706. inline bool SSLSocketStream::is_peer_alive() const {
  10707. return !tls::is_peer_closed(session_, sock_);
  10708. }
  10709. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10710. if (tls::pending(session_) > 0) {
  10711. tls::TlsError err;
  10712. auto ret = tls::read(session_, ptr, size, err);
  10713. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10714. error_ = Error::ConnectionClosed;
  10715. }
  10716. return ret;
  10717. } else if (ensure_readable()) {
  10718. tls::TlsError err;
  10719. auto ret = tls::read(session_, ptr, size, err);
  10720. if (ret < 0) {
  10721. auto n = 1000;
  10722. #ifdef _WIN32
  10723. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10724. (err.code == tls::ErrorCode::SyscallError &&
  10725. WSAGetLastError() == WSAETIMEDOUT))) {
  10726. #else
  10727. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10728. #endif
  10729. if (tls::pending(session_) > 0) {
  10730. return tls::read(session_, ptr, size, err);
  10731. } else if (wait_readable()) {
  10732. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10733. ret = tls::read(session_, ptr, size, err);
  10734. if (ret >= 0) { return ret; }
  10735. } else {
  10736. break;
  10737. }
  10738. }
  10739. assert(ret < 0);
  10740. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10741. error_ = Error::ConnectionClosed;
  10742. }
  10743. return ret;
  10744. } else {
  10745. error_ = Error::Timeout;
  10746. return -1;
  10747. }
  10748. }
  10749. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10750. if (wait_writable()) {
  10751. auto handle_size =
  10752. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10753. tls::TlsError err;
  10754. auto ret = tls::write(session_, ptr, handle_size, err);
  10755. if (ret < 0) {
  10756. auto n = 1000;
  10757. #ifdef _WIN32
  10758. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10759. (err.code == tls::ErrorCode::SyscallError &&
  10760. WSAGetLastError() == WSAETIMEDOUT))) {
  10761. #else
  10762. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10763. #endif
  10764. if (wait_writable()) {
  10765. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10766. ret = tls::write(session_, ptr, handle_size, err);
  10767. if (ret >= 0) { return ret; }
  10768. } else {
  10769. break;
  10770. }
  10771. }
  10772. assert(ret < 0);
  10773. }
  10774. return ret;
  10775. }
  10776. return -1;
  10777. }
  10778. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10779. int &port) const {
  10780. detail::get_remote_ip_and_port(sock_, ip, port);
  10781. }
  10782. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10783. int &port) const {
  10784. detail::get_local_ip_and_port(sock_, ip, port);
  10785. }
  10786. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10787. inline time_t SSLSocketStream::duration() const {
  10788. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10789. std::chrono::steady_clock::now() - start_time_)
  10790. .count();
  10791. }
  10792. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10793. read_timeout_sec_ = sec;
  10794. read_timeout_usec_ = usec;
  10795. }
  10796. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10797. tls::session_t session,
  10798. time_t read_timeout_sec,
  10799. time_t read_timeout_usec,
  10800. time_t write_timeout_sec,
  10801. time_t write_timeout_usec)
  10802. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10803. read_timeout_usec_(read_timeout_usec),
  10804. write_timeout_sec_(write_timeout_sec),
  10805. write_timeout_usec_(write_timeout_usec),
  10806. start_time_(std::chrono::steady_clock::now()) {
  10807. // The receive and send paths run on different threads, so each TLS call is
  10808. // driven in non-blocking mode and readiness is awaited with select()
  10809. // outside the session lock. Set the socket non-blocking once here; it is
  10810. // never flipped back, so no thread races on the flag.
  10811. detail::set_nonblocking(sock_, true);
  10812. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10813. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10814. #endif
  10815. }
  10816. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10817. inline bool WebSocketSSLStream::is_readable() const {
  10818. std::lock_guard<std::mutex> guard(session_mutex_);
  10819. return tls::pending(session_) > 0;
  10820. }
  10821. inline bool WebSocketSSLStream::wait_readable() const {
  10822. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10823. }
  10824. inline bool WebSocketSSLStream::wait_writable() const {
  10825. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10826. // that probe toggles the socket's blocking flag, which would race with the
  10827. // concurrent reader on a permanently non-blocking socket.
  10828. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10829. }
  10830. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10831. tls::TlsError err;
  10832. auto n = 1000;
  10833. while (--n >= 0) {
  10834. {
  10835. std::lock_guard<std::mutex> guard(session_mutex_);
  10836. auto ret = tls::read(session_, ptr, size, err);
  10837. if (ret > 0) { return ret; }
  10838. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10839. error_ = Error::ConnectionClosed;
  10840. return ret;
  10841. }
  10842. }
  10843. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10844. // direction: the send path shares this session, so output it left pending
  10845. // has to be flushed before more input can be decrypted. Anything else is
  10846. // a hard error.
  10847. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10848. #ifdef _WIN32
  10849. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10850. needs_readable =
  10851. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10852. WSAGetLastError() == WSAETIMEDOUT);
  10853. #endif
  10854. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10855. error_ = Error::Read;
  10856. return -1;
  10857. }
  10858. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10859. error_ = Error::Timeout;
  10860. return -1;
  10861. }
  10862. }
  10863. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10864. // to tell a timeout from a close would otherwise see whatever the previous
  10865. // failure left behind (error_ is never cleared on success).
  10866. error_ = Error::Read;
  10867. return -1;
  10868. }
  10869. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10870. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10871. tls::TlsError err;
  10872. auto n = 1000;
  10873. while (--n >= 0) {
  10874. {
  10875. std::lock_guard<std::mutex> guard(session_mutex_);
  10876. auto ret = tls::write(session_, ptr, handle_size, err);
  10877. if (ret >= 0) { return ret; }
  10878. }
  10879. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10880. // or a post-handshake message must be consumed before the record goes
  10881. // out. Anything else is a hard error.
  10882. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10883. #ifdef _WIN32
  10884. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10885. needs_writable =
  10886. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10887. WSAGetLastError() == WSAETIMEDOUT);
  10888. #endif
  10889. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10890. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10891. }
  10892. return -1;
  10893. }
  10894. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10895. int &port) const {
  10896. detail::get_remote_ip_and_port(sock_, ip, port);
  10897. }
  10898. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10899. int &port) const {
  10900. detail::get_local_ip_and_port(sock_, ip, port);
  10901. }
  10902. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10903. inline time_t WebSocketSSLStream::duration() const {
  10904. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10905. std::chrono::steady_clock::now() - start_time_)
  10906. .count();
  10907. }
  10908. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10909. read_timeout_sec_ = sec;
  10910. read_timeout_usec_ = usec;
  10911. }
  10912. } // namespace detail
  10913. #endif // CPPHTTPLIB_SSL_ENABLED
  10914. /*
  10915. * Group 4: Server implementation
  10916. */
  10917. // HTTP server implementation
  10918. inline Server::Server()
  10919. : new_task_queue([] {
  10920. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10921. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10922. }) {
  10923. #ifndef _WIN32
  10924. signal(SIGPIPE, SIG_IGN);
  10925. #endif
  10926. }
  10927. inline Server::~Server() = default;
  10928. inline std::unique_ptr<detail::MatcherBase>
  10929. Server::make_matcher(const std::string &pattern) {
  10930. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10931. // a path params pattern
  10932. if (pattern.find("/:") != std::string::npos) {
  10933. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10934. }
  10935. // A pattern with no regex metacharacter only has to be compared literally,
  10936. // which is what PathParamsMatcher already does when it captures no
  10937. // parameter, so std::regex is only worth building for the patterns that
  10938. // actually need it
  10939. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10940. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10941. }
  10942. return detail::make_unique<detail::RegexMatcher>(pattern);
  10943. }
  10944. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10945. return add_handler(get_handlers_, pattern, std::move(handler));
  10946. }
  10947. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10948. return add_handler(post_handlers_, pattern, std::move(handler));
  10949. }
  10950. inline Server &Server::Post(const std::string &pattern,
  10951. HandlerWithContentReader handler) {
  10952. return add_handler(post_handlers_for_content_reader_, pattern,
  10953. std::move(handler));
  10954. }
  10955. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10956. return add_handler(put_handlers_, pattern, std::move(handler));
  10957. }
  10958. inline Server &Server::Put(const std::string &pattern,
  10959. HandlerWithContentReader handler) {
  10960. return add_handler(put_handlers_for_content_reader_, pattern,
  10961. std::move(handler));
  10962. }
  10963. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10964. return add_handler(patch_handlers_, pattern, std::move(handler));
  10965. }
  10966. inline Server &Server::Patch(const std::string &pattern,
  10967. HandlerWithContentReader handler) {
  10968. return add_handler(patch_handlers_for_content_reader_, pattern,
  10969. std::move(handler));
  10970. }
  10971. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10972. return add_handler(delete_handlers_, pattern, std::move(handler));
  10973. }
  10974. inline Server &Server::Delete(const std::string &pattern,
  10975. HandlerWithContentReader handler) {
  10976. return add_handler(delete_handlers_for_content_reader_, pattern,
  10977. std::move(handler));
  10978. }
  10979. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10980. return add_handler(options_handlers_, pattern, std::move(handler));
  10981. }
  10982. inline const std::set<std::string> &Server::builtin_methods() {
  10983. thread_local const std::set<std::string> methods{
  10984. "GET", "HEAD", "POST", "PUT", "DELETE",
  10985. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10986. return methods;
  10987. }
  10988. inline Server::CustomHandlerEntry *
  10989. Server::custom_entry_for_registration(const std::string &method) {
  10990. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10991. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10992. // routing() before the custom tables are consulted, so a route registered
  10993. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10994. // there and would be reachable, but they carry protocol-level meaning
  10995. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10996. // library does not route.
  10997. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10998. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10999. has_invalid_registration_ = true;
  11000. return nullptr;
  11001. }
  11002. return &custom_handlers_[method];
  11003. }
  11004. inline Server &Server::CustomRoute(const std::string &method,
  11005. const std::string &pattern,
  11006. Handler handler) {
  11007. auto *entry = custom_entry_for_registration(method);
  11008. if (!entry) { return *this; }
  11009. return add_handler(entry->handlers, pattern, std::move(handler));
  11010. }
  11011. inline Server &Server::CustomRoute(const std::string &method,
  11012. const std::string &pattern,
  11013. HandlerWithContentReader handler) {
  11014. auto *entry = custom_entry_for_registration(method);
  11015. if (!entry) { return *this; }
  11016. return add_handler(entry->handlers_for_content_reader, pattern,
  11017. std::move(handler));
  11018. }
  11019. inline const Server::CustomHandlerEntry *
  11020. Server::find_custom_entry(const std::string &method) const {
  11021. // find() alone would be correct here. The empty() check is what keeps the
  11022. // per-request cost off servers that never call CustomRoute(), which is the
  11023. // overwhelmingly common case; keep it rather than walking into the tree.
  11024. if (custom_handlers_.empty()) { return nullptr; }
  11025. auto it = custom_handlers_.find(method);
  11026. return it == custom_handlers_.end() ? nullptr : &it->second;
  11027. }
  11028. inline Server &Server::WebSocket(const std::string &pattern,
  11029. WebSocketHandler handler) {
  11030. websocket_handlers_.push_back(
  11031. {make_matcher(pattern), std::move(handler), nullptr});
  11032. return *this;
  11033. }
  11034. inline Server &Server::WebSocket(const std::string &pattern,
  11035. WebSocketHandler handler,
  11036. SubProtocolSelector sub_protocol_selector) {
  11037. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11038. std::move(sub_protocol_selector)});
  11039. return *this;
  11040. }
  11041. inline bool Server::set_base_dir(const std::string &dir,
  11042. const std::string &mount_point) {
  11043. return set_mount_point(mount_point, dir);
  11044. }
  11045. inline bool Server::set_mount_point(const std::string &mount_point,
  11046. const std::string &dir, Headers headers) {
  11047. detail::FileStat stat(dir);
  11048. if (stat.is_dir()) {
  11049. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11050. if (!mnt.empty() && mnt[0] == '/') {
  11051. std::string resolved_base;
  11052. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11053. #if defined(_WIN32)
  11054. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11055. resolved_base += '\\';
  11056. }
  11057. #else
  11058. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11059. #endif
  11060. }
  11061. base_dirs_.push_back(
  11062. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11063. return true;
  11064. }
  11065. }
  11066. return false;
  11067. }
  11068. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11069. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11070. if (it->mount_point == mount_point) {
  11071. base_dirs_.erase(it);
  11072. return true;
  11073. }
  11074. }
  11075. return false;
  11076. }
  11077. inline Server &
  11078. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11079. const std::string &mime) {
  11080. file_extension_and_mimetype_map_[ext] = mime;
  11081. return *this;
  11082. }
  11083. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11084. default_file_mimetype_ = mime;
  11085. return *this;
  11086. }
  11087. inline Server &Server::set_file_request_handler(Handler handler) {
  11088. file_request_handler_ = std::move(handler);
  11089. return *this;
  11090. }
  11091. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11092. std::true_type) {
  11093. error_handler_ = std::move(handler);
  11094. return *this;
  11095. }
  11096. inline Server &Server::set_error_handler_core(Handler handler,
  11097. std::false_type) {
  11098. error_handler_ = [handler](const Request &req, Response &res) {
  11099. handler(req, res);
  11100. return HandlerResponse::Handled;
  11101. };
  11102. return *this;
  11103. }
  11104. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11105. exception_handler_ = std::move(handler);
  11106. return *this;
  11107. }
  11108. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11109. pre_routing_handler_ = std::move(handler);
  11110. return *this;
  11111. }
  11112. inline Server &Server::set_post_routing_handler(Handler handler) {
  11113. post_routing_handler_ = std::move(handler);
  11114. return *this;
  11115. }
  11116. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11117. pre_request_handler_ = std::move(handler);
  11118. return *this;
  11119. }
  11120. inline Server &Server::set_logger(Logger logger) {
  11121. logger_ = std::move(logger);
  11122. return *this;
  11123. }
  11124. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11125. error_logger_ = std::move(error_logger);
  11126. return *this;
  11127. }
  11128. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11129. pre_compression_logger_ = std::move(logger);
  11130. return *this;
  11131. }
  11132. inline Server &
  11133. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11134. expect_100_continue_handler_ = std::move(handler);
  11135. return *this;
  11136. }
  11137. inline Server &Server::set_start_handler(StartHandler handler) {
  11138. start_handler_ = std::move(handler);
  11139. return *this;
  11140. }
  11141. inline Server &Server::set_address_family(int family) {
  11142. address_family_ = family;
  11143. return *this;
  11144. }
  11145. inline Server &Server::set_tcp_nodelay(bool on) {
  11146. tcp_nodelay_ = on;
  11147. return *this;
  11148. }
  11149. inline Server &Server::set_ipv6_v6only(bool on) {
  11150. ipv6_v6only_ = on;
  11151. return *this;
  11152. }
  11153. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11154. socket_options_ = std::move(socket_options);
  11155. return *this;
  11156. }
  11157. inline Server &Server::set_default_headers(Headers headers) {
  11158. default_headers_ = std::move(headers);
  11159. return *this;
  11160. }
  11161. inline Server &Server::set_header_writer(
  11162. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11163. header_writer_ = writer;
  11164. return *this;
  11165. }
  11166. inline Server &
  11167. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11168. trusted_proxies_ = proxies;
  11169. return *this;
  11170. }
  11171. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11172. keep_alive_max_count_ = count;
  11173. return *this;
  11174. }
  11175. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11176. keep_alive_timeout_sec_ = sec;
  11177. return *this;
  11178. }
  11179. template <class Rep, class Period>
  11180. inline Server &Server::set_keep_alive_timeout(
  11181. const std::chrono::duration<Rep, Period> &duration) {
  11182. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11183. set_keep_alive_timeout(sec);
  11184. });
  11185. return *this;
  11186. }
  11187. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11188. read_timeout_sec_ = sec;
  11189. read_timeout_usec_ = usec;
  11190. return *this;
  11191. }
  11192. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11193. write_timeout_sec_ = sec;
  11194. write_timeout_usec_ = usec;
  11195. return *this;
  11196. }
  11197. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11198. idle_interval_sec_ = sec;
  11199. idle_interval_usec_ = usec;
  11200. return *this;
  11201. }
  11202. inline Server &Server::set_payload_max_length(size_t length) {
  11203. payload_max_length_ = length;
  11204. return *this;
  11205. }
  11206. inline Server &Server::set_static_file_compression(bool on) {
  11207. static_file_compression_ = on;
  11208. return *this;
  11209. }
  11210. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11211. static_file_compression_min_length_ = length;
  11212. return *this;
  11213. }
  11214. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11215. static_file_compression_max_length_ = length;
  11216. return *this;
  11217. }
  11218. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11219. websocket_max_missed_pongs_ = count;
  11220. return *this;
  11221. }
  11222. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11223. websocket_ping_interval_sec_ = sec;
  11224. return *this;
  11225. }
  11226. template <class Rep, class Period>
  11227. inline Server &Server::set_websocket_ping_interval(
  11228. const std::chrono::duration<Rep, Period> &duration) {
  11229. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11230. set_websocket_ping_interval(sec);
  11231. });
  11232. return *this;
  11233. }
  11234. inline bool Server::bind_to_port(const std::string &host, int port,
  11235. int socket_flags) {
  11236. auto ret = bind_internal(host, port, socket_flags);
  11237. if (ret == -1) { is_decommissioned = true; }
  11238. return ret >= 0;
  11239. }
  11240. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11241. auto ret = bind_internal(host, 0, socket_flags);
  11242. if (ret == -1) { is_decommissioned = true; }
  11243. return ret;
  11244. }
  11245. inline bool Server::listen_after_bind() { return listen_internal(); }
  11246. inline bool Server::listen(const std::string &host, int port,
  11247. int socket_flags) {
  11248. return bind_to_port(host, port, socket_flags) && listen_internal();
  11249. }
  11250. inline bool Server::is_running() const { return is_running_; }
  11251. inline void Server::wait_until_ready() const {
  11252. while (!is_running_ && !is_decommissioned) {
  11253. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11254. }
  11255. }
  11256. inline void Server::stop() noexcept {
  11257. // Release the listening socket whether or not the accept loop is running:
  11258. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11259. // exchange is what makes this safe to call concurrently with the accept loop.
  11260. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11261. if (sock != INVALID_SOCKET) {
  11262. detail::shutdown_socket(sock);
  11263. detail::close_socket(sock);
  11264. }
  11265. is_decommissioned = false;
  11266. }
  11267. inline void Server::decommission() { is_decommissioned = true; }
  11268. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11269. auto len = strlen(s);
  11270. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11271. len -= 2;
  11272. {
  11273. size_t count = 0;
  11274. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11275. switch (count) {
  11276. case 0: req.method = std::string(b, e); break;
  11277. case 1: req.target = std::string(b, e); break;
  11278. case 2: req.version = std::string(b, e); break;
  11279. default: break;
  11280. }
  11281. count++;
  11282. });
  11283. if (count != 3) { return false; }
  11284. }
  11285. // A method outside the built-in set is accepted only when a handler has been
  11286. // registered for it with CustomRoute().
  11287. const auto &methods = builtin_methods();
  11288. if (methods.find(req.method) == methods.end() &&
  11289. !find_custom_entry(req.method)) {
  11290. output_error_log(Error::InvalidHTTPMethod, &req);
  11291. return false;
  11292. }
  11293. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11294. output_error_log(Error::InvalidHTTPVersion, &req);
  11295. return false;
  11296. }
  11297. if (!detail::fields::is_request_target(req.target)) { return false; }
  11298. {
  11299. // Skip URL fragment
  11300. for (size_t i = 0; i < req.target.size(); i++) {
  11301. if (req.target[i] == '#') {
  11302. req.target.erase(i);
  11303. break;
  11304. }
  11305. }
  11306. detail::divide(req.target, '?',
  11307. [&](const char *lhs_data, std::size_t lhs_size,
  11308. const char *rhs_data, std::size_t rhs_size) {
  11309. req.path =
  11310. decode_path_component(std::string(lhs_data, lhs_size));
  11311. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11312. });
  11313. }
  11314. return true;
  11315. }
  11316. inline bool Server::write_response(Stream &strm, bool close_connection,
  11317. Request &req, Response &res) {
  11318. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11319. // incorrectly to the error content.
  11320. req.ranges.clear();
  11321. return write_response_core(strm, close_connection, req, res, false);
  11322. }
  11323. inline bool Server::write_response_with_content(Stream &strm,
  11324. bool close_connection,
  11325. const Request &req,
  11326. Response &res) {
  11327. return write_response_core(strm, close_connection, req, res, true);
  11328. }
  11329. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11330. const Request &req, Response &res,
  11331. bool need_apply_ranges) {
  11332. assert(res.status != -1);
  11333. if (400 <= res.status && error_handler_ &&
  11334. error_handler_(req, res) == HandlerResponse::Handled) {
  11335. need_apply_ranges = true;
  11336. }
  11337. std::string content_type;
  11338. std::string boundary;
  11339. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11340. // Prepare additional headers
  11341. if (close_connection ||
  11342. detail::has_header_token(req.headers, "Connection", "close") ||
  11343. 400 <= res.status || // Don't leave connections open after errors
  11344. // The client withholds the body until `100 Continue`, which was never
  11345. // sent, so whether and when the body follows is unknown.
  11346. (req.expect_100_continue_pending_ && detail::has_framed_body(req))) {
  11347. res.set_header("Connection", "close");
  11348. } else {
  11349. std::string s = "timeout=";
  11350. s += std::to_string(keep_alive_timeout_sec_);
  11351. s += ", max=";
  11352. s += std::to_string(keep_alive_max_count_);
  11353. res.set_header("Keep-Alive", s);
  11354. }
  11355. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11356. !res.has_header("Content-Type")) {
  11357. res.set_header("Content-Type", "text/plain");
  11358. }
  11359. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11360. !res.has_header("Content-Length")) {
  11361. res.set_header("Content-Length", "0");
  11362. }
  11363. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11364. res.set_header("Accept-Ranges", "bytes");
  11365. }
  11366. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11367. // Response line and headers
  11368. detail::BufferStream bstrm;
  11369. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11370. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11371. // Combine a small body with the headers so the whole response leaves in a
  11372. // single write. A large body is written on its own instead: a copy of it
  11373. // costs more than the extra write saves.
  11374. auto send_body = req.method != "HEAD";
  11375. auto body_is_separate = false;
  11376. auto provider_done = false;
  11377. if (send_body && !res.body.empty() && !res.content_provider_) {
  11378. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11379. bstrm.write(res.body.data(), res.body.size());
  11380. } else {
  11381. body_is_separate = true;
  11382. }
  11383. } else if (send_body && res.content_provider_ &&
  11384. res.is_file_content_provider_ &&
  11385. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11386. // A small file is read into the same buffer. Other providers may produce
  11387. // their data over time, so they are never held back.
  11388. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11389. return false;
  11390. }
  11391. provider_done = true;
  11392. }
  11393. // Log before writing to avoid race condition with client-side code that
  11394. // accesses logger-captured data immediately after receiving the response.
  11395. output_log(req, res);
  11396. // Flush buffer
  11397. auto &data = bstrm.get_buffer();
  11398. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11399. if (body_is_separate) {
  11400. return detail::write_data(strm, res.body.data(), res.body.size());
  11401. }
  11402. // Streaming body
  11403. if (send_body && res.content_provider_) {
  11404. if (!provider_done &&
  11405. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11406. return false;
  11407. }
  11408. res.content_provider_success_ = true;
  11409. }
  11410. return true;
  11411. }
  11412. inline bool
  11413. Server::write_content_with_provider(Stream &strm, const Request &req,
  11414. Response &res, const std::string &boundary,
  11415. const std::string &content_type) {
  11416. auto is_shutting_down = [this]() {
  11417. return this->svr_sock_ == INVALID_SOCKET;
  11418. };
  11419. if (res.content_length_ > 0) {
  11420. // Only a 206 response is served as a partial representation, matching the
  11421. // condition `apply_ranges()` used to decide the Content-Length and the
  11422. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11423. // only for a 2xx status, slicing under any other status would write a body
  11424. // that disagrees with the header already sent, from an unchecked offset.
  11425. auto is_partial =
  11426. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11427. if (!is_partial) {
  11428. return detail::write_content(strm, res.content_provider_, 0,
  11429. res.content_length_, is_shutting_down);
  11430. } else if (req.ranges.size() == 1) {
  11431. auto offset_and_length = detail::get_range_offset_and_length(
  11432. req.ranges[0], res.content_length_);
  11433. return detail::write_content(strm, res.content_provider_,
  11434. offset_and_length.first,
  11435. offset_and_length.second, is_shutting_down);
  11436. } else {
  11437. return detail::write_multipart_ranges_data(
  11438. strm, req, res, boundary, content_type, res.content_length_,
  11439. is_shutting_down);
  11440. }
  11441. } else {
  11442. if (res.is_chunked_content_provider_) {
  11443. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11444. // re-negotiating here would disagree with them, e.g. once a handler's
  11445. // own Content-Encoding header suppresses the negotiation.
  11446. auto compressor = detail::make_compressor(res.content_coding_);
  11447. if (!compressor) {
  11448. compressor = detail::make_unique<detail::nocompressor>();
  11449. }
  11450. return detail::write_content_chunked(strm, res.content_provider_,
  11451. is_shutting_down, *compressor);
  11452. } else {
  11453. return detail::write_content_without_length(strm, res.content_provider_,
  11454. is_shutting_down);
  11455. }
  11456. }
  11457. }
  11458. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11459. FormFields::iterator cur_field;
  11460. FormFiles::iterator cur_file;
  11461. auto is_text_field = false;
  11462. size_t count = 0;
  11463. if (read_content_core(
  11464. strm, req, res,
  11465. // Regular
  11466. [&](const char *buf, size_t n) {
  11467. // Prevent arithmetic overflow when checking sizes.
  11468. // Avoid computing (req.body.size() + n) directly because
  11469. // adding two unsigned `size_t` values can wrap around and
  11470. // produce a small result instead of indicating overflow.
  11471. // Instead, check using subtraction: ensure `n` does not
  11472. // exceed the remaining capacity `max_size() - size()`.
  11473. if (req.body.size() >= req.body.max_size() ||
  11474. n > req.body.max_size() - req.body.size()) {
  11475. return false;
  11476. }
  11477. // Limit decompressed body size to payload_max_length_ to protect
  11478. // against "zip bomb" attacks where a small compressed payload
  11479. // decompresses to a massive size.
  11480. if (payload_max_length_ > 0 &&
  11481. (req.body.size() >= payload_max_length_ ||
  11482. n > payload_max_length_ - req.body.size())) {
  11483. return false;
  11484. }
  11485. req.body.append(buf, n);
  11486. return true;
  11487. },
  11488. // Multipart FormData
  11489. [&](const FormData &file) {
  11490. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11491. output_error_log(Error::TooManyFormDataFiles, &req);
  11492. return false;
  11493. }
  11494. if (file.filename.empty()) {
  11495. cur_field = req.form.fields.emplace(
  11496. file.name, FormField{file.name, file.content, file.headers});
  11497. is_text_field = true;
  11498. } else {
  11499. cur_file = req.form.files.emplace(file.name, file);
  11500. is_text_field = false;
  11501. }
  11502. return true;
  11503. },
  11504. [&](const char *buf, size_t n) {
  11505. if (is_text_field) {
  11506. auto &content = cur_field->second.content;
  11507. if (content.size() + n > content.max_size()) { return false; }
  11508. content.append(buf, n);
  11509. } else {
  11510. auto &content = cur_file->second.content;
  11511. if (content.size() + n > content.max_size()) { return false; }
  11512. content.append(buf, n);
  11513. }
  11514. return true;
  11515. })) {
  11516. const auto &content_type = req.get_header_value("Content-Type");
  11517. if (detail::extract_media_type(content_type) ==
  11518. "application/x-www-form-urlencoded") {
  11519. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11520. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11521. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11522. return false;
  11523. }
  11524. detail::parse_query_text(req.body, req.params);
  11525. }
  11526. return true;
  11527. }
  11528. return false;
  11529. }
  11530. inline bool Server::read_content_with_content_receiver(
  11531. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11532. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11533. return read_content_core(strm, req, res, std::move(receiver),
  11534. std::move(multipart_header),
  11535. std::move(multipart_receiver));
  11536. }
  11537. inline bool Server::read_content_core(
  11538. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11539. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11540. detail::FormDataParser multipart_form_data_parser;
  11541. ContentReceiverWithProgress out;
  11542. if (req.is_multipart_form_data()) {
  11543. const auto &content_type = req.get_header_value("Content-Type");
  11544. std::string boundary;
  11545. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11546. res.status = StatusCode::BadRequest_400;
  11547. output_error_log(Error::MultipartParsing, &req);
  11548. return false;
  11549. }
  11550. multipart_form_data_parser.set_boundary(std::move(boundary));
  11551. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11552. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11553. multipart_receiver);
  11554. };
  11555. } else {
  11556. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11557. size_t /*len*/) { return receiver(buf, n); };
  11558. }
  11559. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11560. // For non-SSL builds we still scan non-persistent connections for stray
  11561. // body bytes so the payload limit is enforced (413). On keep-alive,
  11562. // pending bytes may be the next request (issue #2450), so skip.
  11563. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11564. if (!req.has_header("Content-Length") &&
  11565. !detail::is_chunked_transfer_encoding(req.headers)) {
  11566. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11567. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11568. auto has_data = strm.is_readable();
  11569. if (!has_data) {
  11570. auto s = strm.socket();
  11571. if (s != INVALID_SOCKET) {
  11572. has_data = detail::select_read(s, 0, 0) > 0;
  11573. }
  11574. }
  11575. if (has_data) {
  11576. // Route through the same decompressing reader used by the
  11577. // length-framed and chunked paths below, so payload_max_length_ is
  11578. // enforced on the decompressed size here too instead of only on the
  11579. // compressed wire bytes.
  11580. return detail::read_content(strm, req, payload_max_length_, res.status,
  11581. nullptr, out, true);
  11582. }
  11583. }
  11584. return true;
  11585. }
  11586. #else
  11587. if (!req.has_header("Content-Length") &&
  11588. !detail::is_chunked_transfer_encoding(req.headers)) {
  11589. return true;
  11590. }
  11591. #endif
  11592. // The client is waiting for this before it sends the body.
  11593. if (req.expect_100_continue_pending_) {
  11594. req.expect_100_continue_pending_ = false;
  11595. detail::write_response_line(strm, StatusCode::Continue_100);
  11596. strm.write("\r\n");
  11597. }
  11598. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11599. out, true)) {
  11600. return false;
  11601. }
  11602. req.body_consumed_ = true;
  11603. if (req.is_multipart_form_data()) {
  11604. if (!multipart_form_data_parser.is_valid()) {
  11605. res.status = StatusCode::BadRequest_400;
  11606. output_error_log(Error::MultipartParsing, &req);
  11607. return false;
  11608. }
  11609. }
  11610. return true;
  11611. }
  11612. inline bool Server::handle_file_request(Request &req, Response &res) {
  11613. for (const auto &entry : base_dirs_) {
  11614. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11615. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11616. // One that already ends in '/' (the root mount among them) carries its own
  11617. // boundary; set_mount_point() guarantees the mount point is not empty.
  11618. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11619. (entry.mount_point.back() == '/' ||
  11620. req.path.size() == entry.mount_point.size() ||
  11621. req.path[entry.mount_point.size()] == '/')) {
  11622. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11623. if (detail::is_valid_path(sub_path)) {
  11624. auto path = entry.base_dir + sub_path;
  11625. if (path.back() == '/') { path += "index.html"; }
  11626. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11627. // but symlinks/junctions can still escape the base directory.
  11628. if (!entry.resolved_base_dir.empty()) {
  11629. std::string resolved_path;
  11630. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11631. !detail::is_path_within_base(resolved_path,
  11632. entry.resolved_base_dir)) {
  11633. res.status = StatusCode::Forbidden_403;
  11634. return true;
  11635. }
  11636. }
  11637. detail::FileStat stat(path);
  11638. if (stat.is_dir()) {
  11639. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11640. return true;
  11641. }
  11642. if (stat.is_file()) {
  11643. for (const auto &kv : entry.headers) {
  11644. res.set_header(kv.first, kv.second);
  11645. }
  11646. auto content_type_of = [&]() {
  11647. return detail::find_content_type(
  11648. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11649. };
  11650. // Only the ETag needs the content type this early, and only to name
  11651. // the coding. Deciding it here would otherwise put a regex in front
  11652. // of the 304 below, which serving a file never used to pay for.
  11653. std::string content_type;
  11654. auto encoding = detail::EncodingType::None;
  11655. if (static_file_compression_) {
  11656. content_type = content_type_of();
  11657. encoding =
  11658. static_file_encoding(req, res, content_type, stat.size());
  11659. }
  11660. // The ETag names the representation actually sent, so a client that
  11661. // cached the compressed form revalidates against the compressed ETag
  11662. // and still gets a 304, while one that took identity keeps the plain
  11663. // ETag.
  11664. auto etag = detail::compute_etag(
  11665. stat, encoding == detail::EncodingType::None
  11666. ? std::string()
  11667. : std::string("-") + detail::encoding_name(encoding));
  11668. if (!etag.empty()) { res.set_header("ETag", etag); }
  11669. auto mtime = stat.mtime();
  11670. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11671. if (!last_modified.empty()) {
  11672. res.set_header("Last-Modified", last_modified);
  11673. }
  11674. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11675. check_if_range(req, etag, mtime);
  11676. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11677. if (!mm->is_open()) {
  11678. output_error_log(Error::OpenFile, &req);
  11679. return false;
  11680. }
  11681. if (!static_file_compression_) { content_type = content_type_of(); }
  11682. detail::set_file_content_provider(res, mm, content_type, encoding);
  11683. if (req.method != "HEAD" && file_request_handler_) {
  11684. file_request_handler_(req, res);
  11685. }
  11686. return true;
  11687. } else {
  11688. output_error_log(Error::OpenFile, &req);
  11689. }
  11690. }
  11691. }
  11692. }
  11693. return false;
  11694. }
  11695. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11696. const std::string &etag,
  11697. time_t mtime) const {
  11698. // Handle conditional GET:
  11699. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11700. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11701. if (req.has_header("If-None-Match")) {
  11702. if (!etag.empty()) {
  11703. auto val =
  11704. detail::get_combined_header_value(req.headers, "If-None-Match");
  11705. // NOTE: We use exact string matching here. This works correctly
  11706. // because our server always generates weak ETags (W/"..."), and
  11707. // clients typically send back the same ETag they received.
  11708. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11709. // If-None-Match, where W/"x" and "x" would match, but this
  11710. // simplified implementation requires exact matches.
  11711. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11712. [&](const char *b, const char *e) {
  11713. auto seg_len = static_cast<size_t>(e - b);
  11714. return (seg_len == 1 && *b == '*') ||
  11715. (seg_len == etag.size() &&
  11716. std::equal(b, e, etag.begin()));
  11717. });
  11718. if (ret) {
  11719. res.status = StatusCode::NotModified_304;
  11720. return true;
  11721. }
  11722. }
  11723. } else if (req.has_header("If-Modified-Since")) {
  11724. auto val = req.get_header_value("If-Modified-Since");
  11725. auto t = detail::parse_http_date(val);
  11726. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11727. res.status = StatusCode::NotModified_304;
  11728. return true;
  11729. }
  11730. }
  11731. return false;
  11732. }
  11733. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11734. time_t mtime) const {
  11735. // Handle If-Range for partial content requests (RFC 9110
  11736. // Section 13.1.5). If-Range is only evaluated when Range header is
  11737. // present. If the validator matches, serve partial content; otherwise
  11738. // serve full content.
  11739. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11740. auto val = req.get_header_value("If-Range");
  11741. auto is_valid_range = [&]() {
  11742. if (detail::is_strong_etag(val)) {
  11743. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11744. // comparison.
  11745. return (!etag.empty() && val == etag);
  11746. } else if (detail::is_weak_etag(val)) {
  11747. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11748. return false;
  11749. } else {
  11750. // HTTP-date comparison
  11751. auto t = detail::parse_http_date(val);
  11752. return (t != static_cast<time_t>(-1) && mtime <= t);
  11753. }
  11754. };
  11755. if (!is_valid_range()) {
  11756. // Validator doesn't match: ignore Range and serve full content
  11757. req.ranges.clear();
  11758. return false;
  11759. }
  11760. }
  11761. return true;
  11762. }
  11763. inline socket_t
  11764. Server::create_server_socket(const std::string &host, int port,
  11765. int socket_flags,
  11766. SocketOptions socket_options) const {
  11767. return detail::create_socket(
  11768. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11769. ipv6_v6only_, std::move(socket_options),
  11770. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11771. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11772. output_error_log(Error::BindIPAddress, nullptr);
  11773. return false;
  11774. }
  11775. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11776. output_error_log(Error::Listen, nullptr);
  11777. return false;
  11778. }
  11779. return true;
  11780. });
  11781. }
  11782. inline int Server::bind_internal(const std::string &host, int port,
  11783. int socket_flags) {
  11784. if (is_decommissioned) { return -1; }
  11785. if (!is_valid()) { return -1; }
  11786. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11787. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11788. if (port == 0) {
  11789. struct sockaddr_storage addr;
  11790. socklen_t addr_len = sizeof(addr);
  11791. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11792. &addr_len) == -1) {
  11793. output_error_log(Error::GetSockName, nullptr);
  11794. return -1;
  11795. }
  11796. if (addr.ss_family == AF_INET) {
  11797. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11798. } else if (addr.ss_family == AF_INET6) {
  11799. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11800. } else {
  11801. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11802. return -1;
  11803. }
  11804. } else {
  11805. return port;
  11806. }
  11807. }
  11808. inline bool Server::listen_internal() {
  11809. // A stop() between bind and listen leaves nothing to accept on. Report
  11810. // failure instead of returning success without ever serving, and mark the
  11811. // server decommissioned the way any failed listen does so that a concurrent
  11812. // wait_until_ready() wakes up instead of spinning forever.
  11813. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11814. is_decommissioned = true;
  11815. return false;
  11816. }
  11817. auto ret = true;
  11818. is_running_ = true;
  11819. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11820. if (start_handler_) { start_handler_(); }
  11821. {
  11822. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11823. while (svr_sock_ != INVALID_SOCKET) {
  11824. #ifndef _WIN32
  11825. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11826. #endif
  11827. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11828. idle_interval_usec_);
  11829. if (val == 0) { // Timeout
  11830. task_queue->on_idle();
  11831. continue;
  11832. }
  11833. #ifndef _WIN32
  11834. }
  11835. #endif
  11836. #if defined _WIN32
  11837. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11838. // OVERLAPPED
  11839. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11840. #elif defined SOCK_CLOEXEC
  11841. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11842. #else
  11843. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11844. #endif
  11845. if (sock == INVALID_SOCKET) {
  11846. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11847. // touches the CRT errno, so the two have to be asked platform by
  11848. // platform rather than by testing errno here.
  11849. if (detail::is_accept_resource_error()) {
  11850. // The per-process descriptor limit or the network stack's buffer
  11851. // space has been reached. Try to accept new connections after a
  11852. // short sleep.
  11853. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11854. continue;
  11855. } else if (detail::is_accept_transient_error()) {
  11856. continue;
  11857. }
  11858. // Take the descriptor out of svr_sock_ before closing it: a later
  11859. // stop() would otherwise shutdown()/close() a value the OS may have
  11860. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11861. // gone. The exchange also settles the race with a concurrent stop(),
  11862. // since whichever side takes the descriptor closes it exactly once.
  11863. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11864. if (listen_sock != INVALID_SOCKET) {
  11865. detail::close_socket(listen_sock);
  11866. ret = false;
  11867. output_error_log(Error::Connection, nullptr);
  11868. } else {
  11869. ; // The server socket was closed by user.
  11870. }
  11871. break;
  11872. }
  11873. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11874. read_timeout_sec_, read_timeout_usec_);
  11875. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11876. write_timeout_sec_, write_timeout_usec_);
  11877. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11878. if (!task_queue->enqueue(
  11879. [this, sock]() { process_and_close_socket(sock); })) {
  11880. output_error_log(Error::ResourceExhaustion, nullptr);
  11881. detail::shutdown_socket(sock);
  11882. detail::close_socket(sock);
  11883. }
  11884. }
  11885. task_queue->shutdown();
  11886. }
  11887. is_decommissioned = !ret;
  11888. return ret;
  11889. }
  11890. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11891. if (pre_routing_handler_ &&
  11892. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11893. return true;
  11894. }
  11895. // File handler
  11896. if ((req.method == "GET" || req.method == "HEAD") &&
  11897. handle_file_request(req, res)) {
  11898. return true;
  11899. }
  11900. const auto *custom = find_custom_entry(req.method);
  11901. // The second clause mirrors what expect_content() does unconditionally for
  11902. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11903. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11904. // `allprop`) would skip its handler and fall through to 404.
  11905. if (detail::expect_content(req) ||
  11906. (custom && !custom->handlers_for_content_reader.empty())) {
  11907. // Content reader handler
  11908. {
  11909. // Track whether the ContentReader was aborted due to the decompressed
  11910. // payload exceeding `payload_max_length_`.
  11911. // The user handler runs after the lambda returns, so we must restore the
  11912. // 413 status if the handler overwrites it.
  11913. bool content_reader_payload_too_large = false;
  11914. ContentReader reader(
  11915. [&](ContentReceiver receiver) {
  11916. auto result = read_content_with_content_receiver(
  11917. strm, req, res, std::move(receiver), nullptr, nullptr);
  11918. if (!result) {
  11919. output_error_log(Error::Read, &req);
  11920. if (res.status == StatusCode::PayloadTooLarge_413) {
  11921. content_reader_payload_too_large = true;
  11922. }
  11923. }
  11924. return result;
  11925. },
  11926. [&](FormDataHeader header, ContentReceiver receiver) {
  11927. auto result = read_content_with_content_receiver(
  11928. strm, req, res, nullptr, std::move(header),
  11929. std::move(receiver));
  11930. if (!result) {
  11931. output_error_log(Error::Read, &req);
  11932. if (res.status == StatusCode::PayloadTooLarge_413) {
  11933. content_reader_payload_too_large = true;
  11934. }
  11935. }
  11936. return result;
  11937. });
  11938. bool dispatched = false;
  11939. if (req.method == "POST") {
  11940. dispatched = dispatch_request_for_content_reader(
  11941. req, res, std::move(reader), post_handlers_for_content_reader_);
  11942. } else if (req.method == "PUT") {
  11943. dispatched = dispatch_request_for_content_reader(
  11944. req, res, std::move(reader), put_handlers_for_content_reader_);
  11945. } else if (req.method == "PATCH") {
  11946. dispatched = dispatch_request_for_content_reader(
  11947. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11948. } else if (req.method == "DELETE") {
  11949. dispatched = dispatch_request_for_content_reader(
  11950. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11951. } else if (custom) {
  11952. dispatched = dispatch_request_for_content_reader(
  11953. req, res, std::move(reader), custom->handlers_for_content_reader);
  11954. }
  11955. if (dispatched) {
  11956. if (content_reader_payload_too_large) {
  11957. // Enforce the limit: override any status the handler may have set
  11958. // and return false so the error path sends a plain 413 response.
  11959. res.status = StatusCode::PayloadTooLarge_413;
  11960. res.body.clear();
  11961. res.content_length_ = 0;
  11962. res.content_provider_ = nullptr;
  11963. return false;
  11964. }
  11965. return true;
  11966. }
  11967. }
  11968. // NOTE: `req.body` is not read here. For a regular handler the body is
  11969. // read inside dispatch_request(), after the route has matched and the
  11970. // pre-request handler has approved the request, so that a rejected
  11971. // request (e.g. failed authentication) never forces us to buffer a
  11972. // potentially large body.
  11973. }
  11974. // Regular handler
  11975. if (req.method == "GET" || req.method == "HEAD") {
  11976. return dispatch_request(req, res, get_handlers_, strm);
  11977. } else if (req.method == "POST") {
  11978. return dispatch_request(req, res, post_handlers_, strm);
  11979. } else if (req.method == "PUT") {
  11980. return dispatch_request(req, res, put_handlers_, strm);
  11981. } else if (req.method == "DELETE") {
  11982. return dispatch_request(req, res, delete_handlers_, strm);
  11983. } else if (req.method == "OPTIONS") {
  11984. return dispatch_request(req, res, options_handlers_, strm);
  11985. } else if (req.method == "PATCH") {
  11986. return dispatch_request(req, res, patch_handlers_, strm);
  11987. } else if (custom) {
  11988. return dispatch_request(req, res, custom->handlers, strm);
  11989. }
  11990. res.status = StatusCode::BadRequest_400;
  11991. return false;
  11992. }
  11993. inline bool Server::dispatch_request(Request &req, Response &res,
  11994. const Handlers &handlers, Stream &strm) {
  11995. for (const auto &x : handlers) {
  11996. const auto &matcher = x.first;
  11997. const auto &handler = x.second;
  11998. if (matcher->match(req)) {
  11999. req.matched_route = matcher->pattern();
  12000. // Run the pre-request handler before reading the body so a rejected
  12001. // request (e.g. failed authentication) never forces us to buffer a
  12002. // potentially large body. `req.matched_route` is available here.
  12003. if (pre_request_handler_ &&
  12004. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12005. return true;
  12006. }
  12007. // The route matched and the request was approved; read the body now.
  12008. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12009. output_error_log(Error::Read, &req);
  12010. return false;
  12011. }
  12012. handler(req, res);
  12013. return true;
  12014. }
  12015. }
  12016. return false;
  12017. }
  12018. // Decides the content coding for a response served straight from a file. Both
  12019. // the ETag, which has to name the representation actually sent, and
  12020. // `apply_static_file_compression()` go through this, so the two cannot drift
  12021. // apart.
  12022. inline detail::EncodingType
  12023. Server::static_file_encoding(const Request &req, const Response &res,
  12024. const std::string &content_type,
  12025. size_t length) const {
  12026. if (!static_file_compression_) { return detail::EncodingType::None; }
  12027. // Nothing to compress, and an empty file already answers with
  12028. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12029. // turn an empty body into a 20-byte gzip stream.
  12030. if (length == 0) { return detail::EncodingType::None; }
  12031. // A file that already fits in a single packet gains nothing from being made
  12032. // smaller, since it still travels in that one segment, and a file of a few
  12033. // bytes comes out larger than it went in.
  12034. if (length < static_file_compression_min_length_) {
  12035. return detail::EncodingType::None;
  12036. }
  12037. // RFC 9110 applies Range to the representation after content coding, so a
  12038. // compressed 206 would mean compressing the whole file and then slicing it.
  12039. // Serve ranges from the identity representation instead.
  12040. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12041. if (static_file_compression_max_length_ > 0 &&
  12042. length > static_file_compression_max_length_) {
  12043. return detail::EncodingType::None;
  12044. }
  12045. return detail::encoding_type(req, res, content_type);
  12046. }
  12047. // Compresses a file-backed content provider into `res.body` and takes over the
  12048. // framing headers. Returns false when the response is left untouched.
  12049. inline bool Server::apply_static_file_compression(const Request &req,
  12050. Response &res) const {
  12051. auto type = res.content_coding_;
  12052. if (type == detail::EncodingType::None || !res.content_provider_) {
  12053. return false;
  12054. }
  12055. auto compressor = detail::make_compressor(type);
  12056. if (!compressor) { return false; }
  12057. output_pre_compression_log(req, res);
  12058. std::string compressed;
  12059. if (!detail::compress_content_provider(res.content_provider_,
  12060. res.content_length_, *compressor,
  12061. compressed)) {
  12062. return false;
  12063. }
  12064. res.body.swap(compressed);
  12065. // The provider was consumed in full, so a resource releaser registered with
  12066. // it should hear about a success when the response goes away.
  12067. res.content_provider_success_ = true;
  12068. res.content_provider_ = nullptr;
  12069. res.content_length_ = 0;
  12070. res.content_coding_ = detail::EncodingType::None;
  12071. res.set_header("Content-Encoding", detail::encoding_name(type));
  12072. res.set_header("Vary", "Accept-Encoding");
  12073. res.set_header("Content-Length", std::to_string(res.body.size()));
  12074. return true;
  12075. }
  12076. inline void Server::apply_ranges(const Request &req, Response &res,
  12077. std::string &content_type,
  12078. std::string &boundary) const {
  12079. // A known-length content provider leaves `res.body` empty, so the compressor
  12080. // at the end of this function never runs for one (issue #2545). A file-backed
  12081. // provider is fully readable right here, so compress it and answer with an
  12082. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12083. // takes the same path as `set_content()` from here on. Range requests never
  12084. // get a content coding, so `Content-Range` still names identity bytes and
  12085. // none of the framing below applies.
  12086. if (apply_static_file_compression(req, res)) { return; }
  12087. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12088. auto it = res.headers.find("Content-Type");
  12089. if (it != res.headers.end()) {
  12090. content_type = it->second;
  12091. res.headers.erase(it);
  12092. }
  12093. boundary = detail::make_multipart_data_boundary();
  12094. res.set_header("Content-Type",
  12095. "multipart/byteranges; boundary=" + boundary);
  12096. }
  12097. auto type = detail::encoding_type(req, res);
  12098. if (res.body.empty()) {
  12099. if (res.content_length_ > 0) {
  12100. size_t length = 0;
  12101. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12102. length = res.content_length_;
  12103. } else if (req.ranges.size() == 1) {
  12104. auto offset_and_length = detail::get_range_offset_and_length(
  12105. req.ranges[0], res.content_length_);
  12106. length = offset_and_length.second;
  12107. auto content_range = detail::make_content_range_header_field(
  12108. offset_and_length, res.content_length_);
  12109. res.set_header("Content-Range", content_range);
  12110. } else {
  12111. length = detail::get_multipart_ranges_data_length(
  12112. req, boundary, content_type, res.content_length_);
  12113. }
  12114. res.set_header("Content-Length", std::to_string(length));
  12115. } else {
  12116. if (res.content_provider_) {
  12117. if (res.is_chunked_content_provider_) {
  12118. res.set_header("Transfer-Encoding", "chunked");
  12119. res.content_coding_ = type;
  12120. if (type != detail::EncodingType::None) {
  12121. res.set_header("Content-Encoding", detail::encoding_name(type));
  12122. res.set_header("Vary", "Accept-Encoding");
  12123. }
  12124. }
  12125. }
  12126. }
  12127. } else {
  12128. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12129. ;
  12130. } else if (req.ranges.size() == 1) {
  12131. auto offset_and_length =
  12132. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12133. auto offset = offset_and_length.first;
  12134. auto length = offset_and_length.second;
  12135. auto content_range = detail::make_content_range_header_field(
  12136. offset_and_length, res.body.size());
  12137. res.set_header("Content-Range", content_range);
  12138. assert(offset + length <= res.body.size());
  12139. res.body = res.body.substr(offset, length);
  12140. } else {
  12141. std::string data;
  12142. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12143. res.body.size(), data);
  12144. res.body.swap(data);
  12145. }
  12146. if (type != detail::EncodingType::None) {
  12147. output_pre_compression_log(req, res);
  12148. if (auto compressor = detail::make_compressor(type)) {
  12149. std::string compressed;
  12150. if (compressor->compress(res.body.data(), res.body.size(), true,
  12151. [&](const char *data, size_t data_len) {
  12152. compressed.append(data, data_len);
  12153. return true;
  12154. })) {
  12155. res.body.swap(compressed);
  12156. res.set_header("Content-Encoding", detail::encoding_name(type));
  12157. res.set_header("Vary", "Accept-Encoding");
  12158. }
  12159. }
  12160. }
  12161. res.content_length_ = res.body.size();
  12162. res.set_header("Content-Length", std::to_string(res.content_length_));
  12163. }
  12164. }
  12165. inline bool Server::dispatch_request_for_content_reader(
  12166. Request &req, Response &res, ContentReader content_reader,
  12167. const HandlersForContentReader &handlers) const {
  12168. for (const auto &x : handlers) {
  12169. const auto &matcher = x.first;
  12170. const auto &handler = x.second;
  12171. if (matcher->match(req)) {
  12172. req.matched_route = matcher->pattern();
  12173. if (!pre_request_handler_ ||
  12174. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12175. handler(req, res, content_reader);
  12176. }
  12177. return true;
  12178. }
  12179. }
  12180. return false;
  12181. }
  12182. inline std::string
  12183. get_client_ip(const std::string &x_forwarded_for,
  12184. const std::vector<std::string> &trusted_proxies) {
  12185. // X-Forwarded-For is a comma-separated list per RFC 7239
  12186. std::vector<std::string> ip_list;
  12187. detail::split(x_forwarded_for.data(),
  12188. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12189. [&](const char *b, const char *e) {
  12190. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12191. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12192. });
  12193. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12194. // no segments. Signal "no client IP derived" with an empty string so the
  12195. // caller can fall back to the connection-level remote address.
  12196. if (ip_list.empty()) { return std::string(); }
  12197. // Each hop appends the address it received the request from, so the rightmost
  12198. // entries are the ones written by our own infrastructure while the leftmost
  12199. // are whatever the original client chose to send. Walk from the right and
  12200. // skip trusted proxies; the first address that is not a trusted proxy is the
  12201. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12202. // from the left instead lets a client forge an arbitrary address by following
  12203. // it with a trusted proxy's address, which the left-to-right scan then
  12204. // returned as the client.
  12205. for (size_t i = ip_list.size(); i-- > 0;) {
  12206. const auto &ip = ip_list[i];
  12207. auto is_trusted_proxy =
  12208. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12209. [&](const std::string &proxy) { return ip == proxy; });
  12210. if (!is_trusted_proxy) { return ip; }
  12211. }
  12212. // Every hop was a trusted proxy; fall back to the first entry.
  12213. return ip_list.front();
  12214. }
  12215. inline bool
  12216. Server::process_request(Stream &strm, const std::string &remote_addr,
  12217. int remote_port, const std::string &local_addr,
  12218. int local_port, bool close_connection,
  12219. bool &connection_closed,
  12220. const std::function<void(Request &)> &setup_request,
  12221. bool *websocket_upgraded) {
  12222. std::array<char, 2048> buf{};
  12223. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12224. // Connection has been closed on client
  12225. if (!line_reader.getline()) { return false; }
  12226. Request req;
  12227. req.start_time_ = std::chrono::steady_clock::now();
  12228. req.remote_addr = remote_addr;
  12229. req.remote_port = remote_port;
  12230. req.local_addr = local_addr;
  12231. req.local_port = local_port;
  12232. Response res;
  12233. res.version = "HTTP/1.1";
  12234. res.headers = default_headers_;
  12235. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12236. // close the connection after that response, whichever path wrote it (an
  12237. // error status, a handler, or a rejected request). Reading on would also
  12238. // parse whatever the client sent next on a connection it considers done.
  12239. auto honor_connection_close = detail::scope_exit([&] {
  12240. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12241. connection_closed = true;
  12242. }
  12243. });
  12244. // Request line and headers. A rejected message leaves the rest of it (and
  12245. // any body) unread, so the connection cannot be reused: the leftover bytes
  12246. // would be parsed as the next request.
  12247. if (!parse_request_line(line_reader.ptr(), req)) {
  12248. connection_closed = true;
  12249. res.status = StatusCode::BadRequest_400;
  12250. output_error_log(Error::InvalidRequestLine, &req);
  12251. return write_response(strm, close_connection, req, res);
  12252. }
  12253. // Request headers
  12254. if (!detail::read_headers(strm, req.headers)) {
  12255. connection_closed = true;
  12256. res.status = StatusCode::BadRequest_400;
  12257. output_error_log(Error::InvalidHeaders, &req);
  12258. return write_response(strm, close_connection, req, res);
  12259. }
  12260. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12261. // which would otherwise let an intermediary and this parser disagree on
  12262. // where the body ends and enable request smuggling. Three cases: a
  12263. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12264. // or empty), which would otherwise be read as "no body"; a non-zero
  12265. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12266. // tolerated for compatibility with existing clients); and a
  12267. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12268. // length undeterminable. None of them may fall through to the "no body"
  12269. // path, or the body bytes are parsed as the next request on a persistent
  12270. // connection.
  12271. auto is_invalid_content_length = false;
  12272. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12273. is_invalid_content_length);
  12274. if (is_invalid_content_length ||
  12275. detail::has_conflicting_content_length(req.headers) ||
  12276. (req.has_header("Transfer-Encoding") &&
  12277. !detail::is_chunked_transfer_encoding(req.headers))) {
  12278. connection_closed = true;
  12279. res.status = StatusCode::BadRequest_400;
  12280. return write_response(strm, close_connection, req, res);
  12281. }
  12282. // Check if the request URI doesn't exceed the limit
  12283. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12284. connection_closed = true;
  12285. res.status = StatusCode::UriTooLong_414;
  12286. output_error_log(Error::ExceedUriMaxLength, &req);
  12287. return write_response(strm, close_connection, req, res);
  12288. }
  12289. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12290. connection_closed = true;
  12291. }
  12292. if (req.version == "HTTP/1.0" &&
  12293. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12294. connection_closed = true;
  12295. }
  12296. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12297. // itself a trusted proxy. Otherwise any direct client could spoof
  12298. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12299. auto is_trusted_peer = std::any_of(
  12300. trusted_proxies_.begin(), trusted_proxies_.end(),
  12301. [&](const std::string &proxy) { return proxy == remote_addr; });
  12302. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12303. // Some proxies append the address they observed as a separate
  12304. // X-Forwarded-For field line instead of extending the one the client sent
  12305. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12306. // be scanned. Reading only the first occurrence would hand back the
  12307. // client-supplied, and therefore forgeable, value.
  12308. auto x_forwarded_for =
  12309. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12310. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12311. req.remote_addr = derived.empty() ? remote_addr : derived;
  12312. } else {
  12313. req.remote_addr = remote_addr;
  12314. }
  12315. req.remote_port = remote_port;
  12316. req.local_addr = local_addr;
  12317. req.local_port = local_port;
  12318. if (req.has_header("Accept")) {
  12319. auto accept_header =
  12320. detail::get_combined_header_value(req.headers, "Accept");
  12321. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12322. connection_closed = true;
  12323. res.status = StatusCode::BadRequest_400;
  12324. output_error_log(Error::HTTPParsing, &req);
  12325. return write_response(strm, close_connection, req, res);
  12326. }
  12327. }
  12328. if (req.has_header("Range")) {
  12329. const auto &range_header_value = req.get_header_value("Range");
  12330. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12331. connection_closed = true;
  12332. res.status = StatusCode::RangeNotSatisfiable_416;
  12333. output_error_log(Error::InvalidRangeHeader, &req);
  12334. return write_response(strm, close_connection, req, res);
  12335. }
  12336. }
  12337. if (setup_request) { setup_request(req); }
  12338. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12339. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12340. // must be ignored. An expectation we do not recognize is left alone; the
  12341. // 417 the section allows for one is a MAY, not a requirement.
  12342. //
  12343. // `100 Continue` itself is deferred until the body is actually read (see
  12344. // read_content_core), so a request rejected by a later handler never
  12345. // invites the client to send a body nobody will read.
  12346. if (req.version != "HTTP/1.0" &&
  12347. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12348. int status = StatusCode::Continue_100;
  12349. if (expect_100_continue_handler_) {
  12350. status = expect_100_continue_handler_(req, res);
  12351. }
  12352. if (status == StatusCode::Continue_100) {
  12353. req.expect_100_continue_pending_ = true;
  12354. } else {
  12355. if (res.status == -1) { res.status = status; }
  12356. connection_closed = true;
  12357. return write_response(strm, true, req, res);
  12358. }
  12359. }
  12360. // Setup `is_connection_closed` method
  12361. auto sock = strm.socket();
  12362. req.is_connection_closed = [sock]() {
  12363. return !detail::is_socket_alive(sock);
  12364. };
  12365. // WebSocket upgrade
  12366. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12367. // that authentication and other middleware can reject the request with an
  12368. // HTTP response (e.g., 401) before the protocol switches.
  12369. if (detail::is_websocket_upgrade(req)) {
  12370. if (pre_routing_handler_ &&
  12371. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12372. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12373. return write_response_with_content(strm, close_connection, req, res);
  12374. }
  12375. // Find matching WebSocket handler
  12376. for (const auto &entry : websocket_handlers_) {
  12377. if (entry.matcher->match(req)) {
  12378. req.matched_route = entry.matcher->pattern();
  12379. if (pre_request_handler_ &&
  12380. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12381. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12382. return write_response_with_content(strm, close_connection, req, res);
  12383. }
  12384. // Compute accept key
  12385. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12386. auto accept_key = detail::websocket_accept_key(client_key);
  12387. // Negotiate subprotocol
  12388. std::string selected_subprotocol;
  12389. if (entry.sub_protocol_selector) {
  12390. auto protocol_header = detail::get_combined_header_value(
  12391. req.headers, "Sec-WebSocket-Protocol");
  12392. if (!protocol_header.empty()) {
  12393. std::vector<std::string> protocols;
  12394. detail::split(protocol_header.data(),
  12395. protocol_header.data() + protocol_header.size(), ',',
  12396. [&](const char *b, const char *e) {
  12397. protocols.emplace_back(b, e);
  12398. });
  12399. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12400. }
  12401. }
  12402. // Send 101 Switching Protocols
  12403. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12404. "Upgrade: websocket\r\n"
  12405. "Connection: Upgrade\r\n"
  12406. "Sec-WebSocket-Accept: " +
  12407. accept_key + "\r\n";
  12408. if (!selected_subprotocol.empty()) {
  12409. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12410. return false;
  12411. }
  12412. handshake_response +=
  12413. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12414. }
  12415. handshake_response += "\r\n";
  12416. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12417. 0) {
  12418. return false;
  12419. }
  12420. connection_closed = true;
  12421. if (websocket_upgraded) { *websocket_upgraded = true; }
  12422. {
  12423. #ifdef CPPHTTPLIB_SSL_ENABLED
  12424. if (req.ssl) {
  12425. // wss: the heartbeat ping thread and the read path enter the same
  12426. // TLS session from different threads. Hand the WebSocket a stream
  12427. // that serializes every TLS call, so the shared SSLSocketStream on
  12428. // the plain HTTP/HTTPS paths stays untouched.
  12429. auto ws_strm =
  12430. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12431. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12432. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12433. write_timeout_sec_, write_timeout_usec_));
  12434. ws::WebSocket ws(std::move(ws_strm), req, true,
  12435. websocket_ping_interval_sec_,
  12436. websocket_max_missed_pongs_);
  12437. entry.handler(req, ws);
  12438. return true;
  12439. }
  12440. #endif
  12441. // Use WebSocket-specific read timeout instead of HTTP timeout
  12442. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12443. 0);
  12444. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12445. websocket_max_missed_pongs_);
  12446. entry.handler(req, ws);
  12447. }
  12448. return true;
  12449. }
  12450. }
  12451. // No matching handler - fall through to 404
  12452. }
  12453. // Routing
  12454. auto routed = false;
  12455. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12456. routed = routing(req, res, strm);
  12457. #else
  12458. try {
  12459. routed = routing(req, res, strm);
  12460. } catch (std::exception &) {
  12461. if (exception_handler_) {
  12462. auto ep = std::current_exception();
  12463. exception_handler_(req, res, ep);
  12464. routed = true;
  12465. } else {
  12466. res.status = StatusCode::InternalServerError_500;
  12467. }
  12468. } catch (...) {
  12469. if (exception_handler_) {
  12470. auto ep = std::current_exception();
  12471. exception_handler_(req, res, ep);
  12472. routed = true;
  12473. } else {
  12474. res.status = StatusCode::InternalServerError_500;
  12475. }
  12476. }
  12477. #endif
  12478. auto ret = false;
  12479. if (routed) {
  12480. if (res.status == -1) {
  12481. res.status = req.ranges.empty() ? StatusCode::OK_200
  12482. : StatusCode::PartialContent_206;
  12483. }
  12484. // Serve file content by using a content provider
  12485. auto file_open_error = false;
  12486. if (!res.file_content_path_.empty()) {
  12487. const auto &path = res.file_content_path_;
  12488. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12489. if (!mm->is_open()) {
  12490. res.body.clear();
  12491. res.content_length_ = 0;
  12492. res.content_provider_ = nullptr;
  12493. res.status = StatusCode::NotFound_404;
  12494. output_error_log(Error::OpenFile, &req);
  12495. file_open_error = true;
  12496. } else {
  12497. auto content_type = res.file_content_content_type_;
  12498. if (content_type.empty()) {
  12499. content_type = detail::find_content_type(
  12500. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12501. }
  12502. detail::set_file_content_provider(
  12503. res, mm, content_type,
  12504. static_file_encoding(req, res, content_type, mm->size()));
  12505. }
  12506. }
  12507. if (file_open_error) {
  12508. ret = write_response(strm, close_connection, req, res);
  12509. } else if (detail::range_error(req, res)) {
  12510. res.body.clear();
  12511. res.content_length_ = 0;
  12512. res.content_provider_ = nullptr;
  12513. res.status = StatusCode::RangeNotSatisfiable_416;
  12514. ret = write_response(strm, close_connection, req, res);
  12515. } else {
  12516. ret = write_response_with_content(strm, close_connection, req, res);
  12517. }
  12518. } else {
  12519. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12520. ret = write_response(strm, close_connection, req, res);
  12521. }
  12522. // Drain any unconsumed framed body to prevent request smuggling on
  12523. // keep-alive. Without framing there is no body to drain — reading would
  12524. // consume the next request (issue #2450). If the response has committed the
  12525. // connection to close, there is no next request to protect.
  12526. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12527. !detail::has_header_token(res.headers, "Connection", "close")) {
  12528. int dummy_status;
  12529. if (!detail::read_content(
  12530. strm, req, payload_max_length_, dummy_status, nullptr,
  12531. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12532. connection_closed = true;
  12533. }
  12534. }
  12535. return ret;
  12536. }
  12537. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12538. inline bool Server::process_and_close_socket(socket_t sock) {
  12539. std::string remote_addr;
  12540. int remote_port = 0;
  12541. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12542. std::string local_addr;
  12543. int local_port = 0;
  12544. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12545. bool websocket_upgraded = false;
  12546. auto ret = serve_guarded([&]() {
  12547. return detail::process_server_socket(
  12548. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12549. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12550. write_timeout_usec_,
  12551. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12552. return process_request(strm, remote_addr, remote_port, local_addr,
  12553. local_port, close_connection,
  12554. connection_closed, nullptr,
  12555. &websocket_upgraded);
  12556. });
  12557. });
  12558. detail::drain_and_close_socket(sock);
  12559. return ret;
  12560. }
  12561. inline void Server::output_log(const Request &req, const Response &res) const {
  12562. if (logger_) {
  12563. std::lock_guard<std::mutex> guard(logger_mutex_);
  12564. logger_(req, res);
  12565. }
  12566. }
  12567. inline void Server::output_pre_compression_log(const Request &req,
  12568. const Response &res) const {
  12569. if (pre_compression_logger_) {
  12570. std::lock_guard<std::mutex> guard(logger_mutex_);
  12571. pre_compression_logger_(req, res);
  12572. }
  12573. }
  12574. inline void Server::output_error_log(const Error &err,
  12575. const Request *req) const {
  12576. if (error_logger_) {
  12577. std::lock_guard<std::mutex> guard(logger_mutex_);
  12578. error_logger_(err, req);
  12579. }
  12580. }
  12581. /*
  12582. * Group 5: ClientImpl and Client (Universal) implementation
  12583. */
  12584. // HTTP client implementation
  12585. inline ClientImpl::ClientImpl(const std::string &host)
  12586. : ClientImpl(host, 80, std::string(), std::string()) {}
  12587. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12588. : ClientImpl(host, port, std::string(), std::string()) {}
  12589. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12590. const std::string &client_cert_path,
  12591. const std::string &client_key_path)
  12592. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12593. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12594. inline ClientImpl::~ClientImpl() {
  12595. // Wait until all the requests in flight are handled.
  12596. size_t retry_count = 10;
  12597. while (retry_count-- > 0) {
  12598. {
  12599. std::lock_guard<std::mutex> guard(socket_mutex_);
  12600. if (socket_requests_in_flight_ == 0) { break; }
  12601. }
  12602. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12603. }
  12604. std::lock_guard<std::mutex> guard(socket_mutex_);
  12605. shutdown_socket(socket_);
  12606. close_socket(socket_);
  12607. }
  12608. inline bool ClientImpl::is_valid() const { return true; }
  12609. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12610. client_cert_path_ = rhs.client_cert_path_;
  12611. client_key_path_ = rhs.client_key_path_;
  12612. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12613. read_timeout_sec_ = rhs.read_timeout_sec_;
  12614. read_timeout_usec_ = rhs.read_timeout_usec_;
  12615. write_timeout_sec_ = rhs.write_timeout_sec_;
  12616. write_timeout_usec_ = rhs.write_timeout_usec_;
  12617. max_timeout_msec_ = rhs.max_timeout_msec_;
  12618. basic_auth_username_ = rhs.basic_auth_username_;
  12619. basic_auth_password_ = rhs.basic_auth_password_;
  12620. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12621. keep_alive_ = rhs.keep_alive_;
  12622. follow_location_ = rhs.follow_location_;
  12623. path_encode_ = rhs.path_encode_;
  12624. address_family_ = rhs.address_family_;
  12625. tcp_nodelay_ = rhs.tcp_nodelay_;
  12626. ipv6_v6only_ = rhs.ipv6_v6only_;
  12627. socket_options_ = rhs.socket_options_;
  12628. compress_ = rhs.compress_;
  12629. decompress_ = rhs.decompress_;
  12630. payload_max_length_ = rhs.payload_max_length_;
  12631. has_payload_max_length_ = rhs.has_payload_max_length_;
  12632. interface_ = rhs.interface_;
  12633. proxy_host_ = rhs.proxy_host_;
  12634. proxy_port_ = rhs.proxy_port_;
  12635. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12636. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12637. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12638. no_proxy_entries_ = rhs.no_proxy_entries_;
  12639. logger_ = rhs.logger_;
  12640. error_logger_ = rhs.error_logger_;
  12641. #ifdef CPPHTTPLIB_SSL_ENABLED
  12642. digest_auth_username_ = rhs.digest_auth_username_;
  12643. digest_auth_password_ = rhs.digest_auth_password_;
  12644. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12645. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12646. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12647. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12648. server_certificate_verification_ = rhs.server_certificate_verification_;
  12649. server_hostname_verification_ = rhs.server_hostname_verification_;
  12650. system_ca_mode_ = rhs.system_ca_mode_;
  12651. #endif
  12652. }
  12653. inline bool
  12654. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12655. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12656. if (no_proxy_entries_.empty()) { return true; }
  12657. // host_ is const so its normalized form is invariant; cache it. The
  12658. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12659. if (host == host_) {
  12660. if (!host_normalized_valid_) {
  12661. host_normalized_ = detail::normalize_target(host_);
  12662. host_normalized_valid_ = true;
  12663. }
  12664. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12665. }
  12666. auto target = detail::normalize_target(host);
  12667. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12668. }
  12669. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12670. if (is_proxy_enabled_for_host(host_)) {
  12671. return detail::create_client_socket(
  12672. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12673. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12674. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12675. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12676. }
  12677. // Check is custom IP or hostname specified for host_
  12678. std::string connect_host;
  12679. std::string ip;
  12680. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12681. return detail::create_client_socket(
  12682. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12683. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12684. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12685. write_timeout_usec_, interface_, error);
  12686. }
  12687. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12688. Error &error) {
  12689. auto sock = create_client_socket(error);
  12690. if (sock == INVALID_SOCKET) { return false; }
  12691. socket.sock = sock;
  12692. return true;
  12693. }
  12694. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12695. return create_and_connect_socket(socket, error);
  12696. }
  12697. inline bool ClientImpl::setup_proxy_connection(
  12698. Socket & /*socket*/,
  12699. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12700. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12701. return true;
  12702. }
  12703. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12704. bool /*shutdown_gracefully*/) {
  12705. // If there are any requests in flight from threads other than us, then it's
  12706. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12707. assert(socket_requests_in_flight_ == 0 ||
  12708. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12709. }
  12710. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12711. if (socket.sock == INVALID_SOCKET) { return; }
  12712. detail::shutdown_socket(socket.sock);
  12713. }
  12714. inline void ClientImpl::close_socket(Socket &socket) {
  12715. // If there are requests in flight in another thread, usually closing
  12716. // the socket will be fine and they will simply receive an error when
  12717. // using the closed socket, but it is still a bug since rarely the OS
  12718. // may reassign the socket id to be used for a new socket, and then
  12719. // suddenly they will be operating on a live socket that is different
  12720. // than the one they intended!
  12721. assert(socket_requests_in_flight_ == 0 ||
  12722. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12723. // It is also a bug if this happens while SSL is still active
  12724. #ifdef CPPHTTPLIB_SSL_ENABLED
  12725. assert(socket.ssl == nullptr);
  12726. #endif
  12727. if (socket.sock == INVALID_SOCKET) { return; }
  12728. detail::close_socket(socket.sock);
  12729. socket.sock = INVALID_SOCKET;
  12730. }
  12731. inline void ClientImpl::disconnect(bool gracefully) {
  12732. shutdown_ssl(socket_, gracefully);
  12733. shutdown_socket(socket_);
  12734. close_socket(socket_);
  12735. }
  12736. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12737. Response &res,
  12738. bool skip_100_continue) const {
  12739. std::array<char, 2048> buf{};
  12740. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12741. if (!line_reader.getline()) { return false; }
  12742. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12743. res.reason)) {
  12744. return req.method == "CONNECT";
  12745. }
  12746. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12747. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12748. if (!line_reader.getline()) { return false; } // CRLF
  12749. if (!line_reader.getline()) { return false; } // next response line
  12750. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12751. res.reason)) {
  12752. return false;
  12753. }
  12754. }
  12755. return true;
  12756. }
  12757. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12758. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12759. auto ret = send_(req, res, error);
  12760. if (error == Error::SSLPeerCouldBeClosed_) {
  12761. assert(!ret);
  12762. ret = send_(req, res, error);
  12763. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12764. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12765. }
  12766. return ret;
  12767. }
  12768. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12769. {
  12770. std::lock_guard<std::mutex> guard(socket_mutex_);
  12771. // Set this to false immediately - if it ever gets set to true by the end
  12772. // of the request, we know another thread instructed us to close the
  12773. // socket.
  12774. socket_should_be_closed_when_request_is_done_ = false;
  12775. auto is_alive = false;
  12776. if (socket_.is_open()) {
  12777. is_alive = detail::is_socket_alive(socket_.sock);
  12778. #ifdef CPPHTTPLIB_SSL_ENABLED
  12779. if (is_alive && is_ssl()) {
  12780. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12781. is_alive = false;
  12782. }
  12783. }
  12784. #endif
  12785. if (!is_alive) {
  12786. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12787. disconnect(/*gracefully=*/false);
  12788. }
  12789. }
  12790. if (!is_alive) {
  12791. if (!ensure_socket_connection(socket_, error)) {
  12792. output_error_log(error, &req);
  12793. return false;
  12794. }
  12795. {
  12796. auto success = true;
  12797. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12798. error)) {
  12799. if (!success) { output_error_log(error, &req); }
  12800. return success;
  12801. }
  12802. }
  12803. }
  12804. // Mark the current socket as being in use so that it cannot be closed by
  12805. // anyone else while this request is ongoing, even though we will be
  12806. // releasing the mutex.
  12807. if (socket_requests_in_flight_ > 1) {
  12808. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12809. }
  12810. socket_requests_in_flight_ += 1;
  12811. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12812. }
  12813. for (const auto &header : default_headers_) {
  12814. if (req.headers.find(header.first) == req.headers.end()) {
  12815. req.headers.insert(header);
  12816. }
  12817. }
  12818. auto ret = false;
  12819. auto close_connection = !keep_alive_;
  12820. auto se = detail::scope_exit([&]() {
  12821. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12822. std::lock_guard<std::mutex> guard(socket_mutex_);
  12823. socket_requests_in_flight_ -= 1;
  12824. if (socket_requests_in_flight_ <= 0) {
  12825. assert(socket_requests_in_flight_ == 0);
  12826. socket_requests_are_from_thread_ = std::thread::id();
  12827. }
  12828. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12829. !ret) {
  12830. disconnect(/*gracefully=*/true);
  12831. }
  12832. });
  12833. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12834. return handle_request(strm, req, res, close_connection, error);
  12835. });
  12836. if (!ret) {
  12837. if (error == Error::Success) {
  12838. error = Error::Unknown;
  12839. output_error_log(error, &req);
  12840. }
  12841. }
  12842. return ret;
  12843. }
  12844. inline Result ClientImpl::send(const Request &req) {
  12845. auto req2 = req;
  12846. return send_(std::move(req2));
  12847. }
  12848. inline Result ClientImpl::send_(Request &&req) {
  12849. auto res = detail::make_unique<Response>();
  12850. auto error = Error::Success;
  12851. auto ret = send(req, *res, error);
  12852. #ifdef CPPHTTPLIB_SSL_ENABLED
  12853. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12854. last_ssl_error_, last_backend_error_};
  12855. #else
  12856. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12857. #endif
  12858. }
  12859. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12860. const std::string &ct) {
  12861. (void)for_stream;
  12862. // Default headers are meant for the origin and may carry its credentials, so
  12863. // keep them off the CONNECT request the proxy reads.
  12864. if (r.method != "CONNECT") {
  12865. for (const auto &header : default_headers_) {
  12866. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12867. }
  12868. }
  12869. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12870. // prepend it rather than appending it after the caller's own fields.
  12871. if (!r.has_header("Host")) {
  12872. r.headers.emplace_front(
  12873. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12874. address_family_));
  12875. }
  12876. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12877. if (!r.content_receiver) {
  12878. if (!r.has_header("Accept-Encoding")) {
  12879. std::string accept_encoding;
  12880. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12881. accept_encoding = "br";
  12882. #endif
  12883. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12884. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12885. accept_encoding += "gzip, deflate";
  12886. #endif
  12887. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12888. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12889. accept_encoding += "zstd";
  12890. #endif
  12891. r.set_header("Accept-Encoding", accept_encoding);
  12892. }
  12893. detail::add_default_user_agent_header(r);
  12894. }
  12895. if (!r.body.empty()) {
  12896. if (!ct.empty() && !r.has_header("Content-Type")) {
  12897. r.headers.emplace("Content-Type", ct);
  12898. }
  12899. if (!r.has_header("Content-Length")) {
  12900. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12901. }
  12902. }
  12903. }
  12904. inline ClientImpl::StreamHandle
  12905. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12906. const Params &params, const Headers &headers,
  12907. const std::string &body,
  12908. const std::string &content_type) {
  12909. StreamHandle handle;
  12910. handle.response = detail::make_unique<Response>();
  12911. handle.error = Error::Success;
  12912. // Encode the target exactly like the buffered send path does, so that the
  12913. // same `path` produces the same request line through either API.
  12914. auto raw_query_path =
  12915. params.empty() ? path : append_query_params(path, params);
  12916. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12917. handle.connection_ = detail::make_unique<ClientConnection>();
  12918. {
  12919. std::lock_guard<std::mutex> guard(socket_mutex_);
  12920. auto is_alive = false;
  12921. if (socket_.is_open()) {
  12922. is_alive = detail::is_socket_alive(socket_.sock);
  12923. #ifdef CPPHTTPLIB_SSL_ENABLED
  12924. if (is_alive && is_ssl()) {
  12925. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12926. is_alive = false;
  12927. }
  12928. }
  12929. #endif
  12930. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12931. }
  12932. if (!is_alive) {
  12933. if (!ensure_socket_connection(socket_, handle.error)) {
  12934. handle.response.reset();
  12935. return handle;
  12936. }
  12937. {
  12938. auto success = true;
  12939. auto start_time = std::chrono::steady_clock::now();
  12940. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12941. success, handle.error)) {
  12942. if (!success) { handle.response.reset(); }
  12943. return handle;
  12944. }
  12945. }
  12946. }
  12947. transfer_socket_ownership_to_handle(handle);
  12948. }
  12949. #ifdef CPPHTTPLIB_SSL_ENABLED
  12950. if (is_ssl() && handle.connection_->session) {
  12951. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12952. handle.connection_->sock, handle.connection_->session,
  12953. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12954. write_timeout_usec_);
  12955. } else {
  12956. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12957. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12958. write_timeout_sec_, write_timeout_usec_);
  12959. }
  12960. #else
  12961. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12962. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12963. write_timeout_sec_, write_timeout_usec_);
  12964. #endif
  12965. handle.stream_ = handle.socket_stream_.get();
  12966. Request req;
  12967. req.method = method;
  12968. req.path = query_path;
  12969. req.headers = headers;
  12970. req.body = body;
  12971. prepare_default_headers(req, true, content_type);
  12972. auto &strm = *handle.stream_;
  12973. // Build the request line and headers in memory first, like write_request()
  12974. // does, so that a rejected header leaves nothing on the wire.
  12975. {
  12976. detail::BufferStream bstrm;
  12977. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  12978. handle.error = Error::Write;
  12979. handle.response.reset();
  12980. return handle;
  12981. }
  12982. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  12983. handle.error)) {
  12984. handle.response.reset();
  12985. return handle;
  12986. }
  12987. const auto &data = bstrm.get_buffer();
  12988. if (!detail::write_data(strm, data.data(), data.size())) {
  12989. handle.error = Error::Write;
  12990. handle.response.reset();
  12991. return handle;
  12992. }
  12993. }
  12994. if (!body.empty()) {
  12995. if (strm.write(body.data(), body.size()) < 0) {
  12996. handle.error = Error::Write;
  12997. handle.response.reset();
  12998. return handle;
  12999. }
  13000. }
  13001. if (!read_response_line(strm, req, *handle.response) ||
  13002. !detail::read_headers(strm, handle.response->headers)) {
  13003. handle.error = Error::Read;
  13004. handle.response.reset();
  13005. return handle;
  13006. }
  13007. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13008. // (204/304) response legitimately carries framing headers with no body.
  13009. if (method != "HEAD" &&
  13010. handle.response->status != StatusCode::NoContent_204 &&
  13011. handle.response->status != StatusCode::NotModified_304 &&
  13012. detail::has_conflicting_content_length(handle.response->headers)) {
  13013. handle.error = Error::Read;
  13014. handle.response.reset();
  13015. return handle;
  13016. }
  13017. handle.body_reader_.stream = handle.stream_;
  13018. handle.body_reader_.payload_max_length = payload_max_length_;
  13019. if (handle.response->has_header("Content-Length")) {
  13020. bool is_invalid = false;
  13021. auto content_length = detail::get_header_value_u64(
  13022. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13023. if (is_invalid) {
  13024. handle.error = Error::Read;
  13025. handle.response.reset();
  13026. return handle;
  13027. }
  13028. handle.body_reader_.has_content_length = true;
  13029. handle.body_reader_.content_length = content_length;
  13030. }
  13031. handle.body_reader_.chunked =
  13032. detail::is_chunked_transfer_encoding(handle.response->headers);
  13033. auto content_encoding = detail::get_combined_header_value(
  13034. handle.response->headers, "Content-Encoding");
  13035. if (!content_encoding.empty()) {
  13036. // Same policy as prepare_content_receiver(): reject a coding we know about
  13037. // but were not built with, pass an unrecognized one through as-is.
  13038. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13039. if (!handle.decompressor_) {
  13040. if (detail::is_known_content_encoding(content_encoding)) {
  13041. handle.error = Error::UnsupportedContentEncoding;
  13042. handle.response.reset();
  13043. return handle;
  13044. }
  13045. } else if (!handle.decompressor_->is_valid()) {
  13046. handle.error = Error::Compression;
  13047. handle.response.reset();
  13048. return handle;
  13049. }
  13050. }
  13051. return handle;
  13052. }
  13053. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13054. if (!is_valid() || !response) { return -1; }
  13055. if (decompressor_) { return read_with_decompression(buf, len); }
  13056. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13057. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13058. trailers_parsed_ = true;
  13059. if (body_reader_.chunked_decoder) {
  13060. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13061. response->trailers, response->headers)) {
  13062. return n;
  13063. }
  13064. } else {
  13065. detail::ChunkedDecoder dec(*stream_);
  13066. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13067. return n;
  13068. }
  13069. }
  13070. }
  13071. return n;
  13072. }
  13073. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13074. size_t len) {
  13075. if (decompress_offset_ < decompress_buffer_.size()) {
  13076. auto available = decompress_buffer_.size() - decompress_offset_;
  13077. auto to_copy = (std::min)(len, available);
  13078. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13079. decompress_offset_ += to_copy;
  13080. decompressed_bytes_read_ += to_copy;
  13081. return static_cast<ssize_t>(to_copy);
  13082. }
  13083. decompress_buffer_.clear();
  13084. decompress_offset_ = 0;
  13085. constexpr size_t kDecompressionBufferSize = 8192;
  13086. char compressed_buf[kDecompressionBufferSize];
  13087. while (true) {
  13088. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13089. sizeof(compressed_buf));
  13090. if (n <= 0) { return n; }
  13091. bool decompress_ok = decompressor_->decompress(
  13092. compressed_buf, static_cast<size_t>(n),
  13093. [this](const char *data, size_t data_len) {
  13094. decompress_buffer_.append(data, data_len);
  13095. auto limit = body_reader_.payload_max_length;
  13096. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  13097. return false;
  13098. }
  13099. return true;
  13100. });
  13101. if (!decompress_ok) {
  13102. body_reader_.last_error = Error::Read;
  13103. return -1;
  13104. }
  13105. if (!decompress_buffer_.empty()) { break; }
  13106. }
  13107. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13108. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13109. decompress_offset_ = to_copy;
  13110. decompressed_bytes_read_ += to_copy;
  13111. return static_cast<ssize_t>(to_copy);
  13112. }
  13113. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13114. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13115. return;
  13116. }
  13117. trailers_parsed_ = true;
  13118. const auto bufsiz = 128;
  13119. char line_buf[bufsiz];
  13120. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13121. if (!line_reader.getline()) { return; }
  13122. if (!detail::parse_trailers(line_reader, response->trailers,
  13123. response->headers)) {
  13124. return;
  13125. }
  13126. }
  13127. namespace detail {
  13128. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13129. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13130. size_t &out_chunk_offset,
  13131. size_t &out_chunk_total) {
  13132. if (finished) { return 0; }
  13133. if (chunk_remaining == 0) {
  13134. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13135. if (!lr.getline()) { return -1; }
  13136. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13137. // the line terminator is never mistaken for line content.
  13138. const char *eol = lr.ptr() + lr.size();
  13139. if (lr.end_with_crlf()) {
  13140. eol -= 2;
  13141. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13142. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13143. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13144. // has to come off here or the check below would reject the line.
  13145. eol -= 1;
  13146. }
  13147. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13148. const char *p = lr.ptr();
  13149. int v = 0;
  13150. if (p == eol || !is_hex(*p, v)) { return -1; }
  13151. size_t chunk_len = 0;
  13152. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13153. for (; p < eol && is_hex(*p, v); ++p) {
  13154. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13155. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13156. }
  13157. while (p < eol && is_space_or_tab(*p)) {
  13158. ++p;
  13159. }
  13160. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13161. // terminator, and it is built from tokens and quoted-strings, so it never
  13162. // holds a CR, LF or any other control character. getline() reads up to the
  13163. // CRLF, so a bare LF left in here would be swallowed as extension text
  13164. // while an intermediary that ends the line on it delimits the chunks
  13165. // differently, and the two disagree on where the body ends (request
  13166. // smuggling).
  13167. if (p < eol && *p != ';') { return -1; }
  13168. for (; p < eol; ++p) {
  13169. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13170. }
  13171. if (chunk_len == 0) {
  13172. chunk_remaining = 0;
  13173. finished = true;
  13174. out_chunk_offset = 0;
  13175. out_chunk_total = 0;
  13176. return 0;
  13177. }
  13178. chunk_remaining = chunk_len;
  13179. last_chunk_total = chunk_remaining;
  13180. last_chunk_offset = 0;
  13181. }
  13182. auto to_read = (std::min)(chunk_remaining, len);
  13183. auto n = strm.read(buf, to_read);
  13184. if (n <= 0) { return -1; }
  13185. auto offset_before = last_chunk_offset;
  13186. last_chunk_offset += static_cast<size_t>(n);
  13187. chunk_remaining -= static_cast<size_t>(n);
  13188. out_chunk_offset = offset_before;
  13189. out_chunk_total = last_chunk_total;
  13190. if (chunk_remaining == 0) {
  13191. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13192. if (!lr.getline()) { return -1; }
  13193. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13194. }
  13195. return n;
  13196. }
  13197. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13198. const Headers &src_headers) {
  13199. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13200. if (!lr.getline()) { return false; }
  13201. return parse_trailers(lr, dest, src_headers);
  13202. }
  13203. } // namespace detail
  13204. inline void
  13205. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13206. handle.connection_->sock = socket_.sock;
  13207. #ifdef CPPHTTPLIB_SSL_ENABLED
  13208. handle.connection_->session = socket_.ssl;
  13209. socket_.ssl = nullptr;
  13210. #endif
  13211. socket_.sock = INVALID_SOCKET;
  13212. }
  13213. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13214. Response &res, bool close_connection,
  13215. Error &error) {
  13216. if (req.path.empty()) {
  13217. error = Error::Connection;
  13218. output_error_log(error, &req);
  13219. return false;
  13220. }
  13221. auto req_save = req;
  13222. bool ret;
  13223. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13224. auto req2 = req;
  13225. req2.path = "http://" +
  13226. detail::make_host_and_port_string(host_, port_, false) +
  13227. req.path;
  13228. ret = process_request(strm, req2, res, close_connection, error);
  13229. req = std::move(req2);
  13230. req.path = req_save.path;
  13231. } else {
  13232. ret = process_request(strm, req, res, close_connection, error);
  13233. }
  13234. if (!ret) { return false; }
  13235. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13236. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13237. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13238. // for this to be safe.
  13239. // This is safe to call because handle_request is only called by send_
  13240. // which locks the request mutex during the process. It would be a bug
  13241. // to call it from a different thread since it's a thread-safety issue
  13242. // to do these things to the socket if another thread is using the socket.
  13243. std::lock_guard<std::mutex> guard(socket_mutex_);
  13244. disconnect(/*gracefully=*/true);
  13245. }
  13246. if (300 < res.status && res.status < 400 && follow_location_) {
  13247. req = std::move(req_save);
  13248. ret = redirect(req, res, error);
  13249. }
  13250. #ifdef CPPHTTPLIB_SSL_ENABLED
  13251. if ((res.status == StatusCode::Unauthorized_401 ||
  13252. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13253. req.authorization_count_ < 5) {
  13254. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13255. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13256. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13257. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13258. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13259. return ret;
  13260. }
  13261. const auto &username =
  13262. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13263. const auto &password =
  13264. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13265. if (!username.empty() && !password.empty()) {
  13266. std::map<std::string, std::string> auth;
  13267. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13268. Request new_req = req;
  13269. new_req.authorization_count_ += 1;
  13270. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13271. : "Authorization");
  13272. new_req.headers.insert(detail::make_digest_authentication_header(
  13273. req, auth, new_req.authorization_count_, detail::random_string(10),
  13274. username, password, is_proxy));
  13275. Response new_res;
  13276. ret = send(new_req, new_res, error);
  13277. if (ret) { res = std::move(new_res); }
  13278. }
  13279. }
  13280. }
  13281. #endif
  13282. return ret;
  13283. }
  13284. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13285. if (req.redirect_count_ == 0) {
  13286. error = Error::ExceedRedirectCount;
  13287. output_error_log(error, &req);
  13288. return false;
  13289. }
  13290. auto location = res.get_header_value("location");
  13291. if (location.empty()) { return false; }
  13292. detail::UrlComponents uc;
  13293. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13294. uc)) {
  13295. return false;
  13296. }
  13297. // Only follow http/https redirects
  13298. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13299. return false;
  13300. }
  13301. auto scheme = is_ssl() ? "https" : "http";
  13302. auto next_scheme = std::move(uc.scheme);
  13303. auto next_host = std::move(uc.host);
  13304. auto port_str = std::move(uc.port);
  13305. auto next_path = std::move(uc.path);
  13306. auto next_query = std::move(uc.query);
  13307. auto next_port = port_;
  13308. if (!port_str.empty()) {
  13309. if (!detail::parse_port(port_str, next_port)) { return false; }
  13310. } else if (!next_scheme.empty()) {
  13311. next_port = next_scheme == "https" ? 443 : 80;
  13312. }
  13313. if (next_scheme.empty()) { next_scheme = scheme; }
  13314. if (next_host.empty()) { next_host = host_; }
  13315. if (next_path.empty()) { next_path = "/"; }
  13316. auto path = decode_path_component(next_path) + next_query;
  13317. // Same host redirect - use current client
  13318. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13319. return detail::redirect(*this, req, res, path, location, error);
  13320. }
  13321. // Cross-host/scheme redirect - create new client with robust setup
  13322. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13323. path, location, error);
  13324. }
  13325. // New method for robust redirect client creation
  13326. inline bool ClientImpl::create_redirect_client(
  13327. const std::string &scheme, const std::string &host, int port, Request &req,
  13328. Response &res, const std::string &path, const std::string &location,
  13329. Error &error) {
  13330. // Determine if we need SSL
  13331. auto need_ssl = (scheme == "https");
  13332. // Clean up request headers that are host/client specific
  13333. // Remove headers that should not be carried over to new host
  13334. auto headers_to_remove = std::vector<std::string>{
  13335. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13336. for (const auto &header_name : headers_to_remove) {
  13337. auto it = req.headers.find(header_name);
  13338. while (it != req.headers.end()) {
  13339. it = req.headers.erase(it);
  13340. it = req.headers.find(header_name);
  13341. }
  13342. }
  13343. // Create appropriate client type and handle redirect
  13344. if (need_ssl) {
  13345. #ifdef CPPHTTPLIB_SSL_ENABLED
  13346. // Create SSL client for HTTPS redirect
  13347. SSLClient redirect_client(host, port);
  13348. // Setup basic client configuration first
  13349. setup_redirect_client(redirect_client);
  13350. redirect_client.enable_server_certificate_verification(
  13351. server_certificate_verification_);
  13352. redirect_client.enable_server_hostname_verification(
  13353. server_hostname_verification_);
  13354. redirect_client.system_ca_mode_ = system_ca_mode_;
  13355. // Transfer CA certificate to redirect client
  13356. if (!ca_cert_pem_.empty()) {
  13357. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13358. ca_cert_pem_.size());
  13359. }
  13360. if (!ca_cert_file_path_.empty()) {
  13361. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13362. }
  13363. // Client certificates are set through constructor for SSLClient
  13364. // NOTE: SSLClient constructor already takes client_cert_path and
  13365. // client_key_path so we need to create it properly if client certs are
  13366. // needed
  13367. // Execute the redirect
  13368. return detail::redirect(redirect_client, req, res, path, location, error);
  13369. #else
  13370. // SSL not supported - set appropriate error
  13371. error = Error::SSLConnection;
  13372. output_error_log(error, &req);
  13373. return false;
  13374. #endif
  13375. } else {
  13376. // HTTP redirect
  13377. ClientImpl redirect_client(host, port);
  13378. // Setup client with robust configuration
  13379. setup_redirect_client(redirect_client);
  13380. // Execute the redirect
  13381. return detail::redirect(redirect_client, req, res, path, location, error);
  13382. }
  13383. }
  13384. // New method for robust client setup (based on basic_manual_redirect.cpp
  13385. // logic)
  13386. template <typename ClientType>
  13387. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13388. // Copy basic settings first
  13389. client.set_connection_timeout(connection_timeout_sec_);
  13390. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13391. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13392. client.set_keep_alive(keep_alive_);
  13393. client.set_follow_location(
  13394. true); // Enable redirects to handle multi-step redirects
  13395. client.set_path_encode(path_encode_);
  13396. client.set_compress(compress_);
  13397. client.set_decompress(decompress_);
  13398. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13399. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13400. // 15.4, credentials must not be forwarded when redirecting to a different
  13401. // host. This function is only called for cross-host redirects; same-host
  13402. // redirects are handled directly in ClientImpl::redirect().
  13403. // Copy the proxy configuration unconditionally; the per-target bypass is
  13404. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13405. // still use the proxy.
  13406. client.no_proxy_entries_ = no_proxy_entries_;
  13407. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13408. client.set_proxy(proxy_host_, proxy_port_);
  13409. if (!proxy_basic_auth_username_.empty()) {
  13410. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13411. proxy_basic_auth_password_);
  13412. }
  13413. if (!proxy_bearer_token_auth_token_.empty()) {
  13414. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13415. }
  13416. #ifdef CPPHTTPLIB_SSL_ENABLED
  13417. if (!proxy_digest_auth_username_.empty()) {
  13418. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13419. proxy_digest_auth_password_);
  13420. }
  13421. #endif
  13422. }
  13423. // Copy network and socket settings
  13424. client.set_address_family(address_family_);
  13425. client.set_tcp_nodelay(tcp_nodelay_);
  13426. client.set_ipv6_v6only(ipv6_v6only_);
  13427. if (socket_options_) { client.set_socket_options(socket_options_); }
  13428. if (!interface_.empty()) { client.set_interface(interface_); }
  13429. // Copy logging and headers
  13430. if (logger_) { client.set_logger(logger_); }
  13431. if (error_logger_) { client.set_error_logger(error_logger_); }
  13432. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13433. // Each new client should generate its own headers based on its target host
  13434. }
  13435. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13436. const Request &req,
  13437. Error &error) const {
  13438. auto is_shutting_down = []() { return false; };
  13439. if (req.is_chunked_content_provider_) {
  13440. auto compressor = compress_ ? detail::create_compressor().first
  13441. : std::unique_ptr<detail::compressor>();
  13442. if (!compressor) {
  13443. compressor = detail::make_unique<detail::nocompressor>();
  13444. }
  13445. return detail::write_content_chunked(strm, req.content_provider_,
  13446. is_shutting_down, *compressor, error);
  13447. } else {
  13448. return detail::write_content_with_progress(
  13449. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13450. req.upload_progress, error);
  13451. }
  13452. }
  13453. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13454. bool close_connection, Error &error,
  13455. bool skip_body, bool &rejected_locally) {
  13456. rejected_locally = false;
  13457. // Prepare additional headers
  13458. if (close_connection) {
  13459. if (!req.has_header("Connection")) {
  13460. req.set_header("Connection", "close");
  13461. }
  13462. }
  13463. std::string ct_for_defaults;
  13464. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13465. ct_for_defaults = "text/plain";
  13466. }
  13467. prepare_default_headers(req, false, ct_for_defaults);
  13468. if (req.body.empty()) {
  13469. if (req.content_provider_) {
  13470. if (!req.is_chunked_content_provider_) {
  13471. if (!req.has_header("Content-Length")) {
  13472. auto length = std::to_string(req.content_length_);
  13473. req.set_header("Content-Length", length);
  13474. }
  13475. }
  13476. } else {
  13477. if (req.method == "POST" || req.method == "PUT" ||
  13478. req.method == "PATCH") {
  13479. req.set_header("Content-Length", "0");
  13480. }
  13481. }
  13482. }
  13483. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13484. // it opens is read by the origin. Each credential goes only to its own hop.
  13485. auto is_connect = req.method == "CONNECT";
  13486. if (!is_connect && !req.has_header("Authorization")) {
  13487. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13488. req.headers.insert(make_basic_authentication_header(
  13489. basic_auth_username_, basic_auth_password_, false));
  13490. } else if (!bearer_token_auth_token_.empty()) {
  13491. req.headers.insert(make_bearer_token_authentication_header(
  13492. bearer_token_auth_token_, false));
  13493. }
  13494. }
  13495. // Proxy-Authorization is only sent when the proxy reads this message —
  13496. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13497. // would leak proxy credentials to the destination server.
  13498. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13499. if (!proxy_basic_auth_username_.empty() &&
  13500. !proxy_basic_auth_password_.empty() &&
  13501. !req.has_header("Proxy-Authorization")) {
  13502. req.headers.insert(make_basic_authentication_header(
  13503. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13504. }
  13505. if (!proxy_bearer_token_auth_token_.empty() &&
  13506. !req.has_header("Proxy-Authorization")) {
  13507. req.headers.insert(make_bearer_token_authentication_header(
  13508. proxy_bearer_token_auth_token_, true));
  13509. }
  13510. }
  13511. // Request line and headers
  13512. {
  13513. detail::BufferStream bstrm;
  13514. // Extract the query from req.path. The encoding itself is delegated to
  13515. // `encode_request_target`; the raw query is still needed here to decide
  13516. // between populating `req.params` from it and falling back to building a
  13517. // query out of caller-supplied `req.params`.
  13518. auto query_pos = req.path.find('?');
  13519. auto query_part = query_pos == std::string::npos
  13520. ? std::string()
  13521. : req.path.substr(query_pos + 1);
  13522. auto path_with_query =
  13523. detail::encode_request_target(req.path, path_encode_);
  13524. if (!query_part.empty()) {
  13525. // The query already came in through `req.path`; still populate
  13526. // `req.params` for handlers/users who read them.
  13527. detail::parse_query_text(query_part, req.params);
  13528. } else if (!req.params.empty()) {
  13529. // No query in `req.path`; build one from `req.params` so existing
  13530. // callers that pass `Params` separately continue to work.
  13531. path_with_query = append_query_params(path_with_query, req.params);
  13532. }
  13533. // Write request line and headers
  13534. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13535. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13536. // CR/LF smuggled in via a decoded redirect Location under
  13537. // set_path_encode(false)) must fail the request cleanly instead of
  13538. // emitting a request-line-less, header-injecting request.
  13539. error = Error::Write;
  13540. rejected_locally = true;
  13541. output_error_log(error, &req);
  13542. return false;
  13543. }
  13544. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13545. error)) {
  13546. rejected_locally = true;
  13547. output_error_log(error, &req);
  13548. return false;
  13549. }
  13550. // Flush buffer
  13551. auto &data = bstrm.get_buffer();
  13552. if (!detail::write_data(strm, data.data(), data.size())) {
  13553. error = Error::Write;
  13554. output_error_log(error, &req);
  13555. return false;
  13556. }
  13557. }
  13558. // After sending request line and headers, wait briefly for an early server
  13559. // response (e.g. 4xx) and avoid sending a potentially large request body
  13560. // unnecessarily. This workaround is only enabled on Windows because Unix
  13561. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13562. // buffering can accept large writes even when the peer already responded.
  13563. // Check the stream first (which covers SSL via `is_readable()`), then
  13564. // fall back to select on the socket. Only perform the wait for very large
  13565. // request bodies to avoid interfering with normal small requests and
  13566. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13567. // response. Skip this check when using Expect: 100-continue, as the protocol
  13568. // handles early responses properly.
  13569. #if defined(_WIN32)
  13570. if (!skip_body &&
  13571. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13572. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13573. auto start = std::chrono::high_resolution_clock::now();
  13574. for (;;) {
  13575. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13576. // from SSL internals. If the underlying socket is readable, assume an
  13577. // early response may be present.
  13578. auto sock = strm.socket();
  13579. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13580. return false;
  13581. }
  13582. // Fallback to stream-level check for non-socket streams or when the
  13583. // socket isn't reporting readable. Avoid using `is_readable()` for
  13584. // SSL, since `SSL_pending()` may report buffered records that do not
  13585. // indicate a complete application-level response yet.
  13586. if (!is_ssl() && strm.is_readable()) { return false; }
  13587. auto now = std::chrono::high_resolution_clock::now();
  13588. auto elapsed =
  13589. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13590. .count();
  13591. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13592. break;
  13593. }
  13594. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13595. }
  13596. }
  13597. #endif
  13598. // Body
  13599. if (skip_body) { return true; }
  13600. return write_request_body(strm, req, error);
  13601. }
  13602. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13603. Error &error) {
  13604. if (req.body.empty()) {
  13605. return write_content_with_provider(strm, req, error);
  13606. }
  13607. if (req.upload_progress) {
  13608. auto body_size = req.body.size();
  13609. size_t written = 0;
  13610. auto data = req.body.data();
  13611. while (written < body_size) {
  13612. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13613. if (!detail::write_data(strm, data + written, to_write)) {
  13614. error = Error::Write;
  13615. output_error_log(error, &req);
  13616. return false;
  13617. }
  13618. written += to_write;
  13619. if (!req.upload_progress(written, body_size)) {
  13620. error = Error::Canceled;
  13621. output_error_log(error, &req);
  13622. return false;
  13623. }
  13624. }
  13625. } else {
  13626. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13627. error = Error::Write;
  13628. output_error_log(error, &req);
  13629. return false;
  13630. }
  13631. }
  13632. return true;
  13633. }
  13634. inline std::unique_ptr<Response>
  13635. ClientImpl::send_with_content_provider_and_receiver(
  13636. Request &req, const char *body, size_t content_length,
  13637. ContentProvider content_provider,
  13638. ContentProviderWithoutLength content_provider_without_length,
  13639. const std::string &content_type, ContentReceiver content_receiver,
  13640. Error &error) {
  13641. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13642. auto enc = compress_
  13643. ? detail::create_compressor()
  13644. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13645. nullptr, nullptr);
  13646. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13647. if (enc.first && !content_provider_without_length) {
  13648. auto &compressor = enc.first;
  13649. if (content_provider) {
  13650. auto ok = true;
  13651. auto finished = false;
  13652. size_t offset = 0;
  13653. DataSink data_sink;
  13654. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13655. if (ok) {
  13656. auto last = offset + data_len == content_length;
  13657. auto ret = compressor->compress(
  13658. data, data_len, last,
  13659. [&](const char *compressed_data, size_t compressed_data_len) {
  13660. req.body.append(compressed_data, compressed_data_len);
  13661. return true;
  13662. });
  13663. if (ret) {
  13664. offset += data_len;
  13665. } else {
  13666. ok = false;
  13667. }
  13668. }
  13669. return ok;
  13670. };
  13671. // As in detail::write_content_with_progress(): the body is framed by
  13672. // content_length, so a provider that finishes early has truncated it.
  13673. // Stop and report that instead of calling the provider forever.
  13674. data_sink.done = [&]() { finished = true; };
  13675. while (ok && !finished && offset < content_length) {
  13676. if (!content_provider(offset, content_length - offset, data_sink)) {
  13677. error = Error::Canceled;
  13678. output_error_log(error, &req);
  13679. return nullptr;
  13680. }
  13681. }
  13682. // A short body here means either the provider stopped early or the
  13683. // compressor gave up. The branch below reports a failing compressor as
  13684. // Error::Compression, so keep the two distinguishable.
  13685. if (offset < content_length) {
  13686. error = ok ? Error::Write : Error::Compression;
  13687. output_error_log(error, &req);
  13688. return nullptr;
  13689. }
  13690. } else {
  13691. if (!compressor->compress(body, content_length, true,
  13692. [&](const char *data, size_t data_len) {
  13693. req.body.append(data, data_len);
  13694. return true;
  13695. })) {
  13696. error = Error::Compression;
  13697. output_error_log(error, &req);
  13698. return nullptr;
  13699. }
  13700. }
  13701. } else {
  13702. if (content_provider) {
  13703. req.content_length_ = content_length;
  13704. req.content_provider_ = std::move(content_provider);
  13705. req.is_chunked_content_provider_ = false;
  13706. } else if (content_provider_without_length) {
  13707. req.content_length_ = 0;
  13708. req.content_provider_ = detail::ContentProviderAdapter(
  13709. std::move(content_provider_without_length));
  13710. req.is_chunked_content_provider_ = true;
  13711. req.set_header("Transfer-Encoding", "chunked");
  13712. } else {
  13713. req.body.assign(body, content_length);
  13714. }
  13715. }
  13716. if (content_receiver) {
  13717. req.content_receiver =
  13718. [content_receiver](const char *data, size_t data_length,
  13719. size_t /*offset*/, size_t /*total_length*/) {
  13720. return content_receiver(data, data_length);
  13721. };
  13722. }
  13723. auto res = detail::make_unique<Response>();
  13724. return send(req, *res, error) ? std::move(res) : nullptr;
  13725. }
  13726. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13727. const std::string &method, const std::string &path, const Headers &headers,
  13728. const char *body, size_t content_length, ContentProvider content_provider,
  13729. ContentProviderWithoutLength content_provider_without_length,
  13730. const std::string &content_type, ContentReceiver content_receiver,
  13731. UploadProgress progress) {
  13732. Request req;
  13733. req.method = method;
  13734. req.headers = headers;
  13735. req.path = path;
  13736. req.upload_progress = std::move(progress);
  13737. if (max_timeout_msec_ > 0) {
  13738. req.start_time_ = std::chrono::steady_clock::now();
  13739. }
  13740. auto error = Error::Success;
  13741. auto res = send_with_content_provider_and_receiver(
  13742. req, body, content_length, std::move(content_provider),
  13743. std::move(content_provider_without_length), content_type,
  13744. std::move(content_receiver), error);
  13745. #ifdef CPPHTTPLIB_SSL_ENABLED
  13746. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13747. last_backend_error_};
  13748. #else
  13749. return Result{std::move(res), error, std::move(req.headers)};
  13750. #endif
  13751. }
  13752. inline void ClientImpl::output_log(const Request &req,
  13753. const Response &res) const {
  13754. if (logger_) {
  13755. std::lock_guard<std::mutex> guard(logger_mutex_);
  13756. logger_(req, res);
  13757. }
  13758. }
  13759. inline void ClientImpl::output_error_log(const Error &err,
  13760. const Request *req) const {
  13761. if (error_logger_) {
  13762. std::lock_guard<std::mutex> guard(logger_mutex_);
  13763. error_logger_(err, req);
  13764. }
  13765. }
  13766. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13767. Response &res, bool close_connection,
  13768. Error &error) {
  13769. // Auto-add Expect: 100-continue for large bodies
  13770. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13771. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13772. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13773. req.set_header("Expect", "100-continue");
  13774. }
  13775. }
  13776. // Check for Expect: 100-continue
  13777. auto expect_100_continue =
  13778. detail::has_header_token(req.headers, "Expect", "100-continue");
  13779. // Send request (skip body if using Expect: 100-continue)
  13780. auto rejected_locally = false;
  13781. auto write_request_success =
  13782. write_request(strm, req, close_connection, error, expect_100_continue,
  13783. rejected_locally);
  13784. // A failed write normally still reads the response below, since the server
  13785. // may have answered early (e.g. 413/414) and closed while the body was being
  13786. // sent. A request rejected before any byte reached the socket gets no such
  13787. // response, and waiting for one would block until the read timeout.
  13788. if (rejected_locally) { return false; }
  13789. #ifdef CPPHTTPLIB_SSL_ENABLED
  13790. if (is_ssl() && !expect_100_continue) {
  13791. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13792. if (!is_proxy_enabled) {
  13793. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13794. error = Error::SSLPeerCouldBeClosed_;
  13795. output_error_log(error, &req);
  13796. return false;
  13797. }
  13798. }
  13799. }
  13800. #endif
  13801. // Handle Expect: 100-continue.
  13802. //
  13803. // Wait for an interim/early response by attempting to read the status line
  13804. // under a short timeout, instead of trusting raw socket readability. Over
  13805. // TLS, post-handshake records (e.g. session tickets) make the socket
  13806. // readable without any HTTP response being available; relying on
  13807. // `select_read` there caused the body to be withheld forever and the
  13808. // request to fail with `Read` (#2458). If no status line arrives within the
  13809. // timeout, send the body anyway (matching curl's behavior).
  13810. auto status_line_read = false;
  13811. if (expect_100_continue && write_request_success) {
  13812. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13813. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13814. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13815. strm.set_read_timeout(sec, usec);
  13816. status_line_read = read_response_line(strm, req, res, false);
  13817. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13818. }
  13819. if (!status_line_read) {
  13820. // No interim response within the timeout: send the body and handle the
  13821. // response as usual.
  13822. if (!write_request_body(strm, req, error)) { return false; }
  13823. expect_100_continue = false; // Switch to normal response handling
  13824. }
  13825. }
  13826. // Receive response and headers
  13827. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13828. if ((!status_line_read &&
  13829. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13830. !detail::read_headers(strm, res.headers)) {
  13831. if (write_request_success) { error = Error::Read; }
  13832. output_error_log(error, &req);
  13833. return false;
  13834. }
  13835. if (!write_request_success) { return false; }
  13836. // Handle Expect: 100-continue response
  13837. if (expect_100_continue) {
  13838. if (res.status == StatusCode::Continue_100) {
  13839. // Server accepted, send the body
  13840. if (!write_request_body(strm, req, error)) { return false; }
  13841. // Read the actual response
  13842. res.headers.clear();
  13843. res.body.clear();
  13844. if (!read_response_line(strm, req, res) ||
  13845. !detail::read_headers(strm, res.headers)) {
  13846. error = Error::Read;
  13847. output_error_log(error, &req);
  13848. return false;
  13849. }
  13850. }
  13851. // If not 100 Continue, server returned an error; proceed with that response
  13852. }
  13853. // Body
  13854. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13855. req.method != "CONNECT") {
  13856. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  13857. // whose final transfer coding is not chunked is not ambiguous: its body
  13858. // runs until the server closes the connection, so it is not rejected.
  13859. // HEAD/204 are excluded above and a 304 carries no body.
  13860. if (res.status != StatusCode::NotModified_304 &&
  13861. detail::has_conflicting_content_length(res.headers)) {
  13862. error = Error::Read;
  13863. output_error_log(error, &req);
  13864. return false;
  13865. }
  13866. auto redirect = 300 < res.status && res.status < 400 &&
  13867. res.status != StatusCode::NotModified_304 &&
  13868. follow_location_;
  13869. if (req.response_handler && !redirect) {
  13870. if (!req.response_handler(res)) {
  13871. error = Error::Canceled;
  13872. output_error_log(error, &req);
  13873. return false;
  13874. }
  13875. }
  13876. auto out =
  13877. req.content_receiver
  13878. ? static_cast<ContentReceiverWithProgress>(
  13879. [&](const char *buf, size_t n, size_t off, size_t len) {
  13880. if (redirect) { return true; }
  13881. auto ret = req.content_receiver(buf, n, off, len);
  13882. if (!ret) {
  13883. error = Error::Canceled;
  13884. output_error_log(error, &req);
  13885. }
  13886. return ret;
  13887. })
  13888. : static_cast<ContentReceiverWithProgress>(
  13889. [&](const char *buf, size_t n, size_t /*off*/,
  13890. size_t /*len*/) {
  13891. assert(res.body.size() + n <= res.body.max_size());
  13892. if (payload_max_length_ > 0 &&
  13893. (res.body.size() >= payload_max_length_ ||
  13894. n > payload_max_length_ - res.body.size())) {
  13895. return false;
  13896. }
  13897. res.body.append(buf, n);
  13898. return true;
  13899. });
  13900. auto progress = [&](size_t current, size_t total) {
  13901. if (!req.download_progress || redirect) { return true; }
  13902. auto ret = req.download_progress(current, total);
  13903. if (!ret) {
  13904. error = Error::Canceled;
  13905. output_error_log(error, &req);
  13906. }
  13907. return ret;
  13908. };
  13909. if (res.has_header("Content-Length")) {
  13910. if (!req.content_receiver) {
  13911. auto len = res.get_header_value_u64("Content-Length");
  13912. if (len > res.body.max_size()) {
  13913. error = Error::Read;
  13914. output_error_log(error, &req);
  13915. return false;
  13916. }
  13917. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13918. // hostile or malformed server sends an enormous Content-Length.
  13919. // The actual body read below is bounded by payload_max_length_,
  13920. // so reserving more than that is never useful.
  13921. auto reserve_len = static_cast<size_t>(len);
  13922. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13923. reserve_len = payload_max_length_;
  13924. }
  13925. res.body.reserve(reserve_len);
  13926. }
  13927. }
  13928. if (res.status != StatusCode::NotModified_304) {
  13929. auto content_status = 0;
  13930. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13931. ? (std::numeric_limits<size_t>::max)()
  13932. : payload_max_length_;
  13933. if (!detail::read_content(strm, res, max_length, content_status,
  13934. std::move(progress), std::move(out),
  13935. decompress_)) {
  13936. if (error != Error::Canceled) {
  13937. // Tell the caller apart from a plain read failure when the body could
  13938. // not be decoded because of its Content-Encoding.
  13939. switch (content_status) {
  13940. case StatusCode::UnsupportedMediaType_415:
  13941. error = Error::UnsupportedContentEncoding;
  13942. break;
  13943. case StatusCode::InternalServerError_500:
  13944. error = Error::Compression;
  13945. break;
  13946. default: error = Error::Read; break;
  13947. }
  13948. }
  13949. output_error_log(error, &req);
  13950. return false;
  13951. }
  13952. }
  13953. }
  13954. // Log
  13955. output_log(req, res);
  13956. return true;
  13957. }
  13958. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13959. const std::string &boundary, const UploadFormDataItems &items,
  13960. const FormDataProviderItems &provider_items) const {
  13961. size_t cur_item = 0;
  13962. size_t cur_start = 0;
  13963. // cur_item and cur_start are copied to within the std::function and
  13964. // maintain state between successive calls
  13965. return [&, cur_item, cur_start](size_t offset,
  13966. DataSink &sink) mutable -> bool {
  13967. if (!offset && !items.empty()) {
  13968. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13969. return true;
  13970. } else if (cur_item < provider_items.size()) {
  13971. if (!cur_start) {
  13972. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13973. provider_items[cur_item], boundary);
  13974. offset += begin.size();
  13975. cur_start = offset;
  13976. sink.os << begin;
  13977. }
  13978. DataSink cur_sink;
  13979. auto has_data = true;
  13980. cur_sink.write = sink.write;
  13981. // Forward is_writable so a provider item asking whether it may keep
  13982. // going gets the outer sink's answer rather than the default `true`.
  13983. cur_sink.is_writable = sink.is_writable;
  13984. cur_sink.done = [&]() { has_data = false; };
  13985. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13986. return false;
  13987. }
  13988. if (!has_data) {
  13989. sink.os << detail::serialize_multipart_formdata_item_end();
  13990. cur_item++;
  13991. cur_start = 0;
  13992. }
  13993. return true;
  13994. } else {
  13995. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13996. sink.done();
  13997. return true;
  13998. }
  13999. };
  14000. }
  14001. inline bool ClientImpl::process_socket(
  14002. const Socket &socket,
  14003. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14004. std::function<bool(Stream &strm)> callback) {
  14005. return detail::process_client_socket(
  14006. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14007. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14008. }
  14009. inline bool ClientImpl::is_ssl() const { return false; }
  14010. inline Result ClientImpl::Get(const std::string &path,
  14011. DownloadProgress progress) {
  14012. return Get(path, Headers(), std::move(progress));
  14013. }
  14014. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14015. DownloadProgress progress) {
  14016. return Get(path, params, Headers(), std::move(progress));
  14017. }
  14018. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14019. const Headers &headers,
  14020. DownloadProgress progress) {
  14021. if (params.empty()) { return Get(path, headers); }
  14022. std::string path_with_query = append_query_params(path, params);
  14023. return Get(path_with_query, headers, std::move(progress));
  14024. }
  14025. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14026. DownloadProgress progress) {
  14027. Request req;
  14028. req.method = "GET";
  14029. req.path = path;
  14030. req.headers = headers;
  14031. req.download_progress = std::move(progress);
  14032. if (max_timeout_msec_ > 0) {
  14033. req.start_time_ = std::chrono::steady_clock::now();
  14034. }
  14035. return send_(std::move(req));
  14036. }
  14037. inline Result ClientImpl::Get(const std::string &path,
  14038. ContentReceiver content_receiver,
  14039. DownloadProgress progress) {
  14040. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14041. std::move(progress));
  14042. }
  14043. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14044. ContentReceiver content_receiver,
  14045. DownloadProgress progress) {
  14046. return Get(path, headers, nullptr, std::move(content_receiver),
  14047. std::move(progress));
  14048. }
  14049. inline Result ClientImpl::Get(const std::string &path,
  14050. ResponseHandler response_handler,
  14051. ContentReceiver content_receiver,
  14052. DownloadProgress progress) {
  14053. return Get(path, Headers(), std::move(response_handler),
  14054. std::move(content_receiver), std::move(progress));
  14055. }
  14056. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14057. ResponseHandler response_handler,
  14058. ContentReceiver content_receiver,
  14059. DownloadProgress progress) {
  14060. Request req;
  14061. req.method = "GET";
  14062. req.path = path;
  14063. req.headers = headers;
  14064. req.response_handler = std::move(response_handler);
  14065. req.content_receiver =
  14066. [content_receiver](const char *data, size_t data_length,
  14067. size_t /*offset*/, size_t /*total_length*/) {
  14068. return content_receiver(data, data_length);
  14069. };
  14070. req.download_progress = std::move(progress);
  14071. if (max_timeout_msec_ > 0) {
  14072. req.start_time_ = std::chrono::steady_clock::now();
  14073. }
  14074. return send_(std::move(req));
  14075. }
  14076. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14077. const Headers &headers,
  14078. ContentReceiver content_receiver,
  14079. DownloadProgress progress) {
  14080. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14081. std::move(progress));
  14082. }
  14083. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14084. const Headers &headers,
  14085. ResponseHandler response_handler,
  14086. ContentReceiver content_receiver,
  14087. DownloadProgress progress) {
  14088. if (params.empty()) {
  14089. return Get(path, headers, std::move(response_handler),
  14090. std::move(content_receiver), std::move(progress));
  14091. }
  14092. std::string path_with_query = append_query_params(path, params);
  14093. return Get(path_with_query, headers, std::move(response_handler),
  14094. std::move(content_receiver), std::move(progress));
  14095. }
  14096. inline Result ClientImpl::Head(const std::string &path) {
  14097. return Head(path, Headers());
  14098. }
  14099. inline Result ClientImpl::Head(const std::string &path,
  14100. const Headers &headers) {
  14101. Request req;
  14102. req.method = "HEAD";
  14103. req.headers = headers;
  14104. req.path = path;
  14105. if (max_timeout_msec_ > 0) {
  14106. req.start_time_ = std::chrono::steady_clock::now();
  14107. }
  14108. return send_(std::move(req));
  14109. }
  14110. inline Result ClientImpl::Post(const std::string &path) {
  14111. return Post(path, std::string(), std::string());
  14112. }
  14113. inline Result ClientImpl::Post(const std::string &path,
  14114. const Headers &headers) {
  14115. return Post(path, headers, nullptr, 0, std::string());
  14116. }
  14117. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14118. size_t content_length,
  14119. const std::string &content_type,
  14120. UploadProgress progress) {
  14121. return Post(path, Headers(), body, content_length, content_type, progress);
  14122. }
  14123. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14124. const std::string &content_type,
  14125. UploadProgress progress) {
  14126. return Post(path, Headers(), body, content_type, progress);
  14127. }
  14128. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14129. return Post(path, Headers(), params);
  14130. }
  14131. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14132. ContentProvider content_provider,
  14133. const std::string &content_type,
  14134. UploadProgress progress) {
  14135. return Post(path, Headers(), content_length, std::move(content_provider),
  14136. content_type, progress);
  14137. }
  14138. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14139. ContentProvider content_provider,
  14140. const std::string &content_type,
  14141. ContentReceiver content_receiver,
  14142. UploadProgress progress) {
  14143. return Post(path, Headers(), content_length, std::move(content_provider),
  14144. content_type, std::move(content_receiver), progress);
  14145. }
  14146. inline Result ClientImpl::Post(const std::string &path,
  14147. ContentProviderWithoutLength content_provider,
  14148. const std::string &content_type,
  14149. UploadProgress progress) {
  14150. return Post(path, Headers(), std::move(content_provider), content_type,
  14151. progress);
  14152. }
  14153. inline Result ClientImpl::Post(const std::string &path,
  14154. ContentProviderWithoutLength content_provider,
  14155. const std::string &content_type,
  14156. ContentReceiver content_receiver,
  14157. UploadProgress progress) {
  14158. return Post(path, Headers(), std::move(content_provider), content_type,
  14159. std::move(content_receiver), progress);
  14160. }
  14161. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14162. const Params &params) {
  14163. auto query = detail::params_to_query_str(params);
  14164. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14165. }
  14166. inline Result ClientImpl::Post(const std::string &path,
  14167. const UploadFormDataItems &items,
  14168. UploadProgress progress) {
  14169. return Post(path, Headers(), items, progress);
  14170. }
  14171. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14172. const UploadFormDataItems &items,
  14173. UploadProgress progress) {
  14174. const auto &boundary = detail::make_multipart_data_boundary();
  14175. const auto &content_type =
  14176. detail::serialize_multipart_formdata_get_content_type(boundary);
  14177. auto content_length = detail::get_multipart_content_length(items, boundary);
  14178. return Post(path, headers, content_length,
  14179. detail::make_multipart_content_provider(items, boundary),
  14180. content_type, progress);
  14181. }
  14182. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14183. const UploadFormDataItems &items,
  14184. const std::string &boundary,
  14185. UploadProgress progress) {
  14186. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14187. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14188. }
  14189. const auto &content_type =
  14190. detail::serialize_multipart_formdata_get_content_type(boundary);
  14191. auto content_length = detail::get_multipart_content_length(items, boundary);
  14192. return Post(path, headers, content_length,
  14193. detail::make_multipart_content_provider(items, boundary),
  14194. content_type, progress);
  14195. }
  14196. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14197. const char *body, size_t content_length,
  14198. const std::string &content_type,
  14199. UploadProgress progress) {
  14200. return send_with_content_provider_and_receiver(
  14201. "POST", path, headers, body, content_length, nullptr, nullptr,
  14202. content_type, nullptr, progress);
  14203. }
  14204. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14205. const std::string &body,
  14206. const std::string &content_type,
  14207. UploadProgress progress) {
  14208. return send_with_content_provider_and_receiver(
  14209. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14210. content_type, nullptr, progress);
  14211. }
  14212. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14213. size_t content_length,
  14214. ContentProvider content_provider,
  14215. const std::string &content_type,
  14216. UploadProgress progress) {
  14217. return send_with_content_provider_and_receiver(
  14218. "POST", path, headers, nullptr, content_length,
  14219. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14220. }
  14221. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14222. size_t content_length,
  14223. ContentProvider content_provider,
  14224. const std::string &content_type,
  14225. ContentReceiver content_receiver,
  14226. DownloadProgress progress) {
  14227. return send_with_content_provider_and_receiver(
  14228. "POST", path, headers, nullptr, content_length,
  14229. std::move(content_provider), nullptr, content_type,
  14230. std::move(content_receiver), std::move(progress));
  14231. }
  14232. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14233. ContentProviderWithoutLength content_provider,
  14234. const std::string &content_type,
  14235. UploadProgress progress) {
  14236. return send_with_content_provider_and_receiver(
  14237. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14238. content_type, nullptr, progress);
  14239. }
  14240. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14241. ContentProviderWithoutLength content_provider,
  14242. const std::string &content_type,
  14243. ContentReceiver content_receiver,
  14244. DownloadProgress progress) {
  14245. return send_with_content_provider_and_receiver(
  14246. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14247. content_type, std::move(content_receiver), std::move(progress));
  14248. }
  14249. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14250. const UploadFormDataItems &items,
  14251. const FormDataProviderItems &provider_items,
  14252. UploadProgress progress) {
  14253. const auto &boundary = detail::make_multipart_data_boundary();
  14254. const auto &content_type =
  14255. detail::serialize_multipart_formdata_get_content_type(boundary);
  14256. return send_with_content_provider_and_receiver(
  14257. "POST", path, headers, nullptr, 0, nullptr,
  14258. get_multipart_content_provider(boundary, items, provider_items),
  14259. content_type, nullptr, progress);
  14260. }
  14261. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14262. const std::string &body,
  14263. const std::string &content_type,
  14264. ContentReceiver content_receiver,
  14265. DownloadProgress progress) {
  14266. Request req;
  14267. req.method = "POST";
  14268. req.path = path;
  14269. req.headers = headers;
  14270. req.body = body;
  14271. req.content_receiver =
  14272. [content_receiver](const char *data, size_t data_length,
  14273. size_t /*offset*/, size_t /*total_length*/) {
  14274. return content_receiver(data, data_length);
  14275. };
  14276. req.download_progress = std::move(progress);
  14277. if (max_timeout_msec_ > 0) {
  14278. req.start_time_ = std::chrono::steady_clock::now();
  14279. }
  14280. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14281. return send_(std::move(req));
  14282. }
  14283. inline Result ClientImpl::Put(const std::string &path) {
  14284. return Put(path, std::string(), std::string());
  14285. }
  14286. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14287. return Put(path, headers, nullptr, 0, std::string());
  14288. }
  14289. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14290. size_t content_length,
  14291. const std::string &content_type,
  14292. UploadProgress progress) {
  14293. return Put(path, Headers(), body, content_length, content_type, progress);
  14294. }
  14295. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14296. const std::string &content_type,
  14297. UploadProgress progress) {
  14298. return Put(path, Headers(), body, content_type, progress);
  14299. }
  14300. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14301. return Put(path, Headers(), params);
  14302. }
  14303. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14304. ContentProvider content_provider,
  14305. const std::string &content_type,
  14306. UploadProgress progress) {
  14307. return Put(path, Headers(), content_length, std::move(content_provider),
  14308. content_type, progress);
  14309. }
  14310. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14311. ContentProvider content_provider,
  14312. const std::string &content_type,
  14313. ContentReceiver content_receiver,
  14314. UploadProgress progress) {
  14315. return Put(path, Headers(), content_length, std::move(content_provider),
  14316. content_type, std::move(content_receiver), progress);
  14317. }
  14318. inline Result ClientImpl::Put(const std::string &path,
  14319. ContentProviderWithoutLength content_provider,
  14320. const std::string &content_type,
  14321. UploadProgress progress) {
  14322. return Put(path, Headers(), std::move(content_provider), content_type,
  14323. progress);
  14324. }
  14325. inline Result ClientImpl::Put(const std::string &path,
  14326. ContentProviderWithoutLength content_provider,
  14327. const std::string &content_type,
  14328. ContentReceiver content_receiver,
  14329. UploadProgress progress) {
  14330. return Put(path, Headers(), std::move(content_provider), content_type,
  14331. std::move(content_receiver), progress);
  14332. }
  14333. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14334. const Params &params) {
  14335. auto query = detail::params_to_query_str(params);
  14336. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14337. }
  14338. inline Result ClientImpl::Put(const std::string &path,
  14339. const UploadFormDataItems &items,
  14340. UploadProgress progress) {
  14341. return Put(path, Headers(), items, progress);
  14342. }
  14343. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14344. const UploadFormDataItems &items,
  14345. UploadProgress progress) {
  14346. const auto &boundary = detail::make_multipart_data_boundary();
  14347. const auto &content_type =
  14348. detail::serialize_multipart_formdata_get_content_type(boundary);
  14349. auto content_length = detail::get_multipart_content_length(items, boundary);
  14350. return Put(path, headers, content_length,
  14351. detail::make_multipart_content_provider(items, boundary),
  14352. content_type, progress);
  14353. }
  14354. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14355. const UploadFormDataItems &items,
  14356. const std::string &boundary,
  14357. UploadProgress progress) {
  14358. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14359. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14360. }
  14361. const auto &content_type =
  14362. detail::serialize_multipart_formdata_get_content_type(boundary);
  14363. auto content_length = detail::get_multipart_content_length(items, boundary);
  14364. return Put(path, headers, content_length,
  14365. detail::make_multipart_content_provider(items, boundary),
  14366. content_type, progress);
  14367. }
  14368. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14369. const char *body, size_t content_length,
  14370. const std::string &content_type,
  14371. UploadProgress progress) {
  14372. return send_with_content_provider_and_receiver(
  14373. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14374. content_type, nullptr, progress);
  14375. }
  14376. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14377. const std::string &body,
  14378. const std::string &content_type,
  14379. UploadProgress progress) {
  14380. return send_with_content_provider_and_receiver(
  14381. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14382. content_type, nullptr, progress);
  14383. }
  14384. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14385. size_t content_length,
  14386. ContentProvider content_provider,
  14387. const std::string &content_type,
  14388. UploadProgress progress) {
  14389. return send_with_content_provider_and_receiver(
  14390. "PUT", path, headers, nullptr, content_length,
  14391. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14392. }
  14393. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14394. size_t content_length,
  14395. ContentProvider content_provider,
  14396. const std::string &content_type,
  14397. ContentReceiver content_receiver,
  14398. UploadProgress progress) {
  14399. return send_with_content_provider_and_receiver(
  14400. "PUT", path, headers, nullptr, content_length,
  14401. std::move(content_provider), nullptr, content_type,
  14402. std::move(content_receiver), progress);
  14403. }
  14404. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14405. ContentProviderWithoutLength content_provider,
  14406. const std::string &content_type,
  14407. UploadProgress progress) {
  14408. return send_with_content_provider_and_receiver(
  14409. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14410. content_type, nullptr, progress);
  14411. }
  14412. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14413. ContentProviderWithoutLength content_provider,
  14414. const std::string &content_type,
  14415. ContentReceiver content_receiver,
  14416. UploadProgress progress) {
  14417. return send_with_content_provider_and_receiver(
  14418. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14419. content_type, std::move(content_receiver), progress);
  14420. }
  14421. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14422. const UploadFormDataItems &items,
  14423. const FormDataProviderItems &provider_items,
  14424. UploadProgress progress) {
  14425. const auto &boundary = detail::make_multipart_data_boundary();
  14426. const auto &content_type =
  14427. detail::serialize_multipart_formdata_get_content_type(boundary);
  14428. return send_with_content_provider_and_receiver(
  14429. "PUT", path, headers, nullptr, 0, nullptr,
  14430. get_multipart_content_provider(boundary, items, provider_items),
  14431. content_type, nullptr, progress);
  14432. }
  14433. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14434. const std::string &body,
  14435. const std::string &content_type,
  14436. ContentReceiver content_receiver,
  14437. DownloadProgress progress) {
  14438. Request req;
  14439. req.method = "PUT";
  14440. req.path = path;
  14441. req.headers = headers;
  14442. req.body = body;
  14443. req.content_receiver =
  14444. [content_receiver](const char *data, size_t data_length,
  14445. size_t /*offset*/, size_t /*total_length*/) {
  14446. return content_receiver(data, data_length);
  14447. };
  14448. req.download_progress = std::move(progress);
  14449. if (max_timeout_msec_ > 0) {
  14450. req.start_time_ = std::chrono::steady_clock::now();
  14451. }
  14452. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14453. return send_(std::move(req));
  14454. }
  14455. inline Result ClientImpl::Patch(const std::string &path) {
  14456. return Patch(path, std::string(), std::string());
  14457. }
  14458. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14459. UploadProgress progress) {
  14460. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14461. }
  14462. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14463. size_t content_length,
  14464. const std::string &content_type,
  14465. UploadProgress progress) {
  14466. return Patch(path, Headers(), body, content_length, content_type, progress);
  14467. }
  14468. inline Result ClientImpl::Patch(const std::string &path,
  14469. const std::string &body,
  14470. const std::string &content_type,
  14471. UploadProgress progress) {
  14472. return Patch(path, Headers(), body, content_type, progress);
  14473. }
  14474. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14475. return Patch(path, Headers(), params);
  14476. }
  14477. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14478. ContentProvider content_provider,
  14479. const std::string &content_type,
  14480. UploadProgress progress) {
  14481. return Patch(path, Headers(), content_length, std::move(content_provider),
  14482. content_type, progress);
  14483. }
  14484. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14485. ContentProvider content_provider,
  14486. const std::string &content_type,
  14487. ContentReceiver content_receiver,
  14488. UploadProgress progress) {
  14489. return Patch(path, Headers(), content_length, std::move(content_provider),
  14490. content_type, std::move(content_receiver), progress);
  14491. }
  14492. inline Result ClientImpl::Patch(const std::string &path,
  14493. ContentProviderWithoutLength content_provider,
  14494. const std::string &content_type,
  14495. UploadProgress progress) {
  14496. return Patch(path, Headers(), std::move(content_provider), content_type,
  14497. progress);
  14498. }
  14499. inline Result ClientImpl::Patch(const std::string &path,
  14500. ContentProviderWithoutLength content_provider,
  14501. const std::string &content_type,
  14502. ContentReceiver content_receiver,
  14503. UploadProgress progress) {
  14504. return Patch(path, Headers(), std::move(content_provider), content_type,
  14505. std::move(content_receiver), progress);
  14506. }
  14507. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14508. const Params &params) {
  14509. auto query = detail::params_to_query_str(params);
  14510. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14511. }
  14512. inline Result ClientImpl::Patch(const std::string &path,
  14513. const UploadFormDataItems &items,
  14514. UploadProgress progress) {
  14515. return Patch(path, Headers(), items, progress);
  14516. }
  14517. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14518. const UploadFormDataItems &items,
  14519. UploadProgress progress) {
  14520. const auto &boundary = detail::make_multipart_data_boundary();
  14521. const auto &content_type =
  14522. detail::serialize_multipart_formdata_get_content_type(boundary);
  14523. auto content_length = detail::get_multipart_content_length(items, boundary);
  14524. return Patch(path, headers, content_length,
  14525. detail::make_multipart_content_provider(items, boundary),
  14526. content_type, progress);
  14527. }
  14528. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14529. const UploadFormDataItems &items,
  14530. const std::string &boundary,
  14531. UploadProgress progress) {
  14532. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14533. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14534. }
  14535. const auto &content_type =
  14536. detail::serialize_multipart_formdata_get_content_type(boundary);
  14537. auto content_length = detail::get_multipart_content_length(items, boundary);
  14538. return Patch(path, headers, content_length,
  14539. detail::make_multipart_content_provider(items, boundary),
  14540. content_type, progress);
  14541. }
  14542. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14543. const char *body, size_t content_length,
  14544. const std::string &content_type,
  14545. UploadProgress progress) {
  14546. return send_with_content_provider_and_receiver(
  14547. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14548. content_type, nullptr, progress);
  14549. }
  14550. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14551. const std::string &body,
  14552. const std::string &content_type,
  14553. UploadProgress progress) {
  14554. return send_with_content_provider_and_receiver(
  14555. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14556. content_type, nullptr, progress);
  14557. }
  14558. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14559. size_t content_length,
  14560. ContentProvider content_provider,
  14561. const std::string &content_type,
  14562. UploadProgress progress) {
  14563. return send_with_content_provider_and_receiver(
  14564. "PATCH", path, headers, nullptr, content_length,
  14565. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14566. }
  14567. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14568. size_t content_length,
  14569. ContentProvider content_provider,
  14570. const std::string &content_type,
  14571. ContentReceiver content_receiver,
  14572. UploadProgress progress) {
  14573. return send_with_content_provider_and_receiver(
  14574. "PATCH", path, headers, nullptr, content_length,
  14575. std::move(content_provider), nullptr, content_type,
  14576. std::move(content_receiver), progress);
  14577. }
  14578. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14579. ContentProviderWithoutLength content_provider,
  14580. const std::string &content_type,
  14581. UploadProgress progress) {
  14582. return send_with_content_provider_and_receiver(
  14583. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14584. content_type, nullptr, progress);
  14585. }
  14586. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14587. ContentProviderWithoutLength content_provider,
  14588. const std::string &content_type,
  14589. ContentReceiver content_receiver,
  14590. UploadProgress progress) {
  14591. return send_with_content_provider_and_receiver(
  14592. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14593. content_type, std::move(content_receiver), progress);
  14594. }
  14595. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14596. const UploadFormDataItems &items,
  14597. const FormDataProviderItems &provider_items,
  14598. UploadProgress progress) {
  14599. const auto &boundary = detail::make_multipart_data_boundary();
  14600. const auto &content_type =
  14601. detail::serialize_multipart_formdata_get_content_type(boundary);
  14602. return send_with_content_provider_and_receiver(
  14603. "PATCH", path, headers, nullptr, 0, nullptr,
  14604. get_multipart_content_provider(boundary, items, provider_items),
  14605. content_type, nullptr, progress);
  14606. }
  14607. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14608. const std::string &body,
  14609. const std::string &content_type,
  14610. ContentReceiver content_receiver,
  14611. DownloadProgress progress) {
  14612. Request req;
  14613. req.method = "PATCH";
  14614. req.path = path;
  14615. req.headers = headers;
  14616. req.body = body;
  14617. req.content_receiver =
  14618. [content_receiver](const char *data, size_t data_length,
  14619. size_t /*offset*/, size_t /*total_length*/) {
  14620. return content_receiver(data, data_length);
  14621. };
  14622. req.download_progress = std::move(progress);
  14623. if (max_timeout_msec_ > 0) {
  14624. req.start_time_ = std::chrono::steady_clock::now();
  14625. }
  14626. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14627. return send_(std::move(req));
  14628. }
  14629. inline Result ClientImpl::Delete(const std::string &path,
  14630. DownloadProgress progress) {
  14631. return Delete(path, Headers(), std::string(), std::string(), progress);
  14632. }
  14633. inline Result ClientImpl::Delete(const std::string &path,
  14634. const Headers &headers,
  14635. DownloadProgress progress) {
  14636. return Delete(path, headers, std::string(), std::string(), progress);
  14637. }
  14638. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14639. size_t content_length,
  14640. const std::string &content_type,
  14641. DownloadProgress progress) {
  14642. return Delete(path, Headers(), body, content_length, content_type, progress);
  14643. }
  14644. inline Result ClientImpl::Delete(const std::string &path,
  14645. const std::string &body,
  14646. const std::string &content_type,
  14647. DownloadProgress progress) {
  14648. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14649. progress);
  14650. }
  14651. inline Result ClientImpl::Delete(const std::string &path,
  14652. const Headers &headers,
  14653. const std::string &body,
  14654. const std::string &content_type,
  14655. DownloadProgress progress) {
  14656. return Delete(path, headers, body.data(), body.size(), content_type,
  14657. progress);
  14658. }
  14659. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14660. DownloadProgress progress) {
  14661. return Delete(path, Headers(), params, progress);
  14662. }
  14663. inline Result ClientImpl::Delete(const std::string &path,
  14664. const Headers &headers, const Params &params,
  14665. DownloadProgress progress) {
  14666. auto query = detail::params_to_query_str(params);
  14667. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14668. progress);
  14669. }
  14670. inline Result ClientImpl::Delete(const std::string &path,
  14671. const Headers &headers, const char *body,
  14672. size_t content_length,
  14673. const std::string &content_type,
  14674. DownloadProgress progress) {
  14675. Request req;
  14676. req.method = "DELETE";
  14677. req.headers = headers;
  14678. req.path = path;
  14679. req.download_progress = std::move(progress);
  14680. if (max_timeout_msec_ > 0) {
  14681. req.start_time_ = std::chrono::steady_clock::now();
  14682. }
  14683. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14684. req.body.assign(body, content_length);
  14685. return send_(std::move(req));
  14686. }
  14687. inline Result ClientImpl::Options(const std::string &path) {
  14688. return Options(path, Headers());
  14689. }
  14690. inline Result ClientImpl::Options(const std::string &path,
  14691. const Headers &headers) {
  14692. Request req;
  14693. req.method = "OPTIONS";
  14694. req.headers = headers;
  14695. req.path = path;
  14696. if (max_timeout_msec_ > 0) {
  14697. req.start_time_ = std::chrono::steady_clock::now();
  14698. }
  14699. return send_(std::move(req));
  14700. }
  14701. inline void ClientImpl::stop() {
  14702. std::lock_guard<std::mutex> guard(socket_mutex_);
  14703. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14704. // do is to shutdown_socket, so that threads using this socket suddenly
  14705. // discover they can't read/write any more and error out. Everything else
  14706. // (closing the socket, shutting ssl down) is unsafe because these actions
  14707. // are not thread-safe.
  14708. if (socket_requests_in_flight_ > 0) {
  14709. shutdown_socket(socket_);
  14710. // Aside from that, we set a flag for the socket to be closed when we're
  14711. // done.
  14712. socket_should_be_closed_when_request_is_done_ = true;
  14713. return;
  14714. }
  14715. disconnect(/*gracefully=*/true);
  14716. }
  14717. inline std::string ClientImpl::host() const { return host_; }
  14718. inline int ClientImpl::port() const { return port_; }
  14719. inline size_t ClientImpl::is_socket_open() const {
  14720. std::lock_guard<std::mutex> guard(socket_mutex_);
  14721. return socket_.is_open();
  14722. }
  14723. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14724. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14725. connection_timeout_sec_ = sec;
  14726. connection_timeout_usec_ = usec;
  14727. }
  14728. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14729. read_timeout_sec_ = sec;
  14730. read_timeout_usec_ = usec;
  14731. }
  14732. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14733. write_timeout_sec_ = sec;
  14734. write_timeout_usec_ = usec;
  14735. }
  14736. inline void ClientImpl::set_max_timeout(time_t msec) {
  14737. max_timeout_msec_ = msec;
  14738. }
  14739. inline void ClientImpl::set_basic_auth(const std::string &username,
  14740. const std::string &password) {
  14741. basic_auth_username_ = username;
  14742. basic_auth_password_ = password;
  14743. }
  14744. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14745. bearer_token_auth_token_ = token;
  14746. }
  14747. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14748. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14749. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14750. inline void
  14751. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14752. addr_map_ = std::move(addr_map);
  14753. }
  14754. inline void ClientImpl::set_default_headers(Headers headers) {
  14755. default_headers_ = std::move(headers);
  14756. }
  14757. inline void ClientImpl::set_header_writer(
  14758. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14759. header_writer_ = writer;
  14760. }
  14761. inline void ClientImpl::set_address_family(int family) {
  14762. address_family_ = family;
  14763. }
  14764. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14765. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14766. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14767. socket_options_ = std::move(socket_options);
  14768. }
  14769. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14770. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14771. inline void ClientImpl::set_payload_max_length(size_t length) {
  14772. payload_max_length_ = length;
  14773. has_payload_max_length_ = true;
  14774. }
  14775. inline void ClientImpl::set_interface(const std::string &intf) {
  14776. interface_ = intf;
  14777. }
  14778. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14779. proxy_host_ = host;
  14780. proxy_port_ = port;
  14781. std::lock_guard<std::mutex> guard(socket_mutex_);
  14782. disconnect(/*gracefully=*/true);
  14783. }
  14784. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14785. const std::string &password) {
  14786. proxy_basic_auth_username_ = username;
  14787. proxy_basic_auth_password_ = password;
  14788. }
  14789. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14790. proxy_bearer_token_auth_token_ = token;
  14791. }
  14792. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14793. std::vector<detail::NoProxyEntry> parsed;
  14794. parsed.reserve(patterns.size());
  14795. for (const auto &p : patterns) {
  14796. auto trimmed = detail::trim_copy(p);
  14797. if (trimmed.empty()) { continue; }
  14798. detail::NoProxyEntry entry;
  14799. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14800. parsed.push_back(std::move(entry));
  14801. }
  14802. }
  14803. no_proxy_entries_ = std::move(parsed);
  14804. std::lock_guard<std::mutex> guard(socket_mutex_);
  14805. disconnect(/*gracefully=*/true);
  14806. }
  14807. #ifdef CPPHTTPLIB_SSL_ENABLED
  14808. inline void ClientImpl::set_digest_auth(const std::string &username,
  14809. const std::string &password) {
  14810. digest_auth_username_ = username;
  14811. digest_auth_password_ = password;
  14812. }
  14813. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14814. const std::string &ca_cert_dir_path) {
  14815. ca_cert_file_path_ = ca_cert_file_path;
  14816. ca_cert_dir_path_ = ca_cert_dir_path;
  14817. }
  14818. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14819. const std::string &password) {
  14820. proxy_digest_auth_username_ = username;
  14821. proxy_digest_auth_password_ = password;
  14822. }
  14823. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14824. server_certificate_verification_ = enabled;
  14825. }
  14826. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14827. server_hostname_verification_ = enabled;
  14828. }
  14829. inline void ClientImpl::enable_system_ca(bool enabled) {
  14830. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14831. }
  14832. #endif
  14833. inline void ClientImpl::set_logger(Logger logger) {
  14834. logger_ = std::move(logger);
  14835. }
  14836. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14837. error_logger_ = std::move(error_logger);
  14838. }
  14839. /*
  14840. * SSL/TLS Common Implementation
  14841. */
  14842. inline ClientConnection::~ClientConnection() {
  14843. #ifdef CPPHTTPLIB_SSL_ENABLED
  14844. if (session) {
  14845. tls::shutdown(session, true);
  14846. tls::free_session(session);
  14847. session = nullptr;
  14848. }
  14849. #endif
  14850. if (sock != INVALID_SOCKET) {
  14851. detail::close_socket(sock);
  14852. sock = INVALID_SOCKET;
  14853. }
  14854. }
  14855. // Universal client implementation
  14856. inline Client::Client(const std::string &scheme_host_port)
  14857. : Client(scheme_host_port, std::string(), std::string()) {}
  14858. inline Client::Client(const std::string &scheme_host_port,
  14859. const std::string &client_cert_path,
  14860. const std::string &client_key_path) {
  14861. detail::UrlComponents uc;
  14862. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14863. auto &scheme = uc.scheme;
  14864. #ifdef CPPHTTPLIB_SSL_ENABLED
  14865. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14866. #else
  14867. if (!scheme.empty() && scheme != "http") {
  14868. #endif
  14869. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14870. std::string msg = "'" + scheme + "' scheme is not supported.";
  14871. throw std::invalid_argument(msg);
  14872. #endif
  14873. return;
  14874. }
  14875. auto is_ssl = scheme == "https";
  14876. auto host = std::move(uc.host);
  14877. auto port = is_ssl ? 443 : 80;
  14878. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14879. if (is_ssl) {
  14880. #ifdef CPPHTTPLIB_SSL_ENABLED
  14881. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14882. client_key_path);
  14883. is_ssl_ = is_ssl;
  14884. #endif
  14885. } else {
  14886. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14887. client_key_path);
  14888. }
  14889. } else {
  14890. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14891. // if port param below changes.
  14892. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14893. client_cert_path, client_key_path);
  14894. }
  14895. }
  14896. inline Client::Client(const std::string &host, int port)
  14897. : Client(host, port, std::string(), std::string()) {}
  14898. inline Client::Client(const std::string &host, int port,
  14899. const std::string &client_cert_path,
  14900. const std::string &client_key_path)
  14901. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14902. client_key_path)) {}
  14903. inline Client::~Client() = default;
  14904. inline bool Client::is_valid() const {
  14905. return cli_ != nullptr && cli_->is_valid();
  14906. }
  14907. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14908. return cli_->Get(path, std::move(progress));
  14909. }
  14910. inline Result Client::Get(const std::string &path, const Headers &headers,
  14911. DownloadProgress progress) {
  14912. return cli_->Get(path, headers, std::move(progress));
  14913. }
  14914. inline Result Client::Get(const std::string &path,
  14915. ContentReceiver content_receiver,
  14916. DownloadProgress progress) {
  14917. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14918. }
  14919. inline Result Client::Get(const std::string &path, const Headers &headers,
  14920. ContentReceiver content_receiver,
  14921. DownloadProgress progress) {
  14922. return cli_->Get(path, headers, std::move(content_receiver),
  14923. std::move(progress));
  14924. }
  14925. inline Result Client::Get(const std::string &path,
  14926. ResponseHandler response_handler,
  14927. ContentReceiver content_receiver,
  14928. DownloadProgress progress) {
  14929. return cli_->Get(path, std::move(response_handler),
  14930. std::move(content_receiver), std::move(progress));
  14931. }
  14932. inline Result Client::Get(const std::string &path, const Headers &headers,
  14933. ResponseHandler response_handler,
  14934. ContentReceiver content_receiver,
  14935. DownloadProgress progress) {
  14936. return cli_->Get(path, headers, std::move(response_handler),
  14937. std::move(content_receiver), std::move(progress));
  14938. }
  14939. inline Result Client::Get(const std::string &path, const Params &params,
  14940. DownloadProgress progress) {
  14941. return cli_->Get(path, params, std::move(progress));
  14942. }
  14943. inline Result Client::Get(const std::string &path, const Params &params,
  14944. const Headers &headers, DownloadProgress progress) {
  14945. return cli_->Get(path, params, headers, std::move(progress));
  14946. }
  14947. inline Result Client::Get(const std::string &path, const Params &params,
  14948. const Headers &headers,
  14949. ContentReceiver content_receiver,
  14950. DownloadProgress progress) {
  14951. return cli_->Get(path, params, headers, std::move(content_receiver),
  14952. std::move(progress));
  14953. }
  14954. inline Result Client::Get(const std::string &path, const Params &params,
  14955. const Headers &headers,
  14956. ResponseHandler response_handler,
  14957. ContentReceiver content_receiver,
  14958. DownloadProgress progress) {
  14959. return cli_->Get(path, params, headers, std::move(response_handler),
  14960. std::move(content_receiver), std::move(progress));
  14961. }
  14962. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14963. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14964. return cli_->Head(path, headers);
  14965. }
  14966. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14967. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14968. return cli_->Post(path, headers);
  14969. }
  14970. inline Result Client::Post(const std::string &path, const char *body,
  14971. size_t content_length,
  14972. const std::string &content_type,
  14973. UploadProgress progress) {
  14974. return cli_->Post(path, body, content_length, content_type, progress);
  14975. }
  14976. inline Result Client::Post(const std::string &path, const Headers &headers,
  14977. const char *body, size_t content_length,
  14978. const std::string &content_type,
  14979. UploadProgress progress) {
  14980. return cli_->Post(path, headers, body, content_length, content_type,
  14981. progress);
  14982. }
  14983. inline Result Client::Post(const std::string &path, const std::string &body,
  14984. const std::string &content_type,
  14985. UploadProgress progress) {
  14986. return cli_->Post(path, body, content_type, progress);
  14987. }
  14988. inline Result Client::Post(const std::string &path, const Headers &headers,
  14989. const std::string &body,
  14990. const std::string &content_type,
  14991. UploadProgress progress) {
  14992. return cli_->Post(path, headers, body, content_type, progress);
  14993. }
  14994. inline Result Client::Post(const std::string &path, size_t content_length,
  14995. ContentProvider content_provider,
  14996. const std::string &content_type,
  14997. UploadProgress progress) {
  14998. return cli_->Post(path, content_length, std::move(content_provider),
  14999. content_type, progress);
  15000. }
  15001. inline Result Client::Post(const std::string &path, size_t content_length,
  15002. ContentProvider content_provider,
  15003. const std::string &content_type,
  15004. ContentReceiver content_receiver,
  15005. UploadProgress progress) {
  15006. return cli_->Post(path, content_length, std::move(content_provider),
  15007. content_type, std::move(content_receiver), progress);
  15008. }
  15009. inline Result Client::Post(const std::string &path,
  15010. ContentProviderWithoutLength content_provider,
  15011. const std::string &content_type,
  15012. UploadProgress progress) {
  15013. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15014. }
  15015. inline Result Client::Post(const std::string &path,
  15016. ContentProviderWithoutLength content_provider,
  15017. const std::string &content_type,
  15018. ContentReceiver content_receiver,
  15019. UploadProgress progress) {
  15020. return cli_->Post(path, std::move(content_provider), content_type,
  15021. std::move(content_receiver), progress);
  15022. }
  15023. inline Result Client::Post(const std::string &path, const Headers &headers,
  15024. size_t content_length,
  15025. ContentProvider content_provider,
  15026. const std::string &content_type,
  15027. UploadProgress progress) {
  15028. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15029. content_type, progress);
  15030. }
  15031. inline Result Client::Post(const std::string &path, const Headers &headers,
  15032. size_t content_length,
  15033. ContentProvider content_provider,
  15034. const std::string &content_type,
  15035. ContentReceiver content_receiver,
  15036. DownloadProgress progress) {
  15037. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15038. content_type, std::move(content_receiver), progress);
  15039. }
  15040. inline Result Client::Post(const std::string &path, const Headers &headers,
  15041. ContentProviderWithoutLength content_provider,
  15042. const std::string &content_type,
  15043. UploadProgress progress) {
  15044. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15045. progress);
  15046. }
  15047. inline Result Client::Post(const std::string &path, const Headers &headers,
  15048. ContentProviderWithoutLength content_provider,
  15049. const std::string &content_type,
  15050. ContentReceiver content_receiver,
  15051. DownloadProgress progress) {
  15052. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15053. std::move(content_receiver), progress);
  15054. }
  15055. inline Result Client::Post(const std::string &path, const Params &params) {
  15056. return cli_->Post(path, params);
  15057. }
  15058. inline Result Client::Post(const std::string &path, const Headers &headers,
  15059. const Params &params) {
  15060. return cli_->Post(path, headers, params);
  15061. }
  15062. inline Result Client::Post(const std::string &path,
  15063. const UploadFormDataItems &items,
  15064. UploadProgress progress) {
  15065. return cli_->Post(path, items, progress);
  15066. }
  15067. inline Result Client::Post(const std::string &path, const Headers &headers,
  15068. const UploadFormDataItems &items,
  15069. UploadProgress progress) {
  15070. return cli_->Post(path, headers, items, progress);
  15071. }
  15072. inline Result Client::Post(const std::string &path, const Headers &headers,
  15073. const UploadFormDataItems &items,
  15074. const std::string &boundary,
  15075. UploadProgress progress) {
  15076. return cli_->Post(path, headers, items, boundary, progress);
  15077. }
  15078. inline Result Client::Post(const std::string &path, const Headers &headers,
  15079. const UploadFormDataItems &items,
  15080. const FormDataProviderItems &provider_items,
  15081. UploadProgress progress) {
  15082. return cli_->Post(path, headers, items, provider_items, progress);
  15083. }
  15084. inline Result Client::Post(const std::string &path, const Headers &headers,
  15085. const std::string &body,
  15086. const std::string &content_type,
  15087. ContentReceiver content_receiver,
  15088. DownloadProgress progress) {
  15089. return cli_->Post(path, headers, body, content_type,
  15090. std::move(content_receiver), progress);
  15091. }
  15092. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15093. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15094. return cli_->Put(path, headers);
  15095. }
  15096. inline Result Client::Put(const std::string &path, const char *body,
  15097. size_t content_length,
  15098. const std::string &content_type,
  15099. UploadProgress progress) {
  15100. return cli_->Put(path, body, content_length, content_type, progress);
  15101. }
  15102. inline Result Client::Put(const std::string &path, const Headers &headers,
  15103. const char *body, size_t content_length,
  15104. const std::string &content_type,
  15105. UploadProgress progress) {
  15106. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15107. }
  15108. inline Result Client::Put(const std::string &path, const std::string &body,
  15109. const std::string &content_type,
  15110. UploadProgress progress) {
  15111. return cli_->Put(path, body, content_type, progress);
  15112. }
  15113. inline Result Client::Put(const std::string &path, const Headers &headers,
  15114. const std::string &body,
  15115. const std::string &content_type,
  15116. UploadProgress progress) {
  15117. return cli_->Put(path, headers, body, content_type, progress);
  15118. }
  15119. inline Result Client::Put(const std::string &path, size_t content_length,
  15120. ContentProvider content_provider,
  15121. const std::string &content_type,
  15122. UploadProgress progress) {
  15123. return cli_->Put(path, content_length, std::move(content_provider),
  15124. content_type, progress);
  15125. }
  15126. inline Result Client::Put(const std::string &path, size_t content_length,
  15127. ContentProvider content_provider,
  15128. const std::string &content_type,
  15129. ContentReceiver content_receiver,
  15130. UploadProgress progress) {
  15131. return cli_->Put(path, content_length, std::move(content_provider),
  15132. content_type, std::move(content_receiver), progress);
  15133. }
  15134. inline Result Client::Put(const std::string &path,
  15135. ContentProviderWithoutLength content_provider,
  15136. const std::string &content_type,
  15137. UploadProgress progress) {
  15138. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15139. }
  15140. inline Result Client::Put(const std::string &path,
  15141. ContentProviderWithoutLength content_provider,
  15142. const std::string &content_type,
  15143. ContentReceiver content_receiver,
  15144. UploadProgress progress) {
  15145. return cli_->Put(path, std::move(content_provider), content_type,
  15146. std::move(content_receiver), progress);
  15147. }
  15148. inline Result Client::Put(const std::string &path, const Headers &headers,
  15149. size_t content_length,
  15150. ContentProvider content_provider,
  15151. const std::string &content_type,
  15152. UploadProgress progress) {
  15153. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15154. content_type, progress);
  15155. }
  15156. inline Result Client::Put(const std::string &path, const Headers &headers,
  15157. size_t content_length,
  15158. ContentProvider content_provider,
  15159. const std::string &content_type,
  15160. ContentReceiver content_receiver,
  15161. UploadProgress progress) {
  15162. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15163. content_type, std::move(content_receiver), progress);
  15164. }
  15165. inline Result Client::Put(const std::string &path, const Headers &headers,
  15166. ContentProviderWithoutLength content_provider,
  15167. const std::string &content_type,
  15168. UploadProgress progress) {
  15169. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15170. progress);
  15171. }
  15172. inline Result Client::Put(const std::string &path, const Headers &headers,
  15173. ContentProviderWithoutLength content_provider,
  15174. const std::string &content_type,
  15175. ContentReceiver content_receiver,
  15176. UploadProgress progress) {
  15177. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15178. std::move(content_receiver), progress);
  15179. }
  15180. inline Result Client::Put(const std::string &path, const Params &params) {
  15181. return cli_->Put(path, params);
  15182. }
  15183. inline Result Client::Put(const std::string &path, const Headers &headers,
  15184. const Params &params) {
  15185. return cli_->Put(path, headers, params);
  15186. }
  15187. inline Result Client::Put(const std::string &path,
  15188. const UploadFormDataItems &items,
  15189. UploadProgress progress) {
  15190. return cli_->Put(path, items, progress);
  15191. }
  15192. inline Result Client::Put(const std::string &path, const Headers &headers,
  15193. const UploadFormDataItems &items,
  15194. UploadProgress progress) {
  15195. return cli_->Put(path, headers, items, progress);
  15196. }
  15197. inline Result Client::Put(const std::string &path, const Headers &headers,
  15198. const UploadFormDataItems &items,
  15199. const std::string &boundary,
  15200. UploadProgress progress) {
  15201. return cli_->Put(path, headers, items, boundary, progress);
  15202. }
  15203. inline Result Client::Put(const std::string &path, const Headers &headers,
  15204. const UploadFormDataItems &items,
  15205. const FormDataProviderItems &provider_items,
  15206. UploadProgress progress) {
  15207. return cli_->Put(path, headers, items, provider_items, progress);
  15208. }
  15209. inline Result Client::Put(const std::string &path, const Headers &headers,
  15210. const std::string &body,
  15211. const std::string &content_type,
  15212. ContentReceiver content_receiver,
  15213. DownloadProgress progress) {
  15214. return cli_->Put(path, headers, body, content_type, content_receiver,
  15215. progress);
  15216. }
  15217. inline Result Client::Patch(const std::string &path) {
  15218. return cli_->Patch(path);
  15219. }
  15220. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15221. return cli_->Patch(path, headers);
  15222. }
  15223. inline Result Client::Patch(const std::string &path, const char *body,
  15224. size_t content_length,
  15225. const std::string &content_type,
  15226. UploadProgress progress) {
  15227. return cli_->Patch(path, body, content_length, content_type, progress);
  15228. }
  15229. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15230. const char *body, size_t content_length,
  15231. const std::string &content_type,
  15232. UploadProgress progress) {
  15233. return cli_->Patch(path, headers, body, content_length, content_type,
  15234. progress);
  15235. }
  15236. inline Result Client::Patch(const std::string &path, const std::string &body,
  15237. const std::string &content_type,
  15238. UploadProgress progress) {
  15239. return cli_->Patch(path, body, content_type, progress);
  15240. }
  15241. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15242. const std::string &body,
  15243. const std::string &content_type,
  15244. UploadProgress progress) {
  15245. return cli_->Patch(path, headers, body, content_type, progress);
  15246. }
  15247. inline Result Client::Patch(const std::string &path, size_t content_length,
  15248. ContentProvider content_provider,
  15249. const std::string &content_type,
  15250. UploadProgress progress) {
  15251. return cli_->Patch(path, content_length, std::move(content_provider),
  15252. content_type, progress);
  15253. }
  15254. inline Result Client::Patch(const std::string &path, size_t content_length,
  15255. ContentProvider content_provider,
  15256. const std::string &content_type,
  15257. ContentReceiver content_receiver,
  15258. UploadProgress progress) {
  15259. return cli_->Patch(path, content_length, std::move(content_provider),
  15260. content_type, std::move(content_receiver), progress);
  15261. }
  15262. inline Result Client::Patch(const std::string &path,
  15263. ContentProviderWithoutLength content_provider,
  15264. const std::string &content_type,
  15265. UploadProgress progress) {
  15266. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15267. }
  15268. inline Result Client::Patch(const std::string &path,
  15269. ContentProviderWithoutLength content_provider,
  15270. const std::string &content_type,
  15271. ContentReceiver content_receiver,
  15272. UploadProgress progress) {
  15273. return cli_->Patch(path, std::move(content_provider), content_type,
  15274. std::move(content_receiver), progress);
  15275. }
  15276. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15277. size_t content_length,
  15278. ContentProvider content_provider,
  15279. const std::string &content_type,
  15280. UploadProgress progress) {
  15281. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15282. content_type, progress);
  15283. }
  15284. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15285. size_t content_length,
  15286. ContentProvider content_provider,
  15287. const std::string &content_type,
  15288. ContentReceiver content_receiver,
  15289. UploadProgress progress) {
  15290. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15291. content_type, std::move(content_receiver), progress);
  15292. }
  15293. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15294. ContentProviderWithoutLength content_provider,
  15295. const std::string &content_type,
  15296. UploadProgress progress) {
  15297. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15298. progress);
  15299. }
  15300. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15301. ContentProviderWithoutLength content_provider,
  15302. const std::string &content_type,
  15303. ContentReceiver content_receiver,
  15304. UploadProgress progress) {
  15305. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15306. std::move(content_receiver), progress);
  15307. }
  15308. inline Result Client::Patch(const std::string &path, const Params &params) {
  15309. return cli_->Patch(path, params);
  15310. }
  15311. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15312. const Params &params) {
  15313. return cli_->Patch(path, headers, params);
  15314. }
  15315. inline Result Client::Patch(const std::string &path,
  15316. const UploadFormDataItems &items,
  15317. UploadProgress progress) {
  15318. return cli_->Patch(path, items, progress);
  15319. }
  15320. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15321. const UploadFormDataItems &items,
  15322. UploadProgress progress) {
  15323. return cli_->Patch(path, headers, items, progress);
  15324. }
  15325. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15326. const UploadFormDataItems &items,
  15327. const std::string &boundary,
  15328. UploadProgress progress) {
  15329. return cli_->Patch(path, headers, items, boundary, progress);
  15330. }
  15331. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15332. const UploadFormDataItems &items,
  15333. const FormDataProviderItems &provider_items,
  15334. UploadProgress progress) {
  15335. return cli_->Patch(path, headers, items, provider_items, progress);
  15336. }
  15337. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15338. const std::string &body,
  15339. const std::string &content_type,
  15340. ContentReceiver content_receiver,
  15341. DownloadProgress progress) {
  15342. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15343. progress);
  15344. }
  15345. inline Result Client::Delete(const std::string &path,
  15346. DownloadProgress progress) {
  15347. return cli_->Delete(path, progress);
  15348. }
  15349. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15350. DownloadProgress progress) {
  15351. return cli_->Delete(path, headers, progress);
  15352. }
  15353. inline Result Client::Delete(const std::string &path, const char *body,
  15354. size_t content_length,
  15355. const std::string &content_type,
  15356. DownloadProgress progress) {
  15357. return cli_->Delete(path, body, content_length, content_type, progress);
  15358. }
  15359. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15360. const char *body, size_t content_length,
  15361. const std::string &content_type,
  15362. DownloadProgress progress) {
  15363. return cli_->Delete(path, headers, body, content_length, content_type,
  15364. progress);
  15365. }
  15366. inline Result Client::Delete(const std::string &path, const std::string &body,
  15367. const std::string &content_type,
  15368. DownloadProgress progress) {
  15369. return cli_->Delete(path, body, content_type, progress);
  15370. }
  15371. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15372. const std::string &body,
  15373. const std::string &content_type,
  15374. DownloadProgress progress) {
  15375. return cli_->Delete(path, headers, body, content_type, progress);
  15376. }
  15377. inline Result Client::Delete(const std::string &path, const Params &params,
  15378. DownloadProgress progress) {
  15379. return cli_->Delete(path, params, progress);
  15380. }
  15381. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15382. const Params &params, DownloadProgress progress) {
  15383. return cli_->Delete(path, headers, params, progress);
  15384. }
  15385. inline Result Client::Options(const std::string &path) {
  15386. return cli_->Options(path);
  15387. }
  15388. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15389. return cli_->Options(path, headers);
  15390. }
  15391. inline ClientImpl::StreamHandle
  15392. Client::open_stream(const std::string &method, const std::string &path,
  15393. const Params &params, const Headers &headers,
  15394. const std::string &body, const std::string &content_type) {
  15395. return cli_->open_stream(method, path, params, headers, body, content_type);
  15396. }
  15397. inline bool Client::send(Request &req, Response &res, Error &error) {
  15398. return cli_->send(req, res, error);
  15399. }
  15400. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15401. inline void Client::stop() { cli_->stop(); }
  15402. inline std::string Client::host() const { return cli_->host(); }
  15403. inline int Client::port() const { return cli_->port(); }
  15404. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15405. inline socket_t Client::socket() const { return cli_->socket(); }
  15406. inline void
  15407. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15408. cli_->set_hostname_addr_map(std::move(addr_map));
  15409. }
  15410. inline void Client::set_default_headers(Headers headers) {
  15411. cli_->set_default_headers(std::move(headers));
  15412. }
  15413. inline void Client::set_header_writer(
  15414. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15415. cli_->set_header_writer(writer);
  15416. }
  15417. inline void Client::set_address_family(int family) {
  15418. cli_->set_address_family(family);
  15419. }
  15420. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15421. inline void Client::set_socket_options(SocketOptions socket_options) {
  15422. cli_->set_socket_options(std::move(socket_options));
  15423. }
  15424. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15425. cli_->set_connection_timeout(sec, usec);
  15426. }
  15427. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15428. cli_->set_read_timeout(sec, usec);
  15429. }
  15430. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15431. cli_->set_write_timeout(sec, usec);
  15432. }
  15433. inline void Client::set_basic_auth(const std::string &username,
  15434. const std::string &password) {
  15435. cli_->set_basic_auth(username, password);
  15436. }
  15437. inline void Client::set_bearer_token_auth(const std::string &token) {
  15438. cli_->set_bearer_token_auth(token);
  15439. }
  15440. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15441. inline void Client::set_follow_location(bool on) {
  15442. cli_->set_follow_location(on);
  15443. }
  15444. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15445. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15446. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15447. inline void Client::set_payload_max_length(size_t length) {
  15448. cli_->set_payload_max_length(length);
  15449. }
  15450. inline void Client::set_interface(const std::string &intf) {
  15451. cli_->set_interface(intf);
  15452. }
  15453. inline void Client::set_proxy(const std::string &host, int port) {
  15454. cli_->set_proxy(host, port);
  15455. }
  15456. inline void Client::set_proxy_basic_auth(const std::string &username,
  15457. const std::string &password) {
  15458. cli_->set_proxy_basic_auth(username, password);
  15459. }
  15460. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15461. cli_->set_proxy_bearer_token_auth(token);
  15462. }
  15463. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15464. cli_->set_no_proxy(patterns);
  15465. }
  15466. inline void Client::set_logger(Logger logger) {
  15467. cli_->set_logger(std::move(logger));
  15468. }
  15469. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15470. cli_->set_error_logger(std::move(error_logger));
  15471. }
  15472. /*
  15473. * Group 6: SSL Server and Client implementation
  15474. */
  15475. #ifdef CPPHTTPLIB_SSL_ENABLED
  15476. // SSL HTTP server implementation
  15477. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15478. const char *client_ca_cert_file_path,
  15479. const char *client_ca_cert_dir_path,
  15480. const char *private_key_password) {
  15481. using namespace tls;
  15482. ctx_ = create_server_context();
  15483. if (!ctx_) { return; }
  15484. // Load server certificate and private key
  15485. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15486. private_key_password)) {
  15487. last_ssl_error_ = static_cast<int>(get_error());
  15488. free_context(ctx_);
  15489. ctx_ = nullptr;
  15490. return;
  15491. }
  15492. // Load client CA certificates for client authentication
  15493. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15494. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15495. client_ca_cert_dir_path)) {
  15496. last_ssl_error_ = static_cast<int>(get_error());
  15497. free_context(ctx_);
  15498. ctx_ = nullptr;
  15499. return;
  15500. }
  15501. // Enable client certificate verification
  15502. set_verify_client(ctx_, true);
  15503. }
  15504. }
  15505. inline SSLServer::SSLServer(const PemMemory &pem) {
  15506. using namespace tls;
  15507. ctx_ = create_server_context();
  15508. if (ctx_) {
  15509. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15510. pem.private_key_password)) {
  15511. last_ssl_error_ = static_cast<int>(get_error());
  15512. free_context(ctx_);
  15513. ctx_ = nullptr;
  15514. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15515. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15516. last_ssl_error_ = static_cast<int>(get_error());
  15517. free_context(ctx_);
  15518. ctx_ = nullptr;
  15519. } else {
  15520. set_verify_client(ctx_, true);
  15521. }
  15522. }
  15523. }
  15524. }
  15525. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15526. using namespace tls;
  15527. ctx_ = create_server_context();
  15528. if (ctx_) {
  15529. if (!setup_callback(ctx_)) {
  15530. free_context(ctx_);
  15531. ctx_ = nullptr;
  15532. }
  15533. }
  15534. }
  15535. inline SSLServer::~SSLServer() {
  15536. if (ctx_) { tls::free_context(ctx_); }
  15537. }
  15538. inline bool SSLServer::is_valid() const {
  15539. return ctx_ != nullptr && Server::is_valid();
  15540. }
  15541. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15542. using namespace tls;
  15543. // Create TLS session with mutex protection
  15544. session_t session = nullptr;
  15545. {
  15546. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15547. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15548. }
  15549. if (!session) {
  15550. last_ssl_error_ = static_cast<int>(get_error());
  15551. detail::shutdown_socket(sock);
  15552. detail::close_socket(sock);
  15553. return false;
  15554. }
  15555. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15556. bool handshake_done = false;
  15557. bool ret = false;
  15558. bool websocket_upgraded = false;
  15559. auto cleanup = detail::scope_exit([&] {
  15560. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15561. free_session(session);
  15562. detail::shutdown_socket(sock);
  15563. detail::close_socket(sock);
  15564. });
  15565. // Perform TLS accept handshake with timeout
  15566. TlsError tls_err;
  15567. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15568. &tls_err)) {
  15569. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15570. // Map TlsError to legacy ssl_error for backward compatibility
  15571. if (tls_err.code == ErrorCode::WantRead) {
  15572. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15573. } else if (tls_err.code == ErrorCode::WantWrite) {
  15574. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15575. } else {
  15576. last_ssl_error_ = SSL_ERROR_SSL;
  15577. }
  15578. #else
  15579. last_ssl_error_ = static_cast<int>(get_error());
  15580. #endif
  15581. return false;
  15582. }
  15583. handshake_done = true;
  15584. std::string remote_addr;
  15585. int remote_port = 0;
  15586. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15587. std::string local_addr;
  15588. int local_port = 0;
  15589. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15590. ret = serve_guarded([&]() {
  15591. return detail::process_server_socket_ssl(
  15592. svr_sock_, session, sock, keep_alive_max_count_,
  15593. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15594. write_timeout_sec_, write_timeout_usec_,
  15595. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15596. return process_request(
  15597. strm, remote_addr, remote_port, local_addr, local_port,
  15598. close_connection, connection_closed,
  15599. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15600. });
  15601. });
  15602. return ret;
  15603. }
  15604. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15605. const char *key_pem,
  15606. const char *client_ca_pem,
  15607. const char *password) {
  15608. if (!ctx_) { return false; }
  15609. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15610. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15611. return false;
  15612. }
  15613. if (client_ca_pem) {
  15614. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15615. }
  15616. return true;
  15617. }
  15618. // SSL HTTP client implementation
  15619. inline SSLClient::~SSLClient() {
  15620. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15621. // base function rather than the derived function once we get to the
  15622. // base class destructor, and won't free the SSL (causing a leak).
  15623. // This must happen before the context is freed below: some backends
  15624. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15625. // context, so freeing the context first leaves close_notify reading
  15626. // freed memory.
  15627. shutdown_ssl_impl(socket_, true);
  15628. if (ctx_) {
  15629. tls::free_context(ctx_);
  15630. ctx_ = nullptr;
  15631. }
  15632. }
  15633. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15634. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15635. shutdown_ssl_impl(socket, shutdown_gracefully);
  15636. }
  15637. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15638. bool shutdown_gracefully) {
  15639. if (socket.sock == INVALID_SOCKET) {
  15640. assert(socket.ssl == nullptr);
  15641. return;
  15642. }
  15643. if (socket.ssl) {
  15644. tls::shutdown(socket.ssl, shutdown_gracefully);
  15645. {
  15646. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15647. tls::free_session(socket.ssl);
  15648. }
  15649. socket.ssl = nullptr;
  15650. }
  15651. assert(socket.ssl == nullptr);
  15652. }
  15653. inline bool SSLClient::process_socket(
  15654. const Socket &socket,
  15655. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15656. std::function<bool(Stream &strm)> callback) {
  15657. assert(socket.ssl);
  15658. return detail::process_client_socket_ssl(
  15659. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15660. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15661. std::move(callback));
  15662. }
  15663. inline bool SSLClient::is_ssl() const { return true; }
  15664. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15665. if (!is_valid()) {
  15666. error = Error::SSLConnection;
  15667. return false;
  15668. }
  15669. return ClientImpl::create_and_connect_socket(socket, error);
  15670. }
  15671. inline bool SSLClient::setup_proxy_connection(
  15672. Socket &socket,
  15673. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15674. Response &res, bool &success, Error &error) {
  15675. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15676. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15677. return false;
  15678. }
  15679. if (!initialize_ssl(socket, error)) {
  15680. success = false;
  15681. return false;
  15682. }
  15683. return true;
  15684. }
  15685. // Assumes that socket_mutex_ is locked and that there are no requests in
  15686. // flight
  15687. inline bool SSLClient::connect_with_proxy(
  15688. Socket &socket,
  15689. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15690. Response &res, bool &success, Error &error) {
  15691. success = true;
  15692. Response proxy_res;
  15693. if (!detail::process_client_socket(
  15694. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15695. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15696. start_time, [&](Stream &strm) {
  15697. Request req2;
  15698. req2.method = "CONNECT";
  15699. req2.path =
  15700. detail::make_host_and_port_string_always_port(host_, port_);
  15701. if (max_timeout_msec_ > 0) {
  15702. req2.start_time_ = std::chrono::steady_clock::now();
  15703. }
  15704. return process_request(strm, req2, proxy_res, false, error);
  15705. })) {
  15706. // Thread-safe to close everything because we are assuming there are no
  15707. // requests in flight
  15708. shutdown_ssl(socket, true);
  15709. shutdown_socket(socket);
  15710. close_socket(socket);
  15711. success = false;
  15712. return false;
  15713. }
  15714. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15715. if (!proxy_digest_auth_username_.empty() &&
  15716. !proxy_digest_auth_password_.empty()) {
  15717. std::map<std::string, std::string> auth;
  15718. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15719. // Close the current socket and create a new one for the authenticated
  15720. // request
  15721. shutdown_ssl(socket, true);
  15722. shutdown_socket(socket);
  15723. close_socket(socket);
  15724. // Create a new socket for the authenticated CONNECT request
  15725. if (!ensure_socket_connection(socket, error)) {
  15726. success = false;
  15727. output_error_log(error, nullptr);
  15728. return false;
  15729. }
  15730. proxy_res = Response();
  15731. if (!detail::process_client_socket(
  15732. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15733. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15734. start_time, [&](Stream &strm) {
  15735. Request req3;
  15736. req3.method = "CONNECT";
  15737. req3.path = detail::make_host_and_port_string_always_port(
  15738. host_, port_);
  15739. req3.headers.insert(detail::make_digest_authentication_header(
  15740. req3, auth, 1, detail::random_string(10),
  15741. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15742. true));
  15743. if (max_timeout_msec_ > 0) {
  15744. req3.start_time_ = std::chrono::steady_clock::now();
  15745. }
  15746. return process_request(strm, req3, proxy_res, false, error);
  15747. })) {
  15748. // Thread-safe to close everything because we are assuming there are
  15749. // no requests in flight
  15750. shutdown_ssl(socket, true);
  15751. shutdown_socket(socket);
  15752. close_socket(socket);
  15753. success = false;
  15754. return false;
  15755. }
  15756. }
  15757. }
  15758. }
  15759. // If status code is not 200, proxy request is failed.
  15760. // Set error to ProxyConnection and return proxy response
  15761. // as the response of the request
  15762. if (proxy_res.status != StatusCode::OK_200) {
  15763. error = Error::ProxyConnection;
  15764. output_error_log(error, nullptr);
  15765. res = std::move(proxy_res);
  15766. // Thread-safe to close everything because we are assuming there are
  15767. // no requests in flight
  15768. shutdown_ssl(socket, true);
  15769. shutdown_socket(socket);
  15770. close_socket(socket);
  15771. return false;
  15772. }
  15773. return true;
  15774. }
  15775. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15776. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15777. if (is_proxy_enabled_for_host(host_)) { return true; }
  15778. if (!initialize_ssl(socket, error)) {
  15779. shutdown_socket(socket);
  15780. close_socket(socket);
  15781. return false;
  15782. }
  15783. return true;
  15784. }
  15785. // SSL HTTP client implementation
  15786. inline SSLClient::SSLClient(const std::string &host)
  15787. : SSLClient(host, 443, std::string(), std::string()) {}
  15788. inline SSLClient::SSLClient(const std::string &host, int port)
  15789. : SSLClient(host, port, std::string(), std::string()) {}
  15790. inline void SSLClient::init_ctx() {
  15791. ctx_ = tls::create_client_context();
  15792. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15793. }
  15794. inline void SSLClient::reset_ctx_on_error() {
  15795. last_backend_error_ = tls::get_error();
  15796. tls::free_context(ctx_);
  15797. ctx_ = nullptr;
  15798. }
  15799. inline SSLClient::SSLClient(const std::string &host, int port,
  15800. const std::string &client_cert_path,
  15801. const std::string &client_key_path,
  15802. const std::string &private_key_password)
  15803. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15804. init_ctx();
  15805. if (!ctx_) { return; }
  15806. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15807. const char *password =
  15808. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15809. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15810. client_key_path.c_str(), password)) {
  15811. reset_ctx_on_error();
  15812. }
  15813. }
  15814. }
  15815. inline SSLClient::SSLClient(const std::string &host, int port,
  15816. const PemMemory &pem)
  15817. : ClientImpl(host, port) {
  15818. init_ctx();
  15819. if (!ctx_) { return; }
  15820. if (pem.cert_pem && pem.key_pem) {
  15821. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15822. pem.private_key_password)) {
  15823. reset_ctx_on_error();
  15824. }
  15825. }
  15826. }
  15827. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15828. if (ca_cert_store && ctx_) {
  15829. // set_ca_store takes ownership of ca_cert_store
  15830. tls::set_ca_store(ctx_, ca_cert_store);
  15831. ca_cert_store_set_ = true;
  15832. } else if (ca_cert_store) {
  15833. tls::free_ca_store(ca_cert_store);
  15834. }
  15835. }
  15836. inline void
  15837. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15838. if (!ctx_) { return; }
  15839. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15840. server_certificate_verifier_set_ = static_cast<bool>(verifier);
  15841. #endif
  15842. tls::set_verify_callback(ctx_, verifier);
  15843. }
  15844. inline void SSLClient::set_session_verifier(
  15845. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15846. session_verifier_ = std::move(verifier);
  15847. }
  15848. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15849. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15850. enable_windows_cert_verification_ = enabled;
  15851. }
  15852. #endif
  15853. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15854. std::size_t size) {
  15855. if (ctx_ && ca_cert && size > 0) {
  15856. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15857. tls::load_ca_pem(ctx_, ca_cert, size);
  15858. }
  15859. }
  15860. inline bool SSLClient::load_certs() {
  15861. auto ret = true;
  15862. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15863. // one client is shared across concurrent requests here.
  15864. std::call_once(initialize_cert_, [&]() {
  15865. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15866. ret = detail::load_client_ca_config(
  15867. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15868. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15869. last_backend_error_);
  15870. });
  15871. return ret;
  15872. }
  15873. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15874. // Load CA certificates if server verification is enabled
  15875. if (server_certificate_verification_) {
  15876. if (!load_certs()) {
  15877. error = Error::SSLLoadingCerts;
  15878. output_error_log(error, nullptr);
  15879. return false;
  15880. }
  15881. }
  15882. detail::ClientTlsSessionOptions options;
  15883. options.server_hostname_verification = server_hostname_verification_;
  15884. options.session_verifier = session_verifier_;
  15885. options.ctx_mutex = &ctx_mutex_;
  15886. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15887. // Skip Schannel when a custom CA cert is specified, as the Windows
  15888. // certificate store would not know about user-provided CA certificates.
  15889. // Also skip when system CA trust is explicitly disabled.
  15890. options.windows_cert_verification =
  15891. enable_windows_cert_verification_ &&
  15892. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15893. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15894. // Only a verifier set through set_server_certificate_verifier() is seen
  15895. // here, not one installed with tls::set_verify_callback() directly.
  15896. options.server_certificate_verifier_set = server_certificate_verifier_set_;
  15897. #endif
  15898. tls::session_t session = nullptr;
  15899. // Use scope_exit to ensure session is freed on error paths
  15900. bool success = false;
  15901. auto session_guard = detail::scope_exit([&] {
  15902. if (!success) { tls::free_session(session); }
  15903. });
  15904. detail::ClientTlsSessionError tls_error;
  15905. if (!detail::setup_client_tls_session(
  15906. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15907. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15908. options)) {
  15909. error = tls_error.error;
  15910. last_ssl_error_ = tls_error.ssl_error;
  15911. last_backend_error_ = tls_error.backend_error;
  15912. output_error_log(error, nullptr);
  15913. return false;
  15914. }
  15915. success = true;
  15916. socket.ssl = session;
  15917. return true;
  15918. }
  15919. inline void Client::set_digest_auth(const std::string &username,
  15920. const std::string &password) {
  15921. cli_->set_digest_auth(username, password);
  15922. }
  15923. inline void Client::set_proxy_digest_auth(const std::string &username,
  15924. const std::string &password) {
  15925. cli_->set_proxy_digest_auth(username, password);
  15926. }
  15927. inline void Client::enable_server_certificate_verification(bool enabled) {
  15928. cli_->enable_server_certificate_verification(enabled);
  15929. }
  15930. inline void Client::enable_server_hostname_verification(bool enabled) {
  15931. cli_->enable_server_hostname_verification(enabled);
  15932. }
  15933. inline void Client::enable_system_ca(bool enabled) {
  15934. cli_->enable_system_ca(enabled);
  15935. }
  15936. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15937. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15938. if (is_ssl_) {
  15939. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15940. enabled);
  15941. }
  15942. }
  15943. #endif
  15944. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15945. const std::string &ca_cert_dir_path) {
  15946. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15947. }
  15948. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15949. if (is_ssl_) {
  15950. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15951. } else if (ca_cert_store) {
  15952. tls::free_ca_store(ca_cert_store);
  15953. }
  15954. }
  15955. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15956. if (is_ssl_) {
  15957. // Use the PEM-based path so the CA data is retained for redirect transfer
  15958. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15959. }
  15960. }
  15961. inline void
  15962. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15963. if (is_ssl_) {
  15964. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15965. std::move(verifier));
  15966. }
  15967. }
  15968. inline void Client::set_session_verifier(
  15969. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15970. if (is_ssl_) {
  15971. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15972. }
  15973. }
  15974. inline tls::ctx_t Client::tls_context() const {
  15975. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15976. return nullptr;
  15977. }
  15978. #endif // CPPHTTPLIB_SSL_ENABLED
  15979. /*
  15980. * Group 7: TLS abstraction layer - Common API
  15981. */
  15982. #ifdef CPPHTTPLIB_SSL_ENABLED
  15983. namespace tls {
  15984. // Helper for PeerCert construction
  15985. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15986. return PeerCert(get_peer_cert(session));
  15987. }
  15988. namespace impl {
  15989. inline VerifyCallback &get_verify_callback() {
  15990. static thread_local VerifyCallback callback;
  15991. return callback;
  15992. }
  15993. inline VerifyCallback &get_mbedtls_verify_callback() {
  15994. static thread_local VerifyCallback callback;
  15995. return callback;
  15996. }
  15997. // Check if a string is an IPv4 address
  15998. inline bool is_ipv4_address(const std::string &str) {
  15999. int dots = 0;
  16000. for (char c : str) {
  16001. if (c == '.') {
  16002. dots++;
  16003. } else if (!detail::is_ascii_digit(c)) {
  16004. return false;
  16005. }
  16006. }
  16007. return dots == 3;
  16008. }
  16009. // Parse IPv4 address string to bytes
  16010. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16011. const char *p = str.c_str();
  16012. for (int i = 0; i < 4; i++) {
  16013. if (i > 0) {
  16014. if (*p != '.') { return false; }
  16015. p++;
  16016. }
  16017. int val = 0;
  16018. int digits = 0;
  16019. while (detail::is_ascii_digit(*p)) {
  16020. val = val * 10 + (*p - '0');
  16021. if (val > 255) { return false; }
  16022. p++;
  16023. digits++;
  16024. }
  16025. if (digits == 0) { return false; }
  16026. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16027. if (digits > 1 && *(p - digits) == '0') { return false; }
  16028. out[i] = static_cast<unsigned char>(val);
  16029. }
  16030. return *p == '\0';
  16031. }
  16032. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16033. // `out` must have room for at least 16 bytes. Returns the address length
  16034. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16035. // literal. Used to match a host against iPAddress SANs the same way the
  16036. // OpenSSL backend does via X509_check_ip.
  16037. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16038. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16039. struct in6_addr addr6 = {};
  16040. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16041. memcpy(out, &addr6, 16);
  16042. return 16;
  16043. }
  16044. return 0;
  16045. }
  16046. #ifdef _WIN32
  16047. // Enumerate Windows system certificates and call callback with DER data
  16048. template <typename Callback>
  16049. inline bool enumerate_windows_system_certs(Callback cb) {
  16050. bool loaded = false;
  16051. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16052. for (auto store_name : store_names) {
  16053. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16054. if (hStore) {
  16055. PCCERT_CONTEXT pContext = nullptr;
  16056. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16057. nullptr) {
  16058. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16059. loaded = true;
  16060. }
  16061. }
  16062. CertCloseStore(hStore, 0);
  16063. }
  16064. }
  16065. return loaded;
  16066. }
  16067. #endif
  16068. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16069. // Enumerate macOS Keychain certificates and call callback with DER data
  16070. template <typename Callback>
  16071. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16072. bool loaded = false;
  16073. const SecTrustSettingsDomain domains[] = {
  16074. kSecTrustSettingsDomainSystem,
  16075. kSecTrustSettingsDomainAdmin,
  16076. kSecTrustSettingsDomainUser,
  16077. };
  16078. for (auto domain : domains) {
  16079. CFArrayRef certs = nullptr;
  16080. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16081. if (status != errSecSuccess || !certs) {
  16082. if (certs) CFRelease(certs);
  16083. continue;
  16084. }
  16085. CFIndex count = CFArrayGetCount(certs);
  16086. for (CFIndex i = 0; i < count; i++) {
  16087. SecCertificateRef cert =
  16088. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16089. CFDataRef data = SecCertificateCopyData(cert);
  16090. if (data) {
  16091. if (cb(CFDataGetBytePtr(data),
  16092. static_cast<size_t>(CFDataGetLength(data)))) {
  16093. loaded = true;
  16094. }
  16095. CFRelease(data);
  16096. }
  16097. }
  16098. CFRelease(certs);
  16099. }
  16100. return loaded;
  16101. }
  16102. #endif
  16103. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16104. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16105. // Common CA certificate file paths on Linux/Unix
  16106. inline const char **system_ca_paths() {
  16107. static const char *paths[] = {
  16108. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16109. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16110. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16111. "/etc/pki/tls/cacert.pem", // OpenELEC
  16112. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16113. nullptr};
  16114. return paths;
  16115. }
  16116. // Common CA certificate directory paths on Linux/Unix
  16117. inline const char **system_ca_dirs() {
  16118. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16119. "/etc/pki/tls/certs", // RHEL/CentOS
  16120. "/usr/share/ca-certificates", // Other
  16121. nullptr};
  16122. return dirs;
  16123. }
  16124. #endif
  16125. } // namespace impl
  16126. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16127. const char *ca_dir) {
  16128. if (!ctx) { return false; }
  16129. bool success = true;
  16130. if (ca_file && *ca_file) {
  16131. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16132. }
  16133. if (ca_dir && *ca_dir) {
  16134. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16135. }
  16136. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16137. // Set CA list for client certificate request (CertificateRequest message)
  16138. if (ca_file && *ca_file) {
  16139. auto list = SSL_load_client_CA_file(ca_file);
  16140. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16141. }
  16142. #endif
  16143. return success;
  16144. }
  16145. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16146. const char *password) {
  16147. return set_client_cert_pem(ctx, cert, key, password);
  16148. }
  16149. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16150. const char *key_path, const char *password) {
  16151. return set_client_cert_file(ctx, cert_path, key_path, password);
  16152. }
  16153. // PeerCert implementation
  16154. inline PeerCert::PeerCert() = default;
  16155. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16156. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16157. other.cert_ = nullptr;
  16158. }
  16159. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16160. if (this != &other) {
  16161. if (cert_) { free_cert(cert_); }
  16162. cert_ = other.cert_;
  16163. other.cert_ = nullptr;
  16164. }
  16165. return *this;
  16166. }
  16167. inline PeerCert::~PeerCert() {
  16168. if (cert_) { free_cert(cert_); }
  16169. }
  16170. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16171. inline std::string PeerCert::subject_cn() const {
  16172. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16173. }
  16174. inline std::string PeerCert::issuer_name() const {
  16175. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16176. }
  16177. inline bool PeerCert::check_hostname(const char *hostname) const {
  16178. return cert_ ? verify_hostname(cert_, hostname) : false;
  16179. }
  16180. inline std::vector<SanEntry> PeerCert::sans() const {
  16181. std::vector<SanEntry> result;
  16182. if (cert_) { get_cert_sans(cert_, result); }
  16183. return result;
  16184. }
  16185. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16186. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16187. }
  16188. inline std::string PeerCert::serial() const {
  16189. return cert_ ? get_cert_serial(cert_) : std::string();
  16190. }
  16191. // VerifyContext method implementations
  16192. inline std::string VerifyContext::subject_cn() const {
  16193. return cert ? get_cert_subject_cn(cert) : std::string();
  16194. }
  16195. inline std::string VerifyContext::issuer_name() const {
  16196. return cert ? get_cert_issuer_name(cert) : std::string();
  16197. }
  16198. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16199. return cert ? verify_hostname(cert, hostname) : false;
  16200. }
  16201. inline std::vector<SanEntry> VerifyContext::sans() const {
  16202. std::vector<SanEntry> result;
  16203. if (cert) { get_cert_sans(cert, result); }
  16204. return result;
  16205. }
  16206. inline bool VerifyContext::validity(time_t &not_before,
  16207. time_t &not_after) const {
  16208. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16209. }
  16210. inline std::string VerifyContext::serial() const {
  16211. return cert ? get_cert_serial(cert) : std::string();
  16212. }
  16213. // TlsError static method implementation
  16214. inline std::string TlsError::verify_error_to_string(long error_code) {
  16215. return verify_error_string(error_code);
  16216. }
  16217. } // namespace tls
  16218. // Request::peer_cert() implementation
  16219. inline tls::PeerCert Request::peer_cert() const {
  16220. return tls::get_peer_cert_from_session(ssl);
  16221. }
  16222. // Request::sni() implementation
  16223. inline std::string Request::sni() const {
  16224. if (!ssl) { return std::string(); }
  16225. const char *s = tls::get_sni(ssl);
  16226. return s ? std::string(s) : std::string();
  16227. }
  16228. #endif // CPPHTTPLIB_SSL_ENABLED
  16229. /*
  16230. * Group 8: TLS abstraction layer - OpenSSL backend
  16231. */
  16232. /*
  16233. * OpenSSL Backend Implementation
  16234. */
  16235. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16236. namespace tls {
  16237. namespace impl {
  16238. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16239. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16240. switch (ssl_error) {
  16241. case SSL_ERROR_NONE: return ErrorCode::Success;
  16242. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16243. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16244. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16245. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16246. case SSL_ERROR_SSL:
  16247. default: return ErrorCode::Fatal;
  16248. }
  16249. }
  16250. // Helper: Create client CA list from PEM string
  16251. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16252. // Caller takes ownership of returned list
  16253. inline STACK_OF(X509_NAME) *
  16254. create_client_ca_list_from_pem(const char *ca_pem) {
  16255. if (!ca_pem) { return nullptr; }
  16256. auto ca_list = sk_X509_NAME_new_null();
  16257. if (!ca_list) { return nullptr; }
  16258. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16259. if (!bio) {
  16260. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16261. return nullptr;
  16262. }
  16263. X509 *cert = nullptr;
  16264. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16265. nullptr) {
  16266. const X509_NAME *name = X509_get_subject_name(cert);
  16267. if (name) {
  16268. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16269. }
  16270. X509_free(cert);
  16271. }
  16272. BIO_free(bio);
  16273. return ca_list;
  16274. }
  16275. // OpenSSL verify callback wrapper
  16276. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16277. auto &callback = get_verify_callback();
  16278. if (!callback) { return preverify_ok; }
  16279. // Get SSL object from X509_STORE_CTX
  16280. auto ssl = static_cast<SSL *>(
  16281. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16282. if (!ssl) { return preverify_ok; }
  16283. // Get current certificate and depth
  16284. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16285. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16286. int error = X509_STORE_CTX_get_error(ctx);
  16287. // Build context
  16288. VerifyContext verify_ctx;
  16289. verify_ctx.session = static_cast<session_t>(ssl);
  16290. verify_ctx.cert = static_cast<cert_t>(cert);
  16291. verify_ctx.depth = depth;
  16292. verify_ctx.preverify_ok = (preverify_ok != 0);
  16293. verify_ctx.error_code = error;
  16294. verify_ctx.error_string =
  16295. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16296. return callback(verify_ctx) ? 1 : 0;
  16297. }
  16298. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16299. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16300. // that must be released with release_store_objects
  16301. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16302. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16303. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16304. #endif
  16305. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16306. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16307. return X509_STORE_get1_objects(store);
  16308. #else
  16309. return X509_STORE_get0_objects(store);
  16310. #endif
  16311. }
  16312. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16313. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16314. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16315. #else
  16316. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16317. #endif
  16318. }
  16319. } // namespace impl
  16320. inline ctx_t create_client_context() {
  16321. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16322. if (ctx) {
  16323. // Disable auto-retry to properly handle non-blocking I/O
  16324. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16325. // Set minimum TLS version
  16326. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16327. }
  16328. return static_cast<ctx_t>(ctx);
  16329. }
  16330. inline void free_context(ctx_t ctx) {
  16331. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16332. }
  16333. inline bool set_min_version(ctx_t ctx, Version version) {
  16334. if (!ctx) return false;
  16335. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16336. static_cast<int>(version)) == 1;
  16337. }
  16338. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16339. if (!ctx || !pem || len == 0) return false;
  16340. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16341. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16342. if (!store) return false;
  16343. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16344. if (!bio) return false;
  16345. bool ok = true;
  16346. X509 *cert = nullptr;
  16347. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16348. nullptr) {
  16349. if (X509_STORE_add_cert(store, cert) != 1) {
  16350. // Ignore duplicate errors
  16351. auto err = ERR_peek_last_error();
  16352. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16353. ok = false;
  16354. }
  16355. }
  16356. X509_free(cert);
  16357. if (!ok) break;
  16358. }
  16359. BIO_free(bio);
  16360. // Clear any "no more certificates" errors
  16361. ERR_clear_error();
  16362. return ok;
  16363. }
  16364. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16365. if (!ctx || !file_path) return false;
  16366. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16367. nullptr) == 1;
  16368. }
  16369. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16370. if (!ctx || !dir_path) return false;
  16371. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16372. dir_path) == 1;
  16373. }
  16374. inline bool load_system_certs(ctx_t ctx) {
  16375. if (!ctx) return false;
  16376. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16377. #ifdef _WIN32
  16378. // Windows: Load from system certificate store (ROOT and CA)
  16379. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16380. if (!store) return false;
  16381. bool loaded_any = false;
  16382. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16383. for (auto store_name : store_names) {
  16384. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16385. if (!hStore) continue;
  16386. PCCERT_CONTEXT pContext = nullptr;
  16387. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16388. nullptr) {
  16389. const unsigned char *data = pContext->pbCertEncoded;
  16390. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16391. if (x509) {
  16392. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16393. X509_free(x509);
  16394. }
  16395. }
  16396. CertCloseStore(hStore, 0);
  16397. }
  16398. return loaded_any;
  16399. #elif defined(__APPLE__)
  16400. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16401. // macOS: Load from Keychain
  16402. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16403. if (!store) return false;
  16404. bool loaded_any = false;
  16405. const SecTrustSettingsDomain domains[] = {
  16406. kSecTrustSettingsDomainSystem,
  16407. kSecTrustSettingsDomainAdmin,
  16408. kSecTrustSettingsDomainUser,
  16409. };
  16410. for (auto domain : domains) {
  16411. CFArrayRef certs = nullptr;
  16412. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16413. !certs) {
  16414. if (certs) CFRelease(certs);
  16415. continue;
  16416. }
  16417. auto count = CFArrayGetCount(certs);
  16418. for (CFIndex i = 0; i < count; i++) {
  16419. auto cert = reinterpret_cast<SecCertificateRef>(
  16420. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16421. CFDataRef der = SecCertificateCopyData(cert);
  16422. if (der) {
  16423. const unsigned char *data = CFDataGetBytePtr(der);
  16424. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16425. if (x509) {
  16426. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16427. X509_free(x509);
  16428. }
  16429. CFRelease(der);
  16430. }
  16431. }
  16432. CFRelease(certs);
  16433. }
  16434. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16435. #else
  16436. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16437. #endif
  16438. #else
  16439. // Other Unix: use default verify paths
  16440. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16441. #endif
  16442. }
  16443. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16444. const char *password) {
  16445. if (!ctx || !cert || !key) return false;
  16446. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16447. // Load certificate
  16448. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16449. if (!cert_bio) return false;
  16450. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16451. BIO_free(cert_bio);
  16452. if (!x509) return false;
  16453. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16454. X509_free(x509);
  16455. if (!cert_ok) return false;
  16456. // Load private key
  16457. auto key_bio = BIO_new_mem_buf(key, -1);
  16458. if (!key_bio) return false;
  16459. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16460. password ? const_cast<char *>(password)
  16461. : nullptr);
  16462. BIO_free(key_bio);
  16463. if (!pkey) return false;
  16464. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16465. EVP_PKEY_free(pkey);
  16466. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16467. }
  16468. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16469. const char *key_path, const char *password) {
  16470. if (!ctx || !cert_path || !key_path) return false;
  16471. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16472. if (password && password[0] != '\0') {
  16473. SSL_CTX_set_default_passwd_cb_userdata(
  16474. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16475. }
  16476. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16477. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16478. }
  16479. inline ctx_t create_server_context() {
  16480. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16481. if (ctx) {
  16482. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16483. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16484. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16485. }
  16486. return static_cast<ctx_t>(ctx);
  16487. }
  16488. inline void set_verify_client(ctx_t ctx, bool require) {
  16489. if (!ctx) return;
  16490. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16491. require
  16492. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16493. : SSL_VERIFY_NONE,
  16494. nullptr);
  16495. }
  16496. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16497. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16498. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16499. SSL *ssl = SSL_new(ssl_ctx);
  16500. if (!ssl) return nullptr;
  16501. // Disable auto-retry for proper non-blocking I/O handling
  16502. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16503. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16504. if (!bio) {
  16505. SSL_free(ssl);
  16506. return nullptr;
  16507. }
  16508. SSL_set_bio(ssl, bio, bio);
  16509. return static_cast<session_t>(ssl);
  16510. }
  16511. inline void free_session(session_t session) {
  16512. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16513. }
  16514. inline bool set_sni(session_t session, const char *hostname,
  16515. bool /*verify_hostname*/) {
  16516. if (!session || !hostname) return false;
  16517. auto ssl = static_cast<SSL *>(session);
  16518. // Set SNI (Server Name Indication) only - does not enable verification.
  16519. // OpenSSL never binds identity checking to SNI (that happens post-
  16520. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16521. #if defined(OPENSSL_IS_BORINGSSL)
  16522. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16523. #else
  16524. // Direct call instead of macro to suppress -Wold-style-cast warning
  16525. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16526. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16527. #endif
  16528. }
  16529. inline TlsError connect(session_t session) {
  16530. if (!session) { return TlsError(); }
  16531. auto ssl = static_cast<SSL *>(session);
  16532. auto ret = SSL_connect(ssl);
  16533. TlsError err;
  16534. if (ret == 1) {
  16535. err.code = ErrorCode::Success;
  16536. } else {
  16537. auto ssl_err = SSL_get_error(ssl, ret);
  16538. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16539. err.backend_code = ERR_get_error();
  16540. }
  16541. return err;
  16542. }
  16543. inline TlsError accept(session_t session) {
  16544. if (!session) { return TlsError(); }
  16545. auto ssl = static_cast<SSL *>(session);
  16546. auto ret = SSL_accept(ssl);
  16547. TlsError err;
  16548. if (ret == 1) {
  16549. err.code = ErrorCode::Success;
  16550. } else {
  16551. auto ssl_err = SSL_get_error(ssl, ret);
  16552. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16553. err.backend_code = ERR_get_error();
  16554. }
  16555. return err;
  16556. }
  16557. inline bool connect_nonblocking(session_t session, socket_t sock,
  16558. time_t timeout_sec, time_t timeout_usec,
  16559. TlsError *err) {
  16560. if (!session) {
  16561. if (err) { err->code = ErrorCode::Fatal; }
  16562. return false;
  16563. }
  16564. auto ssl = static_cast<SSL *>(session);
  16565. auto bio = SSL_get_rbio(ssl);
  16566. // Set non-blocking mode for handshake
  16567. detail::set_nonblocking(sock, true);
  16568. if (bio) { BIO_set_nbio(bio, 1); }
  16569. auto cleanup = detail::scope_exit([&]() {
  16570. // Restore blocking mode after handshake
  16571. if (bio) { BIO_set_nbio(bio, 0); }
  16572. detail::set_nonblocking(sock, false);
  16573. });
  16574. auto res = 0;
  16575. while ((res = SSL_connect(ssl)) != 1) {
  16576. auto ssl_err = SSL_get_error(ssl, res);
  16577. switch (ssl_err) {
  16578. case SSL_ERROR_WANT_READ:
  16579. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16580. continue;
  16581. }
  16582. break;
  16583. case SSL_ERROR_WANT_WRITE:
  16584. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16585. continue;
  16586. }
  16587. break;
  16588. default: break;
  16589. }
  16590. if (err) {
  16591. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16592. err->backend_code = ERR_get_error();
  16593. }
  16594. return false;
  16595. }
  16596. if (err) { err->code = ErrorCode::Success; }
  16597. return true;
  16598. }
  16599. inline bool accept_nonblocking(session_t session, socket_t sock,
  16600. time_t timeout_sec, time_t timeout_usec,
  16601. TlsError *err) {
  16602. if (!session) {
  16603. if (err) { err->code = ErrorCode::Fatal; }
  16604. return false;
  16605. }
  16606. auto ssl = static_cast<SSL *>(session);
  16607. auto bio = SSL_get_rbio(ssl);
  16608. // Set non-blocking mode for handshake
  16609. detail::set_nonblocking(sock, true);
  16610. if (bio) { BIO_set_nbio(bio, 1); }
  16611. auto cleanup = detail::scope_exit([&]() {
  16612. // Restore blocking mode after handshake
  16613. if (bio) { BIO_set_nbio(bio, 0); }
  16614. detail::set_nonblocking(sock, false);
  16615. });
  16616. auto res = 0;
  16617. while ((res = SSL_accept(ssl)) != 1) {
  16618. auto ssl_err = SSL_get_error(ssl, res);
  16619. switch (ssl_err) {
  16620. case SSL_ERROR_WANT_READ:
  16621. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16622. continue;
  16623. }
  16624. break;
  16625. case SSL_ERROR_WANT_WRITE:
  16626. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16627. continue;
  16628. }
  16629. break;
  16630. default: break;
  16631. }
  16632. if (err) {
  16633. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16634. err->backend_code = ERR_get_error();
  16635. }
  16636. return false;
  16637. }
  16638. if (err) { err->code = ErrorCode::Success; }
  16639. return true;
  16640. }
  16641. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16642. if (!session || !buf) {
  16643. err.code = ErrorCode::Fatal;
  16644. return -1;
  16645. }
  16646. auto ssl = static_cast<SSL *>(session);
  16647. constexpr auto max_len =
  16648. static_cast<size_t>((std::numeric_limits<int>::max)());
  16649. if (len > max_len) { len = max_len; }
  16650. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16651. if (ret > 0) {
  16652. err.code = ErrorCode::Success;
  16653. return ret;
  16654. }
  16655. auto ssl_err = SSL_get_error(ssl, ret);
  16656. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16657. if (err.code == ErrorCode::PeerClosed) {
  16658. return 0;
  16659. } // Gracefully handle the peer closed state.
  16660. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16661. return -1;
  16662. }
  16663. inline ssize_t write(session_t session, const void *buf, size_t len,
  16664. TlsError &err) {
  16665. if (!session || !buf) {
  16666. err.code = ErrorCode::Fatal;
  16667. return -1;
  16668. }
  16669. auto ssl = static_cast<SSL *>(session);
  16670. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16671. if (ret > 0) {
  16672. err.code = ErrorCode::Success;
  16673. return ret;
  16674. }
  16675. auto ssl_err = SSL_get_error(ssl, ret);
  16676. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16677. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16678. return -1;
  16679. }
  16680. inline int pending(const_session_t session) {
  16681. if (!session) return 0;
  16682. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16683. }
  16684. inline void shutdown(session_t session, bool graceful) {
  16685. if (!session) return;
  16686. auto ssl = static_cast<SSL *>(session);
  16687. if (graceful) {
  16688. // Send close_notify without waiting for the peer's. The connection is
  16689. // closed right after this, so a unidirectional shutdown is enough, and an
  16690. // idle peer that never answers would otherwise hold this thread until the
  16691. // read timeout. The other backends do not wait either.
  16692. SSL_shutdown(ssl);
  16693. }
  16694. }
  16695. inline bool is_peer_closed(session_t session, socket_t sock) {
  16696. if (!session) return true;
  16697. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16698. detail::set_nonblocking(sock, true);
  16699. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16700. auto ssl = static_cast<SSL *>(session);
  16701. char buf;
  16702. auto ret = SSL_peek(ssl, &buf, 1);
  16703. if (ret > 0) return false;
  16704. auto err = SSL_get_error(ssl, ret);
  16705. return err == SSL_ERROR_ZERO_RETURN;
  16706. }
  16707. inline cert_t get_peer_cert(const_session_t session) {
  16708. if (!session) return nullptr;
  16709. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16710. static_cast<SSL *>(const_cast<void *>(session))));
  16711. }
  16712. inline size_t get_peer_certs(const_session_t session,
  16713. std::vector<cert_t> &certs) {
  16714. certs.clear();
  16715. if (!session) { return 0; }
  16716. auto ssl = static_cast<const SSL *>(session);
  16717. // On the server side, the chain leaves out the peer's own certificate
  16718. if (SSL_is_server(ssl)) {
  16719. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  16720. }
  16721. auto sk = SSL_get_peer_cert_chain(ssl);
  16722. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  16723. auto x509 = sk_X509_value(sk, i);
  16724. X509_up_ref(x509);
  16725. certs.push_back(static_cast<cert_t>(x509));
  16726. }
  16727. return certs.size();
  16728. }
  16729. inline void free_cert(cert_t cert) {
  16730. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16731. }
  16732. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16733. if (!cert || !hostname) return false;
  16734. auto x509 = static_cast<X509 *>(cert);
  16735. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16736. if (detail::is_ip_address(hostname)) {
  16737. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16738. }
  16739. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16740. }
  16741. inline uint64_t hostname_mismatch_code() {
  16742. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16743. }
  16744. inline long get_verify_result(const_session_t session) {
  16745. if (!session) return X509_V_ERR_UNSPECIFIED;
  16746. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16747. }
  16748. inline std::string get_cert_subject_cn(cert_t cert) {
  16749. if (!cert) return "";
  16750. auto x509 = static_cast<X509 *>(cert);
  16751. auto subject_name = X509_get_subject_name(x509);
  16752. if (!subject_name) return "";
  16753. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16754. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16755. if (idx < 0) return "";
  16756. auto entry = X509_NAME_get_entry(subject_name, idx);
  16757. if (!entry) return "";
  16758. auto data = X509_NAME_ENTRY_get_data(entry);
  16759. if (!data) return "";
  16760. return std::string(
  16761. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16762. static_cast<size_t>(ASN1_STRING_length(data)));
  16763. }
  16764. inline std::string get_cert_issuer_name(cert_t cert) {
  16765. if (!cert) return "";
  16766. auto x509 = static_cast<X509 *>(cert);
  16767. auto issuer_name = X509_get_issuer_name(x509);
  16768. if (!issuer_name) return "";
  16769. char buf[256];
  16770. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16771. return std::string(buf);
  16772. }
  16773. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16774. sans.clear();
  16775. if (!cert) return false;
  16776. auto x509 = static_cast<X509 *>(cert);
  16777. auto names = static_cast<GENERAL_NAMES *>(
  16778. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16779. if (!names) return true; // No SANs is valid
  16780. auto count = sk_GENERAL_NAME_num(names);
  16781. for (decltype(count) i = 0; i < count; i++) {
  16782. auto gen = sk_GENERAL_NAME_value(names, i);
  16783. if (!gen) continue;
  16784. SanEntry entry;
  16785. switch (gen->type) {
  16786. case GEN_DNS:
  16787. entry.type = SanType::DNS;
  16788. if (gen->d.dNSName) {
  16789. entry.value = std::string(
  16790. reinterpret_cast<const char *>(
  16791. ASN1_STRING_get0_data(gen->d.dNSName)),
  16792. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16793. }
  16794. break;
  16795. case GEN_IPADD:
  16796. entry.type = SanType::IP;
  16797. if (gen->d.iPAddress) {
  16798. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16799. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16800. if (len == 4) {
  16801. // IPv4
  16802. char buf[INET_ADDRSTRLEN];
  16803. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16804. entry.value = buf;
  16805. } else if (len == 16) {
  16806. // IPv6
  16807. char buf[INET6_ADDRSTRLEN];
  16808. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16809. entry.value = buf;
  16810. }
  16811. }
  16812. break;
  16813. case GEN_EMAIL:
  16814. entry.type = SanType::EMAIL;
  16815. if (gen->d.rfc822Name) {
  16816. entry.value = std::string(
  16817. reinterpret_cast<const char *>(
  16818. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16819. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16820. }
  16821. break;
  16822. case GEN_URI:
  16823. entry.type = SanType::URI;
  16824. if (gen->d.uniformResourceIdentifier) {
  16825. entry.value = std::string(
  16826. reinterpret_cast<const char *>(
  16827. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16828. static_cast<size_t>(
  16829. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16830. }
  16831. break;
  16832. default: entry.type = SanType::OTHER; break;
  16833. }
  16834. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16835. }
  16836. GENERAL_NAMES_free(names);
  16837. return true;
  16838. }
  16839. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16840. time_t &not_after) {
  16841. if (!cert) return false;
  16842. auto x509 = static_cast<X509 *>(cert);
  16843. auto nb = X509_get0_notBefore(x509);
  16844. auto na = X509_get0_notAfter(x509);
  16845. if (!nb || !na) return false;
  16846. ASN1_TIME *epoch = ASN1_TIME_new();
  16847. if (!epoch) return false;
  16848. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16849. if (!ASN1_TIME_set(epoch, 0)) return false;
  16850. int pday, psec;
  16851. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16852. not_before = 86400 * (time_t)pday + psec;
  16853. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16854. not_after = 86400 * (time_t)pday + psec;
  16855. return true;
  16856. }
  16857. inline std::string get_cert_serial(cert_t cert) {
  16858. if (!cert) return "";
  16859. auto x509 = static_cast<X509 *>(cert);
  16860. auto serial = X509_get_serialNumber(x509);
  16861. if (!serial) return "";
  16862. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16863. if (!bn) return "";
  16864. auto hex = BN_bn2hex(bn);
  16865. BN_free(bn);
  16866. if (!hex) return "";
  16867. std::string result(hex);
  16868. OPENSSL_free(hex);
  16869. return result;
  16870. }
  16871. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16872. if (!cert) return false;
  16873. auto x509 = static_cast<X509 *>(cert);
  16874. auto len = i2d_X509(x509, nullptr);
  16875. if (len < 0) return false;
  16876. der.resize(static_cast<size_t>(len));
  16877. auto p = der.data();
  16878. i2d_X509(x509, &p);
  16879. return true;
  16880. }
  16881. inline const char *get_sni(const_session_t session) {
  16882. if (!session) return nullptr;
  16883. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16884. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16885. }
  16886. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16887. inline uint64_t get_error() { return ERR_get_error(); }
  16888. inline std::string error_string(uint64_t code) {
  16889. char buf[256];
  16890. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16891. return std::string(buf);
  16892. }
  16893. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16894. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16895. if (!mem) { return nullptr; }
  16896. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16897. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16898. if (!inf) { return nullptr; }
  16899. auto store = X509_STORE_new();
  16900. if (store) {
  16901. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16902. auto itmp = sk_X509_INFO_value(inf, i);
  16903. if (!itmp) { continue; }
  16904. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16905. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16906. }
  16907. }
  16908. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16909. return static_cast<ca_store_t>(store);
  16910. }
  16911. inline void free_ca_store(ca_store_t store) {
  16912. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16913. }
  16914. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16915. if (!ctx || !store) { return false; }
  16916. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16917. auto x509_store = static_cast<X509_STORE *>(store);
  16918. // Check if same store is already set
  16919. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16920. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16921. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16922. return true;
  16923. }
  16924. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16925. certs.clear();
  16926. if (!ctx) { return 0; }
  16927. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16928. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16929. if (!store) { return 0; }
  16930. auto objs = impl::get_store_objects(store);
  16931. if (!objs) { return 0; }
  16932. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16933. auto count = sk_X509_OBJECT_num(objs);
  16934. for (decltype(count) i = 0; i < count; i++) {
  16935. auto obj = sk_X509_OBJECT_value(objs, i);
  16936. if (!obj) { continue; }
  16937. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16938. auto x509 = X509_OBJECT_get0_X509(obj);
  16939. if (x509) {
  16940. // Increment reference count so caller can free it
  16941. X509_up_ref(x509);
  16942. certs.push_back(static_cast<cert_t>(x509));
  16943. }
  16944. }
  16945. }
  16946. return certs.size();
  16947. }
  16948. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16949. std::vector<std::string> names;
  16950. if (!ctx) { return names; }
  16951. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16952. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16953. if (!store) { return names; }
  16954. auto objs = impl::get_store_objects(store);
  16955. if (!objs) { return names; }
  16956. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16957. auto count = sk_X509_OBJECT_num(objs);
  16958. for (decltype(count) i = 0; i < count; i++) {
  16959. auto obj = sk_X509_OBJECT_value(objs, i);
  16960. if (!obj) { continue; }
  16961. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16962. auto x509 = X509_OBJECT_get0_X509(obj);
  16963. if (x509) {
  16964. auto subject = X509_get_subject_name(x509);
  16965. if (subject) {
  16966. char buf[512];
  16967. X509_NAME_oneline(subject, buf, sizeof(buf));
  16968. names.push_back(buf);
  16969. }
  16970. }
  16971. }
  16972. }
  16973. return names;
  16974. }
  16975. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16976. const char *key_pem, const char *password) {
  16977. if (!ctx || !cert_pem || !key_pem) { return false; }
  16978. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16979. // Load certificate from PEM
  16980. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16981. if (!cert_bio) { return false; }
  16982. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16983. BIO_free(cert_bio);
  16984. if (!cert) { return false; }
  16985. // Load private key from PEM
  16986. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16987. if (!key_bio) {
  16988. X509_free(cert);
  16989. return false;
  16990. }
  16991. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16992. password ? const_cast<char *>(password)
  16993. : nullptr);
  16994. BIO_free(key_bio);
  16995. if (!key) {
  16996. X509_free(cert);
  16997. return false;
  16998. }
  16999. // Update certificate and key
  17000. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17001. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17002. X509_free(cert);
  17003. EVP_PKEY_free(key);
  17004. return ret;
  17005. }
  17006. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17007. if (!ctx || !ca_pem) { return false; }
  17008. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17009. // Create new X509_STORE from PEM
  17010. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17011. if (!store) { return false; }
  17012. // SSL_CTX_set_cert_store takes ownership
  17013. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17014. // Set client CA list for client certificate request
  17015. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17016. if (ca_list) {
  17017. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17018. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17019. }
  17020. return true;
  17021. }
  17022. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17023. if (!ctx) { return false; }
  17024. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17025. impl::get_verify_callback() = std::move(callback);
  17026. if (impl::get_verify_callback()) {
  17027. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17028. } else {
  17029. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17030. }
  17031. return true;
  17032. }
  17033. inline long get_verify_error(const_session_t session) {
  17034. if (!session) { return -1; }
  17035. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17036. return SSL_get_verify_result(ssl);
  17037. }
  17038. inline std::string verify_error_string(long error_code) {
  17039. if (error_code == X509_V_OK) { return ""; }
  17040. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17041. return str ? str : "unknown error";
  17042. }
  17043. } // namespace tls
  17044. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17045. /*
  17046. * Group 9: TLS abstraction layer - Mbed TLS backend
  17047. */
  17048. /*
  17049. * Mbed TLS Backend Implementation
  17050. */
  17051. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17052. namespace tls {
  17053. namespace impl {
  17054. // Mbed TLS session wrapper
  17055. struct MbedTlsSession {
  17056. mbedtls_ssl_context ssl;
  17057. socket_t sock = INVALID_SOCKET;
  17058. std::string hostname; // For client: set via set_sni
  17059. std::string sni_hostname; // For server: received from client via SNI callback
  17060. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17061. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17062. // (e.g. a response that arrived while this side was still in its post-write
  17063. // check), the byte is pushed back here and served by the next read().
  17064. unsigned char peeked_byte = 0;
  17065. bool has_peeked_byte = false;
  17066. // Set by set_sni() when the caller disabled hostname verification, so the
  17067. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17068. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17069. // OpenSSL and wolfSSL keep them independent).
  17070. bool suppress_hostname_mismatch = false;
  17071. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  17072. // decide which verify callback to install when hostname verification is
  17073. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  17074. // wired for this context, or a self-contained one otherwise, so a session
  17075. // that never opted into a callback never consults the process-wide
  17076. // set_verify_callback() slot (which some other, unrelated client may have
  17077. // populated).
  17078. bool has_verify_callback = false;
  17079. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17080. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17081. MbedTlsSession(const MbedTlsSession &) = delete;
  17082. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17083. };
  17084. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17085. // queue)
  17086. inline int &mbedtls_last_error() {
  17087. static thread_local int err = 0;
  17088. return err;
  17089. }
  17090. // Helper to map Mbed TLS error to ErrorCode
  17091. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17092. uint32_t verify_flags) {
  17093. if (ret == 0) { return ErrorCode::Success; }
  17094. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17095. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17096. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17097. return ErrorCode::PeerClosed;
  17098. }
  17099. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17100. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17101. out_errno = errno;
  17102. return ErrorCode::SyscallError;
  17103. }
  17104. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17105. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17106. // the handshake's chain verification (see set_sni()); a mismatch there
  17107. // is reported the same way as any other verify_flags bit. Report it as
  17108. // HostnameMismatch, matching the other backends and the post-handshake
  17109. // identity check below, but only when naming is the sole problem -
  17110. // if the chain itself is also untrusted/expired/etc., that takes
  17111. // priority over the naming detail.
  17112. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17113. return ErrorCode::HostnameMismatch;
  17114. }
  17115. return ErrorCode::CertVerifyFailed;
  17116. }
  17117. return ErrorCode::Fatal;
  17118. }
  17119. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17120. // return value, including the verify-flags-dependent HostnameMismatch
  17121. // mapping; shared by connect() and connect_nonblocking() so the
  17122. // backend_code policy for that mapping only lives in one place.
  17123. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17124. int ret) {
  17125. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17126. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17127. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17128. ? static_cast<uint64_t>(verify_flags)
  17129. : static_cast<uint64_t>(-ret);
  17130. }
  17131. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17132. // non-fatal notification delivered between records, not an error and not
  17133. // application data, so I/O calls that see it should just be retried. Kept in
  17134. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17135. // splitting the closing brace across an #if.
  17136. inline bool mbedtls_is_session_ticket(int ret) {
  17137. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17138. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17139. #else
  17140. (void)ret;
  17141. return false;
  17142. #endif
  17143. }
  17144. // BIO-like send callback for Mbed TLS
  17145. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17146. size_t len) {
  17147. auto sock = *static_cast<socket_t *>(ctx);
  17148. #ifdef _WIN32
  17149. auto ret =
  17150. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17151. if (ret == SOCKET_ERROR) {
  17152. int err = WSAGetLastError();
  17153. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17154. return MBEDTLS_ERR_NET_SEND_FAILED;
  17155. }
  17156. #else
  17157. auto ret = send(sock, buf, len, 0);
  17158. if (ret < 0) {
  17159. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17160. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17161. }
  17162. return MBEDTLS_ERR_NET_SEND_FAILED;
  17163. }
  17164. #endif
  17165. return static_cast<int>(ret);
  17166. }
  17167. // BIO-like recv callback for Mbed TLS
  17168. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17169. auto sock = *static_cast<socket_t *>(ctx);
  17170. #ifdef _WIN32
  17171. auto ret =
  17172. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17173. if (ret == SOCKET_ERROR) {
  17174. int err = WSAGetLastError();
  17175. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17176. return MBEDTLS_ERR_NET_RECV_FAILED;
  17177. }
  17178. #else
  17179. auto ret = recv(sock, buf, len, 0);
  17180. if (ret < 0) {
  17181. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17182. return MBEDTLS_ERR_SSL_WANT_READ;
  17183. }
  17184. return MBEDTLS_ERR_NET_RECV_FAILED;
  17185. }
  17186. #endif
  17187. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17188. return static_cast<int>(ret);
  17189. }
  17190. // MbedTlsContext constructor/destructor implementations
  17191. inline MbedTlsContext::MbedTlsContext() {
  17192. mbedtls_ssl_config_init(&conf);
  17193. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17194. mbedtls_entropy_init(&entropy);
  17195. mbedtls_ctr_drbg_init(&ctr_drbg);
  17196. #endif
  17197. mbedtls_x509_crt_init(&ca_chain);
  17198. mbedtls_x509_crt_init(&own_cert);
  17199. mbedtls_pk_init(&own_key);
  17200. }
  17201. inline MbedTlsContext::~MbedTlsContext() {
  17202. mbedtls_pk_free(&own_key);
  17203. mbedtls_x509_crt_free(&own_cert);
  17204. mbedtls_x509_crt_free(&ca_chain);
  17205. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17206. mbedtls_ctr_drbg_free(&ctr_drbg);
  17207. mbedtls_entropy_free(&entropy);
  17208. #endif
  17209. mbedtls_ssl_config_free(&conf);
  17210. }
  17211. // Thread-local storage for SNI captured during handshake
  17212. // This is needed because the SNI callback doesn't have a way to pass
  17213. // session-specific data before the session is fully set up
  17214. inline std::string &mbedpending_sni() {
  17215. static thread_local std::string sni;
  17216. return sni;
  17217. }
  17218. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17219. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17220. const unsigned char *name, size_t name_len) {
  17221. (void)p_ctx;
  17222. (void)ssl;
  17223. // Store SNI name in thread-local storage
  17224. // It will be retrieved and stored in the session after handshake
  17225. if (name && name_len > 0) {
  17226. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17227. } else {
  17228. mbedpending_sni().clear();
  17229. }
  17230. return 0; // Accept any SNI
  17231. }
  17232. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17233. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17234. }
  17235. // Verify callback used when hostname verification is disabled for a session
  17236. // that has no user-supplied verify callback of its own (MbedTlsSession::
  17237. // has_verify_callback is false). Deliberately does not consult
  17238. // get_verify_callback(): that slot is process-wide, so reading it here would
  17239. // pick up whatever another, unrelated client last installed there.
  17240. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17241. mbedtls_x509_crt *, int,
  17242. uint32_t *flags) {
  17243. (void)data;
  17244. mbedtls_clear_cn_mismatch(flags);
  17245. return 0;
  17246. }
  17247. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17248. int cert_depth, uint32_t *flags);
  17249. // MbedTLS verify callback wrapper
  17250. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17251. int cert_depth, uint32_t *flags) {
  17252. // data points to the MbedTlsSession
  17253. auto *session = static_cast<MbedTlsSession *>(data);
  17254. // set_sni() disabled hostname verification for this session: drop the
  17255. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17256. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17257. // SNI. The final pass/fail decision still comes from the remaining flags
  17258. // (or, below, from the user's own verify callback).
  17259. if (session && session->suppress_hostname_mismatch) {
  17260. mbedtls_clear_cn_mismatch(flags);
  17261. }
  17262. auto &callback = get_verify_callback();
  17263. if (!callback) { return 0; } // Continue with default verification
  17264. // Build context
  17265. VerifyContext verify_ctx;
  17266. verify_ctx.session = static_cast<session_t>(session);
  17267. verify_ctx.cert = static_cast<cert_t>(crt);
  17268. verify_ctx.depth = cert_depth;
  17269. verify_ctx.preverify_ok = (*flags == 0);
  17270. verify_ctx.error_code = static_cast<long>(*flags);
  17271. // Convert Mbed TLS flags to error string
  17272. static thread_local char error_buf[256];
  17273. if (*flags != 0) {
  17274. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17275. verify_ctx.error_string = error_buf;
  17276. } else {
  17277. verify_ctx.error_string = nullptr;
  17278. }
  17279. bool accepted = callback(verify_ctx);
  17280. if (accepted) {
  17281. *flags = 0; // Clear all error flags
  17282. return 0;
  17283. }
  17284. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17285. }
  17286. } // namespace impl
  17287. inline ctx_t create_client_context() {
  17288. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17289. if (!ctx) { return nullptr; }
  17290. ctx->is_server = false;
  17291. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17292. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17293. if (!detail::ensure_mbedtls_psa_crypto()) {
  17294. delete ctx;
  17295. return nullptr;
  17296. }
  17297. int ret;
  17298. #else
  17299. // Seed the random number generator
  17300. const char *pers = "httplib_client";
  17301. int ret = mbedtls_ctr_drbg_seed(
  17302. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17303. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17304. if (ret != 0) {
  17305. impl::mbedtls_last_error() = ret;
  17306. delete ctx;
  17307. return nullptr;
  17308. }
  17309. #endif
  17310. // Set up SSL config for client
  17311. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17312. MBEDTLS_SSL_TRANSPORT_STREAM,
  17313. MBEDTLS_SSL_PRESET_DEFAULT);
  17314. if (ret != 0) {
  17315. impl::mbedtls_last_error() = ret;
  17316. delete ctx;
  17317. return nullptr;
  17318. }
  17319. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17320. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17321. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17322. #endif
  17323. // Default: verify peer certificate
  17324. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17325. // Set minimum TLS version to 1.2
  17326. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17327. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17328. #else
  17329. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17330. MBEDTLS_SSL_MINOR_VERSION_3);
  17331. #endif
  17332. return static_cast<ctx_t>(ctx);
  17333. }
  17334. inline ctx_t create_server_context() {
  17335. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17336. if (!ctx) { return nullptr; }
  17337. ctx->is_server = true;
  17338. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17339. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17340. if (!detail::ensure_mbedtls_psa_crypto()) {
  17341. delete ctx;
  17342. return nullptr;
  17343. }
  17344. int ret;
  17345. #else
  17346. // Seed the random number generator
  17347. const char *pers = "httplib_server";
  17348. int ret = mbedtls_ctr_drbg_seed(
  17349. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17350. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17351. if (ret != 0) {
  17352. impl::mbedtls_last_error() = ret;
  17353. delete ctx;
  17354. return nullptr;
  17355. }
  17356. #endif
  17357. // Set up SSL config for server
  17358. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17359. MBEDTLS_SSL_TRANSPORT_STREAM,
  17360. MBEDTLS_SSL_PRESET_DEFAULT);
  17361. if (ret != 0) {
  17362. impl::mbedtls_last_error() = ret;
  17363. delete ctx;
  17364. return nullptr;
  17365. }
  17366. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17367. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17368. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17369. #endif
  17370. // Default: don't verify client
  17371. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17372. // Set minimum TLS version to 1.2
  17373. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17374. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17375. #else
  17376. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17377. MBEDTLS_SSL_MINOR_VERSION_3);
  17378. #endif
  17379. // Set SNI callback to capture client's SNI hostname
  17380. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17381. return static_cast<ctx_t>(ctx);
  17382. }
  17383. inline void free_context(ctx_t ctx) {
  17384. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17385. }
  17386. inline bool set_min_version(ctx_t ctx, Version version) {
  17387. if (!ctx) { return false; }
  17388. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17389. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17390. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17391. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17392. if (version >= Version::TLS1_3) {
  17393. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17394. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17395. #endif
  17396. }
  17397. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17398. #else
  17399. // Mbed TLS 2.x uses major/minor version numbers
  17400. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17401. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17402. if (version >= Version::TLS1_3) {
  17403. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17404. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17405. #else
  17406. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17407. #endif
  17408. }
  17409. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17410. #endif
  17411. return true;
  17412. }
  17413. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17414. if (!ctx || !pem) { return false; }
  17415. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17416. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17417. // Add null terminator if not present
  17418. std::string pem_str(pem, len);
  17419. int ret = mbedtls_x509_crt_parse(
  17420. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17421. pem_str.size() + 1);
  17422. if (ret != 0) {
  17423. impl::mbedtls_last_error() = ret;
  17424. return false;
  17425. }
  17426. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17427. return true;
  17428. }
  17429. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17430. if (!ctx || !file_path) { return false; }
  17431. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17432. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17433. if (ret != 0) {
  17434. impl::mbedtls_last_error() = ret;
  17435. return false;
  17436. }
  17437. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17438. return true;
  17439. }
  17440. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17441. if (!ctx || !dir_path) { return false; }
  17442. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17443. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17444. if (ret < 0) { // Returns number of certs on success, negative on error
  17445. impl::mbedtls_last_error() = ret;
  17446. return false;
  17447. }
  17448. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17449. return true;
  17450. }
  17451. inline bool load_system_certs(ctx_t ctx) {
  17452. if (!ctx) { return false; }
  17453. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17454. bool loaded = false;
  17455. #ifdef _WIN32
  17456. loaded = impl::enumerate_windows_system_certs(
  17457. [&](const unsigned char *data, size_t len) {
  17458. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17459. });
  17460. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17461. loaded = impl::enumerate_macos_keychain_certs(
  17462. [&](const unsigned char *data, size_t len) {
  17463. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17464. });
  17465. #else
  17466. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17467. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17468. loaded = true;
  17469. break;
  17470. }
  17471. }
  17472. if (!loaded) {
  17473. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17474. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17475. loaded = true;
  17476. break;
  17477. }
  17478. }
  17479. }
  17480. #endif
  17481. if (loaded) {
  17482. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17483. }
  17484. return loaded;
  17485. }
  17486. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17487. const char *password) {
  17488. if (!ctx || !cert || !key) { return false; }
  17489. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17490. // Parse certificate
  17491. std::string cert_str(cert);
  17492. int ret = mbedtls_x509_crt_parse(
  17493. &mctx->own_cert,
  17494. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17495. cert_str.size() + 1);
  17496. if (ret != 0) {
  17497. impl::mbedtls_last_error() = ret;
  17498. return false;
  17499. }
  17500. // Parse private key
  17501. std::string key_str(key);
  17502. const unsigned char *pwd =
  17503. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17504. size_t pwd_len = password ? strlen(password) : 0;
  17505. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17506. ret = mbedtls_pk_parse_key(
  17507. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17508. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17509. &mctx->ctr_drbg);
  17510. #else
  17511. ret = mbedtls_pk_parse_key(
  17512. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17513. key_str.size() + 1, pwd, pwd_len);
  17514. #endif
  17515. if (ret != 0) {
  17516. impl::mbedtls_last_error() = ret;
  17517. return false;
  17518. }
  17519. // Verify that the certificate and private key match.
  17520. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17521. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17522. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17523. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17524. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17525. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17526. #else
  17527. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17528. #endif
  17529. if (ret != 0) {
  17530. impl::mbedtls_last_error() = ret;
  17531. return false;
  17532. }
  17533. #endif
  17534. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17535. if (ret != 0) {
  17536. impl::mbedtls_last_error() = ret;
  17537. return false;
  17538. }
  17539. return true;
  17540. }
  17541. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17542. const char *key_path, const char *password) {
  17543. if (!ctx || !cert_path || !key_path) { return false; }
  17544. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17545. // Parse certificate file
  17546. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17547. if (ret != 0) {
  17548. impl::mbedtls_last_error() = ret;
  17549. return false;
  17550. }
  17551. // Parse private key file
  17552. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17553. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17554. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17555. #else
  17556. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17557. #endif
  17558. if (ret != 0) {
  17559. impl::mbedtls_last_error() = ret;
  17560. return false;
  17561. }
  17562. // Verify that the certificate and private key match.
  17563. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17564. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17565. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17566. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17567. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17568. #else
  17569. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17570. #endif
  17571. if (ret != 0) {
  17572. impl::mbedtls_last_error() = ret;
  17573. return false;
  17574. }
  17575. #endif
  17576. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17577. if (ret != 0) {
  17578. impl::mbedtls_last_error() = ret;
  17579. return false;
  17580. }
  17581. return true;
  17582. }
  17583. inline void set_verify_client(ctx_t ctx, bool require) {
  17584. if (!ctx) { return; }
  17585. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17586. mctx->verify_client = require;
  17587. if (require) {
  17588. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17589. } else {
  17590. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17591. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17592. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17593. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17594. : MBEDTLS_SSL_VERIFY_NONE);
  17595. }
  17596. }
  17597. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17598. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17599. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17600. auto session = new (std::nothrow) impl::MbedTlsSession();
  17601. if (!session) { return nullptr; }
  17602. session->sock = sock;
  17603. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17604. if (ret != 0) {
  17605. impl::mbedtls_last_error() = ret;
  17606. delete session;
  17607. return nullptr;
  17608. }
  17609. // Explicitly opt out of in-handshake hostname verification by default;
  17610. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17611. // fails outright when no hostname was set. set_sni() installs the real
  17612. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17613. // caller verifies the certificate identity post-handshake via
  17614. // verify_hostname().
  17615. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17616. // Set BIO callbacks
  17617. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17618. impl::mbedtls_net_recv_cb, nullptr);
  17619. // Set per-session verify callback with session pointer if callback is
  17620. // registered
  17621. session->has_verify_callback = mctx->has_verify_callback;
  17622. if (mctx->has_verify_callback) {
  17623. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17624. session);
  17625. }
  17626. return static_cast<session_t>(session);
  17627. }
  17628. inline void free_session(session_t session) {
  17629. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17630. }
  17631. inline bool set_sni(session_t session, const char *hostname,
  17632. bool verify_hostname) {
  17633. if (!session || !hostname) { return false; }
  17634. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17635. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17636. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17637. // independently, so a disabled hostname check is handled below by masking
  17638. // the resulting mismatch flag instead of skipping this call.
  17639. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17640. if (ret != 0) {
  17641. impl::mbedtls_last_error() = ret;
  17642. return false;
  17643. }
  17644. msession->hostname = hostname;
  17645. if (!verify_hostname) {
  17646. msession->suppress_hostname_mismatch = true;
  17647. // If a user verify callback is already wired for this session,
  17648. // mbedtls_verify_callback() masks the mismatch flag itself before
  17649. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17650. // here would be redundant. Otherwise install the self-contained masking
  17651. // callback, which never touches the process-wide callback slot.
  17652. if (!msession->has_verify_callback) {
  17653. mbedtls_ssl_set_verify(&msession->ssl,
  17654. impl::mbedtls_mask_hostname_mismatch_callback,
  17655. msession);
  17656. }
  17657. }
  17658. return true;
  17659. }
  17660. inline TlsError connect(session_t session) {
  17661. TlsError err;
  17662. if (!session) {
  17663. err.code = ErrorCode::Fatal;
  17664. return err;
  17665. }
  17666. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17667. int ret;
  17668. do {
  17669. ret = mbedtls_ssl_handshake(&msession->ssl);
  17670. } while (impl::mbedtls_is_session_ticket(ret));
  17671. if (ret == 0) {
  17672. err.code = ErrorCode::Success;
  17673. } else {
  17674. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17675. impl::mbedtls_last_error() = ret;
  17676. }
  17677. return err;
  17678. }
  17679. inline TlsError accept(session_t session) {
  17680. // Same as connect for Mbed TLS - handshake works for both client and server
  17681. auto result = connect(session);
  17682. // After successful handshake, capture SNI from thread-local storage
  17683. if (result.code == ErrorCode::Success && session) {
  17684. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17685. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17686. impl::mbedpending_sni().clear();
  17687. }
  17688. return result;
  17689. }
  17690. inline bool connect_nonblocking(session_t session, socket_t sock,
  17691. time_t timeout_sec, time_t timeout_usec,
  17692. TlsError *err) {
  17693. if (!session) {
  17694. if (err) { err->code = ErrorCode::Fatal; }
  17695. return false;
  17696. }
  17697. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17698. // Set socket to non-blocking mode
  17699. detail::set_nonblocking(sock, true);
  17700. auto cleanup =
  17701. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17702. int ret;
  17703. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17704. // Non-fatal TLS 1.3 ticket; retry immediately.
  17705. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17706. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17707. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17708. continue;
  17709. }
  17710. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17711. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17712. continue;
  17713. }
  17714. }
  17715. // TlsError or timeout
  17716. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17717. impl::mbedtls_last_error() = ret;
  17718. return false;
  17719. }
  17720. if (err) { err->code = ErrorCode::Success; }
  17721. return true;
  17722. }
  17723. inline bool accept_nonblocking(session_t session, socket_t sock,
  17724. time_t timeout_sec, time_t timeout_usec,
  17725. TlsError *err) {
  17726. // Same implementation as connect for Mbed TLS
  17727. bool result =
  17728. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17729. // After successful handshake, capture SNI from thread-local storage
  17730. if (result && session) {
  17731. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17732. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17733. impl::mbedpending_sni().clear();
  17734. }
  17735. return result;
  17736. }
  17737. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17738. if (!session || !buf) {
  17739. err.code = ErrorCode::Fatal;
  17740. return -1;
  17741. }
  17742. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17743. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17744. if (msession->has_peeked_byte) {
  17745. if (len == 0) { return 0; }
  17746. auto p = static_cast<unsigned char *>(buf);
  17747. p[0] = msession->peeked_byte;
  17748. msession->has_peeked_byte = false;
  17749. size_t n = 1;
  17750. // Top up with any already-decrypted bytes without risking a block.
  17751. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17752. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17753. if (extra > 0) { n += static_cast<size_t>(extra); }
  17754. }
  17755. err.code = ErrorCode::Success;
  17756. return static_cast<ssize_t>(n);
  17757. }
  17758. int ret;
  17759. do {
  17760. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17761. len);
  17762. } while (impl::mbedtls_is_session_ticket(ret));
  17763. if (ret > 0) {
  17764. err.code = ErrorCode::Success;
  17765. return static_cast<ssize_t>(ret);
  17766. }
  17767. if (ret == 0) {
  17768. err.code = ErrorCode::PeerClosed;
  17769. return 0;
  17770. }
  17771. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17772. err.backend_code = static_cast<uint64_t>(-ret);
  17773. impl::mbedtls_last_error() = ret;
  17774. // mbedTLS signals a clean close_notify via a negative error code rather
  17775. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17776. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17777. return -1;
  17778. }
  17779. inline ssize_t write(session_t session, const void *buf, size_t len,
  17780. TlsError &err) {
  17781. if (!session || !buf) {
  17782. err.code = ErrorCode::Fatal;
  17783. return -1;
  17784. }
  17785. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17786. int ret;
  17787. do {
  17788. ret = mbedtls_ssl_write(&msession->ssl,
  17789. static_cast<const unsigned char *>(buf), len);
  17790. } while (impl::mbedtls_is_session_ticket(ret));
  17791. if (ret > 0) {
  17792. err.code = ErrorCode::Success;
  17793. return static_cast<ssize_t>(ret);
  17794. }
  17795. if (ret == 0) {
  17796. err.code = ErrorCode::PeerClosed;
  17797. return 0;
  17798. }
  17799. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17800. err.backend_code = static_cast<uint64_t>(-ret);
  17801. impl::mbedtls_last_error() = ret;
  17802. return -1;
  17803. }
  17804. inline int pending(const_session_t session) {
  17805. if (!session) { return 0; }
  17806. auto msession =
  17807. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17808. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17809. (msession->has_peeked_byte ? 1 : 0);
  17810. }
  17811. inline void shutdown(session_t session, bool graceful) {
  17812. if (!session) { return; }
  17813. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17814. if (graceful) {
  17815. // Try to send close_notify, but don't block forever
  17816. int ret;
  17817. int attempts = 0;
  17818. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17819. attempts < 3) {
  17820. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17821. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17822. break;
  17823. }
  17824. attempts++;
  17825. }
  17826. }
  17827. }
  17828. inline bool is_peer_closed(session_t session, socket_t sock) {
  17829. if (!session || sock == INVALID_SOCKET) { return true; }
  17830. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17831. // Check if there's already decrypted or pushed-back data available.
  17832. // If so, the connection is definitely alive.
  17833. if (msession->has_peeked_byte ||
  17834. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17835. return false;
  17836. }
  17837. // Set socket to non-blocking to avoid blocking on read
  17838. detail::set_nonblocking(sock, true);
  17839. auto cleanup =
  17840. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17841. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17842. // on application data — e.g. a response that already arrived — push the
  17843. // byte back so the next read() delivers it instead of losing it.
  17844. unsigned char buf;
  17845. int ret;
  17846. do {
  17847. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17848. } while (impl::mbedtls_is_session_ticket(ret));
  17849. // If we got data or WANT_READ (would block), connection is alive
  17850. if (ret > 0) {
  17851. msession->peeked_byte = buf;
  17852. msession->has_peeked_byte = true;
  17853. return false;
  17854. }
  17855. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17856. // If we get a peer close notify or a connection reset, the peer is closed
  17857. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17858. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17859. }
  17860. inline cert_t get_peer_cert(const_session_t session) {
  17861. if (!session) { return nullptr; }
  17862. auto msession =
  17863. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17864. // Mbed TLS returns a pointer to the internal peer cert chain.
  17865. // WARNING: This pointer is only valid while the session is active.
  17866. // Do not use the certificate after calling free_session().
  17867. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17868. return const_cast<mbedtls_x509_crt *>(cert);
  17869. }
  17870. inline size_t get_peer_certs(const_session_t session,
  17871. std::vector<cert_t> &certs) {
  17872. certs.clear();
  17873. // Mbed TLS parses the whole received chain into a list headed by the peer
  17874. // certificate, owned by the session like get_peer_cert()'s result
  17875. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  17876. crt && crt->raw.len > 0; crt = crt->next) {
  17877. certs.push_back(static_cast<cert_t>(crt));
  17878. }
  17879. return certs.size();
  17880. }
  17881. inline void free_cert(cert_t cert) {
  17882. // Mbed TLS: peer certificate is owned by the SSL context.
  17883. // No-op here, but callers should still call this for cross-backend
  17884. // portability.
  17885. (void)cert;
  17886. }
  17887. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17888. if (!cert || !hostname) { return false; }
  17889. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17890. std::string host_str(hostname);
  17891. // Check if hostname is an IP address (IPv4 or IPv6)
  17892. unsigned char ip_bytes[16];
  17893. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17894. auto is_ip = ip_len > 0;
  17895. // Check Subject Alternative Names (SAN)
  17896. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17897. // - DNS names: raw string bytes
  17898. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17899. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17900. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17901. const unsigned char *p = san->buf.p;
  17902. size_t len = san->buf.len;
  17903. if (is_ip) {
  17904. // For an IP host, only a matching iPAddress SAN of the same family
  17905. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17906. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17907. } else {
  17908. // Check if this SAN is a DNS name (printable ASCII string)
  17909. bool is_dns = len > 0;
  17910. for (size_t i = 0; i < len && is_dns; i++) {
  17911. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17912. }
  17913. if (is_dns) {
  17914. std::string san_name(reinterpret_cast<const char *>(p), len);
  17915. if (detail::match_hostname(san_name, host_str)) { return true; }
  17916. }
  17917. }
  17918. san = san->next;
  17919. }
  17920. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17921. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17922. // the OpenSSL backend's X509_check_ip behaves the same way).
  17923. if (!is_ip) {
  17924. char cn[256];
  17925. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17926. if (ret > 0) {
  17927. std::string cn_str(cn);
  17928. // Look for "CN=" in the DN string
  17929. size_t cn_pos = cn_str.find("CN=");
  17930. if (cn_pos != std::string::npos) {
  17931. size_t start = cn_pos + 3;
  17932. size_t end = cn_str.find(',', start);
  17933. std::string cn_value =
  17934. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17935. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17936. }
  17937. }
  17938. }
  17939. return false;
  17940. }
  17941. inline uint64_t hostname_mismatch_code() {
  17942. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17943. }
  17944. inline long get_verify_result(const_session_t session) {
  17945. if (!session) { return -1; }
  17946. auto msession =
  17947. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17948. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17949. // Return 0 (X509_V_OK equivalent) if verification passed
  17950. return flags == 0 ? 0 : static_cast<long>(flags);
  17951. }
  17952. inline std::string get_cert_subject_cn(cert_t cert) {
  17953. if (!cert) return "";
  17954. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17955. // Find the CN in the subject
  17956. const mbedtls_x509_name *name = &x509->subject;
  17957. while (name != nullptr) {
  17958. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17959. return std::string(reinterpret_cast<const char *>(name->val.p),
  17960. name->val.len);
  17961. }
  17962. name = name->next;
  17963. }
  17964. return "";
  17965. }
  17966. inline std::string get_cert_issuer_name(cert_t cert) {
  17967. if (!cert) return "";
  17968. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17969. // Build a human-readable issuer name string
  17970. char buf[512];
  17971. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17972. if (ret < 0) return "";
  17973. return std::string(buf);
  17974. }
  17975. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17976. sans.clear();
  17977. if (!cert) return false;
  17978. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17979. // Parse the Subject Alternative Name extension
  17980. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17981. while (cur != nullptr) {
  17982. if (cur->buf.len > 0) {
  17983. // Mbed TLS stores SAN as ASN.1 sequences
  17984. // The tag byte indicates the type
  17985. const unsigned char *p = cur->buf.p;
  17986. size_t len = cur->buf.len;
  17987. // First byte is the tag
  17988. unsigned char tag = *p;
  17989. p++;
  17990. len--;
  17991. // Parse length (simple single-byte length assumed)
  17992. if (len > 0 && *p < 0x80) {
  17993. size_t value_len = *p;
  17994. p++;
  17995. len--;
  17996. if (value_len <= len) {
  17997. SanEntry entry;
  17998. // ASN.1 context tags for GeneralName
  17999. switch (tag & 0x1F) {
  18000. case 2: // dNSName
  18001. entry.type = SanType::DNS;
  18002. entry.value =
  18003. std::string(reinterpret_cast<const char *>(p), value_len);
  18004. break;
  18005. case 7: // iPAddress
  18006. entry.type = SanType::IP;
  18007. if (value_len == 4) {
  18008. // IPv4
  18009. char buf[16];
  18010. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18011. entry.value = buf;
  18012. } else if (value_len == 16) {
  18013. // IPv6
  18014. char buf[64];
  18015. snprintf(buf, sizeof(buf),
  18016. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18017. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18018. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  18019. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  18020. entry.value = buf;
  18021. }
  18022. break;
  18023. case 1: // rfc822Name (email)
  18024. entry.type = SanType::EMAIL;
  18025. entry.value =
  18026. std::string(reinterpret_cast<const char *>(p), value_len);
  18027. break;
  18028. case 6: // uniformResourceIdentifier
  18029. entry.type = SanType::URI;
  18030. entry.value =
  18031. std::string(reinterpret_cast<const char *>(p), value_len);
  18032. break;
  18033. default: entry.type = SanType::OTHER; break;
  18034. }
  18035. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18036. }
  18037. }
  18038. }
  18039. cur = cur->next;
  18040. }
  18041. return true;
  18042. }
  18043. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18044. time_t &not_after) {
  18045. if (!cert) return false;
  18046. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18047. // Convert mbedtls_x509_time to time_t
  18048. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18049. struct tm tm_time = {};
  18050. tm_time.tm_year = t.year - 1900;
  18051. tm_time.tm_mon = t.mon - 1;
  18052. tm_time.tm_mday = t.day;
  18053. tm_time.tm_hour = t.hour;
  18054. tm_time.tm_min = t.min;
  18055. tm_time.tm_sec = t.sec;
  18056. #ifdef _WIN32
  18057. return _mkgmtime(&tm_time);
  18058. #else
  18059. return timegm(&tm_time);
  18060. #endif
  18061. };
  18062. not_before = to_time_t(x509->valid_from);
  18063. not_after = to_time_t(x509->valid_to);
  18064. return true;
  18065. }
  18066. inline std::string get_cert_serial(cert_t cert) {
  18067. if (!cert) return "";
  18068. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18069. // Convert serial number to hex string
  18070. std::string result;
  18071. result.reserve(x509->serial.len * 2);
  18072. for (size_t i = 0; i < x509->serial.len; i++) {
  18073. char hex[3];
  18074. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18075. result += hex;
  18076. }
  18077. return result;
  18078. }
  18079. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18080. if (!cert) return false;
  18081. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18082. if (!crt->raw.p || crt->raw.len == 0) return false;
  18083. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18084. return true;
  18085. }
  18086. inline const char *get_sni(const_session_t session) {
  18087. if (!session) return nullptr;
  18088. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18089. // For server: return SNI received from client during handshake
  18090. if (!msession->sni_hostname.empty()) {
  18091. return msession->sni_hostname.c_str();
  18092. }
  18093. // For client: return the hostname set via set_sni
  18094. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18095. return nullptr;
  18096. }
  18097. inline uint64_t peek_error() {
  18098. // Mbed TLS doesn't have an error queue, return the last error
  18099. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18100. }
  18101. inline uint64_t get_error() {
  18102. // Mbed TLS doesn't have an error queue, return and clear the last error
  18103. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18104. impl::mbedtls_last_error() = 0;
  18105. return err;
  18106. }
  18107. inline std::string error_string(uint64_t code) {
  18108. char buf[256];
  18109. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18110. return std::string(buf);
  18111. }
  18112. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18113. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18114. if (!ca_chain) { return nullptr; }
  18115. mbedtls_x509_crt_init(ca_chain);
  18116. // mbedtls_x509_crt_parse expects null-terminated PEM
  18117. int ret = mbedtls_x509_crt_parse(ca_chain,
  18118. reinterpret_cast<const unsigned char *>(pem),
  18119. len + 1); // +1 for null terminator
  18120. if (ret != 0) {
  18121. // Try without +1 in case PEM is already null-terminated
  18122. ret = mbedtls_x509_crt_parse(
  18123. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18124. if (ret != 0) {
  18125. mbedtls_x509_crt_free(ca_chain);
  18126. delete ca_chain;
  18127. return nullptr;
  18128. }
  18129. }
  18130. return static_cast<ca_store_t>(ca_chain);
  18131. }
  18132. inline void free_ca_store(ca_store_t store) {
  18133. if (store) {
  18134. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18135. mbedtls_x509_crt_free(ca_chain);
  18136. delete ca_chain;
  18137. }
  18138. }
  18139. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18140. if (!ctx || !store) { return false; }
  18141. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18142. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18143. // Free existing CA chain
  18144. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18145. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18146. // Copy the CA chain (deep copy)
  18147. // Parse from the raw data of the source cert
  18148. mbedtls_x509_crt *src = ca_chain;
  18149. while (src != nullptr) {
  18150. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18151. src->raw.len);
  18152. if (ret != 0) {
  18153. free_ca_store(store);
  18154. return false;
  18155. }
  18156. src = src->next;
  18157. }
  18158. // This function takes ownership of the store; the chain was deep-copied
  18159. // above, so release the source
  18160. free_ca_store(store);
  18161. // Update the SSL config to use the new CA chain
  18162. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18163. return true;
  18164. }
  18165. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18166. certs.clear();
  18167. if (!ctx) { return 0; }
  18168. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18169. // Iterate through the CA chain
  18170. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18171. while (cert != nullptr && cert->raw.len > 0) {
  18172. // Create a copy of the certificate for the caller
  18173. auto *copy = new mbedtls_x509_crt;
  18174. mbedtls_x509_crt_init(copy);
  18175. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18176. if (ret == 0) {
  18177. certs.push_back(static_cast<cert_t>(copy));
  18178. } else {
  18179. mbedtls_x509_crt_free(copy);
  18180. delete copy;
  18181. }
  18182. cert = cert->next;
  18183. }
  18184. return certs.size();
  18185. }
  18186. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18187. std::vector<std::string> names;
  18188. if (!ctx) { return names; }
  18189. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18190. // Iterate through the CA chain
  18191. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18192. while (cert != nullptr && cert->raw.len > 0) {
  18193. char buf[512];
  18194. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18195. if (ret > 0) { names.push_back(buf); }
  18196. cert = cert->next;
  18197. }
  18198. return names;
  18199. }
  18200. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18201. const char *key_pem, const char *password) {
  18202. if (!ctx || !cert_pem || !key_pem) { return false; }
  18203. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18204. // Free existing certificate and key
  18205. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18206. mbedtls_pk_free(&mbed_ctx->own_key);
  18207. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18208. mbedtls_pk_init(&mbed_ctx->own_key);
  18209. // Parse certificate PEM
  18210. int ret = mbedtls_x509_crt_parse(
  18211. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18212. strlen(cert_pem) + 1);
  18213. if (ret != 0) {
  18214. impl::mbedtls_last_error() = ret;
  18215. return false;
  18216. }
  18217. // Parse private key PEM
  18218. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18219. ret = mbedtls_pk_parse_key(
  18220. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18221. strlen(key_pem) + 1,
  18222. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18223. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18224. &mbed_ctx->ctr_drbg);
  18225. #else
  18226. ret = mbedtls_pk_parse_key(
  18227. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18228. strlen(key_pem) + 1,
  18229. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18230. password ? strlen(password) : 0);
  18231. #endif
  18232. if (ret != 0) {
  18233. impl::mbedtls_last_error() = ret;
  18234. return false;
  18235. }
  18236. // Configure SSL to use the new certificate and key
  18237. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18238. &mbed_ctx->own_key);
  18239. if (ret != 0) {
  18240. impl::mbedtls_last_error() = ret;
  18241. return false;
  18242. }
  18243. return true;
  18244. }
  18245. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18246. if (!ctx || !ca_pem) { return false; }
  18247. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18248. // Free existing CA chain
  18249. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18250. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18251. // Parse CA PEM
  18252. int ret = mbedtls_x509_crt_parse(
  18253. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18254. strlen(ca_pem) + 1);
  18255. if (ret != 0) {
  18256. impl::mbedtls_last_error() = ret;
  18257. return false;
  18258. }
  18259. // Update SSL config to use new CA chain
  18260. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18261. return true;
  18262. }
  18263. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18264. if (!ctx) { return false; }
  18265. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18266. impl::get_verify_callback() = std::move(callback);
  18267. mbed_ctx->has_verify_callback =
  18268. static_cast<bool>(impl::get_verify_callback());
  18269. if (mbed_ctx->has_verify_callback) {
  18270. // Set OPTIONAL mode to ensure callback is called even when verification
  18271. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18272. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18273. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  18274. nullptr);
  18275. } else {
  18276. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  18277. }
  18278. return true;
  18279. }
  18280. inline long get_verify_error(const_session_t session) {
  18281. if (!session) { return -1; }
  18282. auto *msession =
  18283. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18284. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18285. }
  18286. inline std::string verify_error_string(long error_code) {
  18287. if (error_code == 0) { return ""; }
  18288. char buf[256];
  18289. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18290. static_cast<uint32_t>(error_code));
  18291. // Remove trailing newline if present
  18292. std::string result(buf);
  18293. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18294. result.pop_back();
  18295. }
  18296. return result;
  18297. }
  18298. } // namespace tls
  18299. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18300. /*
  18301. * Group 10: TLS abstraction layer - wolfSSL backend
  18302. */
  18303. /*
  18304. * wolfSSL Backend Implementation
  18305. */
  18306. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18307. namespace tls {
  18308. namespace impl {
  18309. // wolfSSL session wrapper
  18310. struct WolfSSLSession {
  18311. WOLFSSL *ssl = nullptr;
  18312. socket_t sock = INVALID_SOCKET;
  18313. std::string hostname; // For client: set via set_sni
  18314. std::string sni_hostname; // For server: received from client via SNI callback
  18315. WolfSSLSession() = default;
  18316. ~WolfSSLSession() {
  18317. if (ssl) { wolfSSL_free(ssl); }
  18318. }
  18319. WolfSSLSession(const WolfSSLSession &) = delete;
  18320. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18321. };
  18322. // Thread-local error code accessor for wolfSSL
  18323. inline uint64_t &wolfssl_last_error() {
  18324. static thread_local uint64_t err = 0;
  18325. return err;
  18326. }
  18327. // Helper to map wolfSSL error to ErrorCode.
  18328. // ssl_error is the value from wolfSSL_get_error().
  18329. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18330. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18331. int &out_errno) {
  18332. switch (ssl_error) {
  18333. case SSL_ERROR_NONE: return ErrorCode::Success;
  18334. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18335. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18336. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18337. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18338. default:
  18339. if (ssl) {
  18340. // wolfSSL stores the low-level error code as a negative value.
  18341. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18342. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18343. if (low_err == DOMAIN_NAME_MISMATCH) {
  18344. return ErrorCode::HostnameMismatch;
  18345. }
  18346. // Check verify result to distinguish cert verification from generic SSL
  18347. // errors.
  18348. long vr = wolfSSL_get_verify_result(ssl);
  18349. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18350. }
  18351. return ErrorCode::Fatal;
  18352. }
  18353. }
  18354. // WolfSSLContext constructor/destructor implementations
  18355. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18356. inline WolfSSLContext::~WolfSSLContext() {
  18357. if (ctx) { wolfSSL_CTX_free(ctx); }
  18358. }
  18359. // Thread-local storage for SNI captured during handshake
  18360. inline std::string &wolfssl_pending_sni() {
  18361. static thread_local std::string sni;
  18362. return sni;
  18363. }
  18364. // SNI callback for wolfSSL server to capture client's SNI hostname
  18365. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18366. (void)ret;
  18367. (void)exArg;
  18368. void *name_data = nullptr;
  18369. unsigned short name_len =
  18370. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18371. if (name_data && name_len > 0) {
  18372. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18373. name_len);
  18374. } else {
  18375. wolfssl_pending_sni().clear();
  18376. }
  18377. return 0; // Continue regardless
  18378. }
  18379. // wolfSSL verify callback wrapper
  18380. inline int wolfssl_verify_callback(int preverify_ok,
  18381. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18382. auto &callback = get_verify_callback();
  18383. if (!callback) { return preverify_ok; }
  18384. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18385. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18386. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18387. // Get the WOLFSSL object from the X509_STORE_CTX
  18388. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18389. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18390. VerifyContext verify_ctx;
  18391. verify_ctx.session = static_cast<session_t>(ssl);
  18392. verify_ctx.cert = static_cast<cert_t>(cert);
  18393. verify_ctx.depth = depth;
  18394. verify_ctx.preverify_ok = (preverify_ok != 0);
  18395. verify_ctx.error_code = static_cast<long>(err);
  18396. if (err != 0) {
  18397. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18398. } else {
  18399. verify_ctx.error_string = nullptr;
  18400. }
  18401. bool accepted = callback(verify_ctx);
  18402. return accepted ? 1 : 0;
  18403. }
  18404. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18405. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18406. wolfSSL_CTX_set_default_passwd_cb(
  18407. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18408. auto *pwd = static_cast<const char *>(userdata);
  18409. if (!pwd) return 0;
  18410. auto len = static_cast<int>(strlen(pwd));
  18411. if (len > size) len = size;
  18412. memcpy(buf, pwd, static_cast<size_t>(len));
  18413. return len;
  18414. });
  18415. }
  18416. } // namespace impl
  18417. inline ctx_t create_client_context() {
  18418. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18419. if (!ctx) { return nullptr; }
  18420. ctx->is_server = false;
  18421. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18422. if (!method) {
  18423. delete ctx;
  18424. return nullptr;
  18425. }
  18426. ctx->ctx = wolfSSL_CTX_new(method);
  18427. if (!ctx->ctx) {
  18428. delete ctx;
  18429. return nullptr;
  18430. }
  18431. // Default: verify peer certificate
  18432. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18433. return static_cast<ctx_t>(ctx);
  18434. }
  18435. inline ctx_t create_server_context() {
  18436. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18437. if (!ctx) { return nullptr; }
  18438. ctx->is_server = true;
  18439. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18440. if (!method) {
  18441. delete ctx;
  18442. return nullptr;
  18443. }
  18444. ctx->ctx = wolfSSL_CTX_new(method);
  18445. if (!ctx->ctx) {
  18446. delete ctx;
  18447. return nullptr;
  18448. }
  18449. // Default: don't verify client
  18450. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18451. // Enable SNI on server
  18452. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18453. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18454. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18455. return static_cast<ctx_t>(ctx);
  18456. }
  18457. inline void free_context(ctx_t ctx) {
  18458. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18459. }
  18460. inline bool set_min_version(ctx_t ctx, Version version) {
  18461. if (!ctx) { return false; }
  18462. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18463. int min_ver = WOLFSSL_TLSV1_2;
  18464. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18465. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18466. }
  18467. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18468. if (!ctx || !pem) { return false; }
  18469. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18470. int ret = wolfSSL_CTX_load_verify_buffer(
  18471. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18472. static_cast<long>(len), SSL_FILETYPE_PEM);
  18473. if (ret != SSL_SUCCESS) {
  18474. impl::wolfssl_last_error() =
  18475. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18476. return false;
  18477. }
  18478. wctx->ca_pem_data_.append(pem, len);
  18479. return true;
  18480. }
  18481. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18482. if (!ctx || !file_path) { return false; }
  18483. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18484. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18485. if (ret != SSL_SUCCESS) {
  18486. impl::wolfssl_last_error() =
  18487. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18488. return false;
  18489. }
  18490. return true;
  18491. }
  18492. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18493. if (!ctx || !dir_path) { return false; }
  18494. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18495. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18496. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18497. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18498. // immediately. Return true even on failure since the CA file may have
  18499. // already been loaded, matching OpenSSL's lenient behavior.
  18500. (void)ret;
  18501. return true;
  18502. }
  18503. inline bool load_system_certs(ctx_t ctx) {
  18504. if (!ctx) { return false; }
  18505. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18506. bool loaded = false;
  18507. #ifdef _WIN32
  18508. loaded = impl::enumerate_windows_system_certs(
  18509. [&](const unsigned char *data, size_t len) {
  18510. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18511. static_cast<long>(len),
  18512. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18513. });
  18514. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18515. loaded = impl::enumerate_macos_keychain_certs(
  18516. [&](const unsigned char *data, size_t len) {
  18517. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18518. static_cast<long>(len),
  18519. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18520. });
  18521. #else
  18522. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18523. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18524. SSL_SUCCESS) {
  18525. loaded = true;
  18526. break;
  18527. }
  18528. }
  18529. if (!loaded) {
  18530. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18531. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18532. SSL_SUCCESS) {
  18533. loaded = true;
  18534. break;
  18535. }
  18536. }
  18537. }
  18538. #endif
  18539. return loaded;
  18540. }
  18541. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18542. const char *password) {
  18543. if (!ctx || !cert || !key) { return false; }
  18544. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18545. // Load certificate
  18546. int ret = wolfSSL_CTX_use_certificate_buffer(
  18547. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18548. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18549. if (ret != SSL_SUCCESS) {
  18550. impl::wolfssl_last_error() =
  18551. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18552. return false;
  18553. }
  18554. // Set password callback if password is provided
  18555. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18556. // Load private key
  18557. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18558. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18559. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18560. if (ret != SSL_SUCCESS) {
  18561. impl::wolfssl_last_error() =
  18562. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18563. return false;
  18564. }
  18565. // Verify that the certificate and private key match
  18566. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18567. }
  18568. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18569. const char *key_path, const char *password) {
  18570. if (!ctx || !cert_path || !key_path) { return false; }
  18571. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18572. // Load certificate file
  18573. int ret =
  18574. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18575. if (ret != SSL_SUCCESS) {
  18576. impl::wolfssl_last_error() =
  18577. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18578. return false;
  18579. }
  18580. // Set password callback if password is provided
  18581. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18582. // Load private key file
  18583. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18584. if (ret != SSL_SUCCESS) {
  18585. impl::wolfssl_last_error() =
  18586. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18587. return false;
  18588. }
  18589. // Verify that the certificate and private key match
  18590. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18591. }
  18592. inline void set_verify_client(ctx_t ctx, bool require) {
  18593. if (!ctx) { return; }
  18594. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18595. wctx->verify_client = require;
  18596. if (require) {
  18597. wolfSSL_CTX_set_verify(
  18598. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18599. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18600. } else {
  18601. if (wctx->has_verify_callback) {
  18602. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18603. impl::wolfssl_verify_callback);
  18604. } else {
  18605. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18606. }
  18607. }
  18608. }
  18609. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18610. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18611. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18612. auto session = new (std::nothrow) impl::WolfSSLSession();
  18613. if (!session) { return nullptr; }
  18614. session->sock = sock;
  18615. session->ssl = wolfSSL_new(wctx->ctx);
  18616. if (!session->ssl) {
  18617. impl::wolfssl_last_error() =
  18618. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18619. delete session;
  18620. return nullptr;
  18621. }
  18622. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18623. return static_cast<session_t>(session);
  18624. }
  18625. inline void free_session(session_t session) {
  18626. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18627. }
  18628. inline bool set_sni(session_t session, const char *hostname,
  18629. bool verify_hostname) {
  18630. if (!session || !hostname) { return false; }
  18631. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18632. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18633. static_cast<word16>(strlen(hostname)));
  18634. if (ret != WOLFSSL_SUCCESS) {
  18635. impl::wolfssl_last_error() =
  18636. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18637. return false;
  18638. }
  18639. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18640. // separately from the SNI extension sent above; skip it when hostname
  18641. // verification is disabled so only the chain is checked, matching OpenSSL.
  18642. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18643. wsession->hostname = hostname;
  18644. return true;
  18645. }
  18646. inline TlsError connect(session_t session) {
  18647. TlsError err;
  18648. if (!session) {
  18649. err.code = ErrorCode::Fatal;
  18650. return err;
  18651. }
  18652. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18653. int ret = wolfSSL_connect(wsession->ssl);
  18654. if (ret == SSL_SUCCESS) {
  18655. err.code = ErrorCode::Success;
  18656. } else {
  18657. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18658. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18659. err.backend_code = static_cast<uint64_t>(ssl_error);
  18660. impl::wolfssl_last_error() = err.backend_code;
  18661. }
  18662. return err;
  18663. }
  18664. inline TlsError accept(session_t session) {
  18665. TlsError err;
  18666. if (!session) {
  18667. err.code = ErrorCode::Fatal;
  18668. return err;
  18669. }
  18670. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18671. int ret = wolfSSL_accept(wsession->ssl);
  18672. if (ret == SSL_SUCCESS) {
  18673. err.code = ErrorCode::Success;
  18674. // Capture SNI from thread-local storage after successful handshake
  18675. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18676. impl::wolfssl_pending_sni().clear();
  18677. } else {
  18678. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18679. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18680. err.backend_code = static_cast<uint64_t>(ssl_error);
  18681. impl::wolfssl_last_error() = err.backend_code;
  18682. }
  18683. return err;
  18684. }
  18685. inline bool connect_nonblocking(session_t session, socket_t sock,
  18686. time_t timeout_sec, time_t timeout_usec,
  18687. TlsError *err) {
  18688. if (!session) {
  18689. if (err) { err->code = ErrorCode::Fatal; }
  18690. return false;
  18691. }
  18692. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18693. // Set socket to non-blocking mode
  18694. detail::set_nonblocking(sock, true);
  18695. auto cleanup =
  18696. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18697. int ret;
  18698. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18699. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18700. if (ssl_error == SSL_ERROR_WANT_READ) {
  18701. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18702. continue;
  18703. }
  18704. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18705. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18706. continue;
  18707. }
  18708. }
  18709. // Error or timeout
  18710. if (err) {
  18711. err->code =
  18712. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18713. err->backend_code = static_cast<uint64_t>(ssl_error);
  18714. }
  18715. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18716. return false;
  18717. }
  18718. if (err) { err->code = ErrorCode::Success; }
  18719. return true;
  18720. }
  18721. inline bool accept_nonblocking(session_t session, socket_t sock,
  18722. time_t timeout_sec, time_t timeout_usec,
  18723. TlsError *err) {
  18724. if (!session) {
  18725. if (err) { err->code = ErrorCode::Fatal; }
  18726. return false;
  18727. }
  18728. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18729. // Set socket to non-blocking mode
  18730. detail::set_nonblocking(sock, true);
  18731. auto cleanup =
  18732. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18733. int ret;
  18734. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18735. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18736. if (ssl_error == SSL_ERROR_WANT_READ) {
  18737. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18738. continue;
  18739. }
  18740. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18741. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18742. continue;
  18743. }
  18744. }
  18745. // Error or timeout
  18746. if (err) {
  18747. err->code =
  18748. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18749. err->backend_code = static_cast<uint64_t>(ssl_error);
  18750. }
  18751. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18752. return false;
  18753. }
  18754. if (err) { err->code = ErrorCode::Success; }
  18755. // Capture SNI from thread-local storage after successful handshake
  18756. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18757. impl::wolfssl_pending_sni().clear();
  18758. return true;
  18759. }
  18760. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18761. if (!session || !buf) {
  18762. err.code = ErrorCode::Fatal;
  18763. return -1;
  18764. }
  18765. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18766. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18767. if (ret > 0) {
  18768. err.code = ErrorCode::Success;
  18769. return static_cast<ssize_t>(ret);
  18770. }
  18771. if (ret == 0) {
  18772. err.code = ErrorCode::PeerClosed;
  18773. return 0;
  18774. }
  18775. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18776. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18777. err.backend_code = static_cast<uint64_t>(ssl_error);
  18778. impl::wolfssl_last_error() = err.backend_code;
  18779. return -1;
  18780. }
  18781. inline ssize_t write(session_t session, const void *buf, size_t len,
  18782. TlsError &err) {
  18783. if (!session || !buf) {
  18784. err.code = ErrorCode::Fatal;
  18785. return -1;
  18786. }
  18787. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18788. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18789. if (ret > 0) {
  18790. err.code = ErrorCode::Success;
  18791. return static_cast<ssize_t>(ret);
  18792. }
  18793. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18794. // Treat this as an error (return -1) so callers don't spin in a
  18795. // write loop adding zero to the offset.
  18796. if (ret == 0) {
  18797. err.code = ErrorCode::PeerClosed;
  18798. return -1;
  18799. }
  18800. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18801. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18802. err.backend_code = static_cast<uint64_t>(ssl_error);
  18803. impl::wolfssl_last_error() = err.backend_code;
  18804. return -1;
  18805. }
  18806. inline int pending(const_session_t session) {
  18807. if (!session) { return 0; }
  18808. auto wsession =
  18809. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18810. return wolfSSL_pending(wsession->ssl);
  18811. }
  18812. inline void shutdown(session_t session, bool graceful) {
  18813. if (!session) { return; }
  18814. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18815. if (graceful) {
  18816. int ret;
  18817. int attempts = 0;
  18818. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18819. attempts < 3) {
  18820. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18821. if (ssl_error != SSL_ERROR_WANT_READ &&
  18822. ssl_error != SSL_ERROR_WANT_WRITE) {
  18823. break;
  18824. }
  18825. attempts++;
  18826. }
  18827. } else {
  18828. wolfSSL_shutdown(wsession->ssl);
  18829. }
  18830. }
  18831. inline bool is_peer_closed(session_t session, socket_t sock) {
  18832. if (!session || sock == INVALID_SOCKET) { return true; }
  18833. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18834. // Check if there's already decrypted data available
  18835. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18836. // Set socket to non-blocking to avoid blocking on read
  18837. detail::set_nonblocking(sock, true);
  18838. auto cleanup =
  18839. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18840. // Peek 1 byte to check connection status without consuming data
  18841. unsigned char buf;
  18842. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18843. // If we got data or WANT_READ (would block), connection is alive
  18844. if (ret > 0) { return false; }
  18845. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18846. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18847. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18848. ret == 0;
  18849. }
  18850. inline cert_t get_peer_cert(const_session_t session) {
  18851. if (!session) { return nullptr; }
  18852. auto wsession =
  18853. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18854. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18855. return static_cast<cert_t>(cert);
  18856. }
  18857. inline size_t get_peer_certs(const_session_t session,
  18858. std::vector<cert_t> &certs) {
  18859. certs.clear();
  18860. if (!session) { return 0; }
  18861. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  18862. #ifdef SESSION_CERTS
  18863. auto wsession =
  18864. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18865. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  18866. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  18867. for (int i = 0; i < count; i++) {
  18868. auto x509 = wolfSSL_get_chain_X509(chain, i);
  18869. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18870. }
  18871. #endif
  18872. return certs.size();
  18873. }
  18874. inline void free_cert(cert_t cert) {
  18875. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18876. }
  18877. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18878. if (!cert || !hostname) { return false; }
  18879. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18880. std::string host_str(hostname);
  18881. // Check if hostname is an IP address (IPv4 or IPv6)
  18882. unsigned char ip_bytes[16];
  18883. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18884. auto is_ip = ip_len > 0;
  18885. // Check Subject Alternative Names
  18886. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18887. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18888. if (san_names) {
  18889. int san_count = wolfSSL_sk_num(san_names);
  18890. for (int i = 0; i < san_count; i++) {
  18891. auto *names =
  18892. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18893. if (!names) continue;
  18894. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18895. // DNS name
  18896. unsigned char *dns_name = nullptr;
  18897. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18898. if (dns_name && dns_len > 0) {
  18899. std::string san_name(reinterpret_cast<char *>(dns_name),
  18900. static_cast<size_t>(dns_len));
  18901. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18902. if (detail::match_hostname(san_name, host_str)) {
  18903. wolfSSL_sk_free(san_names);
  18904. return true;
  18905. }
  18906. }
  18907. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18908. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18909. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18910. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18911. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18912. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18913. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18914. wolfSSL_sk_free(san_names);
  18915. return true;
  18916. }
  18917. }
  18918. }
  18919. wolfSSL_sk_free(san_names);
  18920. }
  18921. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18922. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18923. // the OpenSSL backend's X509_check_ip behaves the same way).
  18924. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18925. if (subject) {
  18926. char cn[256] = {};
  18927. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18928. sizeof(cn));
  18929. if (cn_len > 0) {
  18930. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18931. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18932. }
  18933. }
  18934. return false;
  18935. }
  18936. inline uint64_t hostname_mismatch_code() {
  18937. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18938. }
  18939. inline long get_verify_result(const_session_t session) {
  18940. if (!session) { return -1; }
  18941. auto wsession =
  18942. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18943. long result = wolfSSL_get_verify_result(wsession->ssl);
  18944. return result;
  18945. }
  18946. inline std::string get_cert_subject_cn(cert_t cert) {
  18947. if (!cert) return "";
  18948. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18949. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18950. if (!subject) return "";
  18951. char cn[256] = {};
  18952. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18953. sizeof(cn));
  18954. if (cn_len <= 0) return "";
  18955. return std::string(cn, static_cast<size_t>(cn_len));
  18956. }
  18957. inline std::string get_cert_issuer_name(cert_t cert) {
  18958. if (!cert) return "";
  18959. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18960. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18961. if (!issuer) return "";
  18962. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18963. if (!name_str) return "";
  18964. std::string result(name_str);
  18965. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18966. return result;
  18967. }
  18968. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18969. sans.clear();
  18970. if (!cert) return false;
  18971. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18972. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18973. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18974. if (!san_names) return true; // No SANs is not an error
  18975. int count = wolfSSL_sk_num(san_names);
  18976. for (int i = 0; i < count; i++) {
  18977. auto *name =
  18978. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18979. if (!name) continue;
  18980. SanEntry entry;
  18981. switch (name->type) {
  18982. case WOLFSSL_GEN_DNS: {
  18983. entry.type = SanType::DNS;
  18984. unsigned char *dns_name = nullptr;
  18985. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18986. if (dns_name && dns_len > 0) {
  18987. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18988. static_cast<size_t>(dns_len));
  18989. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18990. }
  18991. break;
  18992. }
  18993. case WOLFSSL_GEN_IPADD: {
  18994. entry.type = SanType::IP;
  18995. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18996. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18997. if (ip_data && ip_len == 4) {
  18998. char buf[16];
  18999. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19000. ip_data[2], ip_data[3]);
  19001. entry.value = buf;
  19002. } else if (ip_data && ip_len == 16) {
  19003. char buf[64];
  19004. snprintf(buf, sizeof(buf),
  19005. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19006. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19007. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19008. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19009. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19010. ip_data[14], ip_data[15]);
  19011. entry.value = buf;
  19012. }
  19013. break;
  19014. }
  19015. case WOLFSSL_GEN_EMAIL:
  19016. entry.type = SanType::EMAIL;
  19017. {
  19018. unsigned char *email = nullptr;
  19019. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19020. if (email && email_len > 0) {
  19021. entry.value = std::string(reinterpret_cast<char *>(email),
  19022. static_cast<size_t>(email_len));
  19023. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19024. }
  19025. }
  19026. break;
  19027. case WOLFSSL_GEN_URI:
  19028. entry.type = SanType::URI;
  19029. {
  19030. unsigned char *uri = nullptr;
  19031. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19032. &uri, name->d.uniformResourceIdentifier);
  19033. if (uri && uri_len > 0) {
  19034. entry.value = std::string(reinterpret_cast<char *>(uri),
  19035. static_cast<size_t>(uri_len));
  19036. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19037. }
  19038. }
  19039. break;
  19040. default: entry.type = SanType::OTHER; break;
  19041. }
  19042. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19043. }
  19044. wolfSSL_sk_free(san_names);
  19045. return true;
  19046. }
  19047. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19048. time_t &not_after) {
  19049. if (!cert) return false;
  19050. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19051. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19052. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19053. if (!nb || !na) return false;
  19054. // wolfSSL_ASN1_TIME_to_tm is available
  19055. struct tm tm_nb = {}, tm_na = {};
  19056. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19057. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19058. #ifdef _WIN32
  19059. not_before = _mkgmtime(&tm_nb);
  19060. not_after = _mkgmtime(&tm_na);
  19061. #else
  19062. not_before = timegm(&tm_nb);
  19063. not_after = timegm(&tm_na);
  19064. #endif
  19065. return true;
  19066. }
  19067. inline std::string get_cert_serial(cert_t cert) {
  19068. if (!cert) return "";
  19069. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19070. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19071. if (!serial_asn1) return "";
  19072. // Get the serial number data
  19073. int len = serial_asn1->length;
  19074. unsigned char *data = serial_asn1->data;
  19075. if (!data || len <= 0) return "";
  19076. std::string result;
  19077. result.reserve(static_cast<size_t>(len) * 2);
  19078. for (int i = 0; i < len; i++) {
  19079. char hex[3];
  19080. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19081. result += hex;
  19082. }
  19083. return result;
  19084. }
  19085. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19086. if (!cert) return false;
  19087. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19088. int der_len = 0;
  19089. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19090. if (!der_data || der_len <= 0) return false;
  19091. der.assign(der_data, der_data + der_len);
  19092. return true;
  19093. }
  19094. inline const char *get_sni(const_session_t session) {
  19095. if (!session) return nullptr;
  19096. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19097. // For server: return SNI received from client during handshake
  19098. if (!wsession->sni_hostname.empty()) {
  19099. return wsession->sni_hostname.c_str();
  19100. }
  19101. // For client: return the hostname set via set_sni
  19102. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19103. return nullptr;
  19104. }
  19105. inline uint64_t peek_error() {
  19106. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19107. }
  19108. inline uint64_t get_error() {
  19109. uint64_t err = impl::wolfssl_last_error();
  19110. impl::wolfssl_last_error() = 0;
  19111. return err;
  19112. }
  19113. inline std::string error_string(uint64_t code) {
  19114. char buf[256];
  19115. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19116. return std::string(buf);
  19117. }
  19118. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19119. if (!pem || len == 0) { return nullptr; }
  19120. // Validate by attempting to load into a temporary ctx
  19121. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19122. if (!tmp_ctx) { return nullptr; }
  19123. int ret = wolfSSL_CTX_load_verify_buffer(
  19124. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19125. static_cast<long>(len), SSL_FILETYPE_PEM);
  19126. wolfSSL_CTX_free(tmp_ctx);
  19127. if (ret != SSL_SUCCESS) { return nullptr; }
  19128. return static_cast<ca_store_t>(
  19129. new impl::WolfSSLCAStore{std::string(pem, len)});
  19130. }
  19131. inline void free_ca_store(ca_store_t store) {
  19132. delete static_cast<impl::WolfSSLCAStore *>(store);
  19133. }
  19134. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19135. if (!ctx || !store) { return false; }
  19136. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19137. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19138. int ret = wolfSSL_CTX_load_verify_buffer(
  19139. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19140. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19141. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19142. // This function takes ownership of the store; the PEM data was copied into
  19143. // the context, so release the source
  19144. free_ca_store(store);
  19145. return ret == SSL_SUCCESS;
  19146. }
  19147. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19148. certs.clear();
  19149. if (!ctx) { return 0; }
  19150. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19151. if (wctx->ca_pem_data_.empty()) { return 0; }
  19152. const std::string &pem = wctx->ca_pem_data_;
  19153. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19154. const std::string end_marker = "-----END CERTIFICATE-----";
  19155. size_t pos = 0;
  19156. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19157. size_t end_pos = pem.find(end_marker, pos);
  19158. if (end_pos == std::string::npos) { break; }
  19159. end_pos += end_marker.size();
  19160. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19161. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19162. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19163. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19164. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19165. pos = end_pos;
  19166. }
  19167. return certs.size();
  19168. }
  19169. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19170. std::vector<std::string> names;
  19171. if (!ctx) { return names; }
  19172. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19173. if (wctx->ca_pem_data_.empty()) { return names; }
  19174. const std::string &pem = wctx->ca_pem_data_;
  19175. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19176. const std::string end_marker = "-----END CERTIFICATE-----";
  19177. size_t pos = 0;
  19178. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19179. size_t end_pos = pem.find(end_marker, pos);
  19180. if (end_pos == std::string::npos) { break; }
  19181. end_pos += end_marker.size();
  19182. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19183. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19184. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19185. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19186. if (x509) {
  19187. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19188. if (subject) {
  19189. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19190. if (name_str) {
  19191. names.push_back(name_str);
  19192. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19193. }
  19194. }
  19195. wolfSSL_X509_free(x509);
  19196. }
  19197. pos = end_pos;
  19198. }
  19199. return names;
  19200. }
  19201. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19202. const char *key_pem, const char *password) {
  19203. if (!ctx || !cert_pem || !key_pem) { return false; }
  19204. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19205. // Load new certificate
  19206. int ret = wolfSSL_CTX_use_certificate_buffer(
  19207. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19208. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19209. if (ret != SSL_SUCCESS) {
  19210. impl::wolfssl_last_error() =
  19211. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19212. return false;
  19213. }
  19214. // Set password if provided
  19215. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19216. // Load new private key
  19217. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19218. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19219. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19220. if (ret != SSL_SUCCESS) {
  19221. impl::wolfssl_last_error() =
  19222. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19223. return false;
  19224. }
  19225. return true;
  19226. }
  19227. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19228. if (!ctx || !ca_pem) { return false; }
  19229. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19230. int ret = wolfSSL_CTX_load_verify_buffer(
  19231. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19232. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19233. if (ret != SSL_SUCCESS) {
  19234. impl::wolfssl_last_error() =
  19235. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19236. return false;
  19237. }
  19238. return true;
  19239. }
  19240. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19241. if (!ctx) { return false; }
  19242. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19243. impl::get_verify_callback() = std::move(callback);
  19244. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  19245. if (wctx->has_verify_callback) {
  19246. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19247. impl::wolfssl_verify_callback);
  19248. } else {
  19249. wolfSSL_CTX_set_verify(
  19250. wctx->ctx,
  19251. wctx->verify_client
  19252. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19253. : SSL_VERIFY_NONE,
  19254. nullptr);
  19255. }
  19256. return true;
  19257. }
  19258. inline long get_verify_error(const_session_t session) {
  19259. if (!session) { return -1; }
  19260. auto *wsession =
  19261. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19262. return wolfSSL_get_verify_result(wsession->ssl);
  19263. }
  19264. inline std::string verify_error_string(long error_code) {
  19265. if (error_code == 0) { return ""; }
  19266. const char *str =
  19267. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19268. return str ? std::string(str) : std::string();
  19269. }
  19270. } // namespace tls
  19271. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19272. // WebSocket implementation
  19273. namespace ws {
  19274. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19275. bool fin) {
  19276. std::lock_guard<std::mutex> lock(write_mutex_);
  19277. if (closed_) { return false; }
  19278. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19279. }
  19280. inline ReadResult WebSocket::read(std::string &msg) {
  19281. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19282. while (!closed_) {
  19283. Opcode opcode;
  19284. std::string payload;
  19285. bool fin;
  19286. impl::FrameRead r =
  19287. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19288. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19289. // A timeout landed on a frame boundary: the connection is untouched and
  19290. // still usable, so hand control back without closing it. That is only
  19291. // useful to a caller who asked for the timeout; the compile-time default
  19292. // is a backstop against a peer gone quiet, and elapsing it closes the
  19293. // connection so a plain `while (ws.read(msg))` loop ends.
  19294. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19295. if (r != impl::FrameRead::Ok) {
  19296. closed_ = true;
  19297. return Fail;
  19298. }
  19299. switch (opcode) {
  19300. case Opcode::Ping: {
  19301. std::lock_guard<std::mutex> lock(write_mutex_);
  19302. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19303. payload.size(), true, !is_server_);
  19304. continue;
  19305. }
  19306. case Opcode::Pong: {
  19307. std::lock_guard<std::mutex> lock(ping_mutex_);
  19308. unacked_pings_ = 0;
  19309. continue;
  19310. }
  19311. case Opcode::Close: {
  19312. if (!closed_.exchange(true)) {
  19313. // Echo close frame back
  19314. std::lock_guard<std::mutex> lock(write_mutex_);
  19315. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19316. payload.size(), true, !is_server_);
  19317. }
  19318. return Fail;
  19319. }
  19320. case Opcode::Text:
  19321. case Opcode::Binary: {
  19322. auto result = opcode == Opcode::Text ? Text : Binary;
  19323. msg = std::move(payload);
  19324. // Handle fragmentation
  19325. if (!fin) {
  19326. while (true) {
  19327. Opcode cont_opcode;
  19328. std::string cont_payload;
  19329. bool cont_fin;
  19330. // A timeout is not reportable here: half of a fragmented message is
  19331. // already in `msg` and read() has no way to resume it, so it is a
  19332. // failure like any other. Timeouts are only ever seen on a message
  19333. // boundary.
  19334. if (impl::read_websocket_frame(
  19335. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19336. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19337. impl::FrameRead::Ok) {
  19338. closed_ = true;
  19339. return Fail;
  19340. }
  19341. if (cont_opcode == Opcode::Ping) {
  19342. std::lock_guard<std::mutex> lock(write_mutex_);
  19343. detail::write_websocket_frame(
  19344. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19345. true, !is_server_);
  19346. continue;
  19347. }
  19348. if (cont_opcode == Opcode::Pong) {
  19349. std::lock_guard<std::mutex> lock(ping_mutex_);
  19350. unacked_pings_ = 0;
  19351. continue;
  19352. }
  19353. if (cont_opcode == Opcode::Close) {
  19354. if (!closed_.exchange(true)) {
  19355. std::lock_guard<std::mutex> lock(write_mutex_);
  19356. detail::write_websocket_frame(
  19357. strm_, Opcode::Close, cont_payload.data(),
  19358. cont_payload.size(), true, !is_server_);
  19359. }
  19360. return Fail;
  19361. }
  19362. // RFC 6455: continuation frames must use opcode 0x0
  19363. if (cont_opcode != Opcode::Continuation) {
  19364. closed_ = true;
  19365. return Fail;
  19366. }
  19367. msg += cont_payload;
  19368. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19369. closed_ = true;
  19370. return Fail;
  19371. }
  19372. if (cont_fin) { break; }
  19373. }
  19374. }
  19375. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19376. if (result == Text && !impl::is_valid_utf8(msg)) {
  19377. // close() takes the read lock to wait for the peer's Close reply, so
  19378. // it must not run while this thread still holds it.
  19379. read_lock.unlock();
  19380. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19381. return Fail;
  19382. }
  19383. return result;
  19384. }
  19385. default: closed_ = true; return Fail;
  19386. }
  19387. }
  19388. return Fail;
  19389. }
  19390. inline bool WebSocket::send(const std::string &data) {
  19391. return send_frame(Opcode::Text, data.data(), data.size());
  19392. }
  19393. inline bool WebSocket::send(const char *data, size_t len) {
  19394. return send_frame(Opcode::Binary, data, len);
  19395. }
  19396. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19397. if (closed_.exchange(true)) { return; }
  19398. ping_cv_.notify_all();
  19399. std::string payload;
  19400. auto code = static_cast<uint16_t>(status);
  19401. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19402. payload.push_back(static_cast<char>(code & 0xFF));
  19403. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19404. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19405. payload += reason.substr(0, 123);
  19406. {
  19407. std::lock_guard<std::mutex> lock(write_mutex_);
  19408. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19409. payload.size(), true, !is_server_);
  19410. }
  19411. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19412. // Close response before closing the TCP connection.
  19413. //
  19414. // Wait only when no other thread is parsing frames. When one is, it is the
  19415. // thread positioned to see the peer's reply, and reading here would take
  19416. // bytes out of the message it is assembling. Bailing out also leaves the
  19417. // stream, including its read timeout, entirely to that thread.
  19418. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19419. if (!read_lock.owns_lock()) { return; }
  19420. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19421. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19422. Opcode op;
  19423. std::string resp;
  19424. bool fin;
  19425. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19426. impl::FrameRead::Ok) {
  19427. if (op == Opcode::Close) { break; }
  19428. }
  19429. }
  19430. inline WebSocket::~WebSocket() {
  19431. {
  19432. std::lock_guard<std::mutex> lock(ping_mutex_);
  19433. closed_ = true;
  19434. }
  19435. ping_cv_.notify_all();
  19436. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19437. }
  19438. inline void WebSocket::start_heartbeat() {
  19439. if (ping_interval_sec_ == 0) { return; }
  19440. ping_thread_ = std::thread([this]() {
  19441. std::unique_lock<std::mutex> lock(ping_mutex_);
  19442. while (!closed_) {
  19443. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19444. if (closed_) { break; }
  19445. // If the peer has failed to respond to the previous pings, give up.
  19446. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19447. // opt-in liveness check controlled by max_missed_pongs_.
  19448. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19449. lock.unlock();
  19450. close(CloseStatus::GoingAway, "pong timeout");
  19451. return;
  19452. }
  19453. lock.unlock();
  19454. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19455. lock.lock();
  19456. closed_ = true;
  19457. break;
  19458. }
  19459. lock.lock();
  19460. unacked_pings_++;
  19461. }
  19462. });
  19463. }
  19464. inline const Request &WebSocket::request() const { return req_; }
  19465. inline bool WebSocket::is_open() const { return !closed_; }
  19466. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19467. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19468. // poll(), where 0 would instead mean "return immediately", so hand it the
  19469. // negative poll uses for an unbounded wait.
  19470. if (sec == 0 && usec == 0) { sec = -1; }
  19471. strm_.set_read_timeout(sec, usec);
  19472. read_timeout_set_ = true;
  19473. }
  19474. // WebSocketClient implementation
  19475. inline WebSocketClient::WebSocketClient(
  19476. const std::string &scheme_host_port_path, const Headers &headers)
  19477. : headers_(headers) {
  19478. detail::UrlComponents uc;
  19479. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19480. !uc.host.empty() && !uc.path.empty()) {
  19481. auto &scheme = uc.scheme;
  19482. #ifdef CPPHTTPLIB_SSL_ENABLED
  19483. if (scheme != "ws" && scheme != "wss") {
  19484. #else
  19485. if (scheme != "ws") {
  19486. #endif
  19487. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19488. std::string msg = "'" + scheme + "' scheme is not supported.";
  19489. throw std::invalid_argument(msg);
  19490. #endif
  19491. return;
  19492. }
  19493. auto is_ssl = scheme == "wss";
  19494. host_ = std::move(uc.host);
  19495. port_ = is_ssl ? 443 : 80;
  19496. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19497. path_ = std::move(uc.path);
  19498. if (!uc.query.empty()) { path_ += uc.query; }
  19499. #ifdef CPPHTTPLIB_SSL_ENABLED
  19500. is_ssl_ = is_ssl;
  19501. if (is_ssl_) {
  19502. // The context lives as long as the client so that CA configuration
  19503. // survives reconnects; sessions are created per connection.
  19504. tls_ctx_ = tls::create_client_context();
  19505. if (!tls_ctx_) { return; }
  19506. }
  19507. #else
  19508. if (is_ssl) { return; }
  19509. #endif
  19510. is_valid_ = true;
  19511. }
  19512. }
  19513. #ifdef CPPHTTPLIB_SSL_ENABLED
  19514. inline WebSocketClient::WebSocketClient(
  19515. const std::string &scheme_host_port_path, const PemMemory &pem,
  19516. const Headers &headers)
  19517. : WebSocketClient(scheme_host_port_path, headers) {
  19518. // For ws:// URLs the client certificate is silently ignored, consistent
  19519. // with the TLS-only setters such as set_ca_cert_path().
  19520. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19521. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19522. pem.private_key_password)) {
  19523. tls::free_context(tls_ctx_);
  19524. tls_ctx_ = nullptr;
  19525. is_valid_ = false;
  19526. }
  19527. }
  19528. }
  19529. #endif
  19530. inline WebSocketClient::~WebSocketClient() {
  19531. shutdown_and_close();
  19532. #ifdef CPPHTTPLIB_SSL_ENABLED
  19533. if (tls_ctx_) {
  19534. tls::free_context(tls_ctx_);
  19535. tls_ctx_ = nullptr;
  19536. }
  19537. #endif
  19538. }
  19539. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19540. inline void WebSocketClient::shutdown_and_close() {
  19541. // Send the close frame while the TLS session is still alive: ws_ holds an
  19542. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19543. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19544. if (ws_ && ws_->is_open()) { ws_->close(); }
  19545. ws_.reset();
  19546. #ifdef CPPHTTPLIB_SSL_ENABLED
  19547. if (is_ssl_) {
  19548. if (tls_session_) {
  19549. tls::shutdown(tls_session_, true);
  19550. tls::free_session(tls_session_);
  19551. tls_session_ = nullptr;
  19552. }
  19553. }
  19554. #endif
  19555. if (sock_ != INVALID_SOCKET) {
  19556. detail::shutdown_socket(sock_);
  19557. detail::close_socket(sock_);
  19558. sock_ = INVALID_SOCKET;
  19559. }
  19560. }
  19561. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19562. Error &error, int &ssl_error,
  19563. uint64_t &ssl_backend_error) {
  19564. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19565. // The streams wait with poll(), where 0 instead means "return immediately",
  19566. // so they are given the negative poll uses for an unbounded wait.
  19567. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19568. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19569. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19570. // The handshake belongs to establishing the connection, so an unset read
  19571. // timeout leaves it bounded by the connection timeout instead of forever.
  19572. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19573. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19574. #ifdef CPPHTTPLIB_SSL_ENABLED
  19575. if (is_ssl_) {
  19576. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19577. // is not safe to call concurrently on one client to begin with, since
  19578. // nothing else here is guarded either.
  19579. if (server_certificate_verification_ && !certs_loaded_) {
  19580. uint64_t backend_error = 0;
  19581. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19582. ca_cert_dir_path_, custom_ca_loaded_,
  19583. system_ca_mode_, backend_error);
  19584. certs_loaded_ = true;
  19585. }
  19586. detail::ClientTlsSessionOptions options;
  19587. options.server_hostname_verification = server_hostname_verification_;
  19588. detail::ClientTlsSessionError tls_error;
  19589. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19590. server_certificate_verification_,
  19591. hs_sec, hs_usec, &tls_error,
  19592. options)) {
  19593. error = tls_error.error;
  19594. ssl_error = tls_error.ssl_error;
  19595. ssl_backend_error = tls_error.backend_error;
  19596. return false;
  19597. }
  19598. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19599. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19600. write_timeout_usec_));
  19601. return true;
  19602. }
  19603. #else
  19604. (void)error;
  19605. (void)ssl_error;
  19606. (void)ssl_backend_error;
  19607. (void)hs_sec;
  19608. (void)hs_usec;
  19609. #endif
  19610. strm = std::unique_ptr<Stream>(
  19611. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19612. write_timeout_sec_, write_timeout_usec_));
  19613. return true;
  19614. }
  19615. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19616. #ifdef CPPHTTPLIB_SSL_ENABLED
  19617. auto is_ssl = is_ssl_;
  19618. #else
  19619. auto is_ssl = false;
  19620. #endif
  19621. if (!req.has_header("Host")) {
  19622. req.headers.emplace("Host", detail::make_default_host_header_value(
  19623. host_, port_, is_ssl, address_family_));
  19624. }
  19625. detail::add_default_user_agent_header(req);
  19626. }
  19627. inline Result WebSocketClient::connect() {
  19628. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19629. shutdown_and_close();
  19630. // Check is custom IP or hostname specified for host_
  19631. std::string connect_host;
  19632. std::string ip;
  19633. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19634. auto error = Error::Success;
  19635. sock_ = detail::create_client_socket(
  19636. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19637. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19638. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19639. write_timeout_usec_, interface_, error);
  19640. if (sock_ == INVALID_SOCKET) {
  19641. if (error == Error::Success) { error = Error::Connection; }
  19642. return Result{error, -1, Headers{}};
  19643. }
  19644. std::unique_ptr<Stream> strm;
  19645. auto stream_error = Error::SSLConnection;
  19646. int ssl_error = 0;
  19647. uint64_t ssl_backend_error = 0;
  19648. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19649. shutdown_and_close();
  19650. #ifdef CPPHTTPLIB_SSL_ENABLED
  19651. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19652. #else
  19653. return Result{stream_error, -1, Headers{}};
  19654. #endif
  19655. }
  19656. Request req;
  19657. req.method = "GET";
  19658. req.path = path_;
  19659. req.headers = headers_;
  19660. prepare_default_headers(req);
  19661. detail::WebSocketUpgradeResponse upgrade;
  19662. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19663. shutdown_and_close();
  19664. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19665. }
  19666. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19667. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19668. websocket_ping_interval_sec_,
  19669. websocket_max_missed_pongs_));
  19670. // The stream was created with the timeout already; tell the WebSocket
  19671. // whether it came from the caller, so read() knows to report it as Timeout.
  19672. ws_->read_timeout_set_ = read_timeout_set_;
  19673. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19674. }
  19675. inline ReadResult WebSocketClient::read(std::string &msg) {
  19676. if (!ws_) { return Fail; }
  19677. return ws_->read(msg);
  19678. }
  19679. inline bool WebSocketClient::send(const std::string &data) {
  19680. if (!ws_) { return false; }
  19681. return ws_->send(data);
  19682. }
  19683. inline bool WebSocketClient::send(const char *data, size_t len) {
  19684. if (!ws_) { return false; }
  19685. return ws_->send(data, len);
  19686. }
  19687. inline void WebSocketClient::close(CloseStatus status,
  19688. const std::string &reason) {
  19689. if (ws_) { ws_->close(status, reason); }
  19690. }
  19691. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19692. inline const std::string &WebSocketClient::subprotocol() const {
  19693. return subprotocol_;
  19694. }
  19695. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19696. read_timeout_sec_ = sec;
  19697. read_timeout_usec_ = usec;
  19698. read_timeout_set_ = true;
  19699. // The members above only seed the next connect(); read() consults the
  19700. // stream, so an already-open connection has to be told directly.
  19701. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19702. }
  19703. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19704. write_timeout_sec_ = sec;
  19705. write_timeout_usec_ = usec;
  19706. }
  19707. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19708. websocket_ping_interval_sec_ = sec;
  19709. }
  19710. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19711. websocket_max_missed_pongs_ = count;
  19712. }
  19713. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19714. inline void WebSocketClient::set_address_family(int family) {
  19715. address_family_ = family;
  19716. }
  19717. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19718. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19719. socket_options_ = std::move(socket_options);
  19720. }
  19721. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19722. connection_timeout_sec_ = sec;
  19723. connection_timeout_usec_ = usec;
  19724. }
  19725. inline void WebSocketClient::set_interface(const std::string &intf) {
  19726. interface_ = intf;
  19727. }
  19728. inline void WebSocketClient::set_hostname_addr_map(
  19729. std::map<std::string, std::string> addr_map) {
  19730. addr_map_ = std::move(addr_map);
  19731. }
  19732. #ifdef CPPHTTPLIB_SSL_ENABLED
  19733. inline void
  19734. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19735. const std::string &ca_cert_dir_path) {
  19736. ca_cert_file_path_ = ca_cert_file_path;
  19737. ca_cert_dir_path_ = ca_cert_dir_path;
  19738. }
  19739. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19740. if (store && tls_ctx_) {
  19741. // set_ca_store takes ownership of store
  19742. tls::set_ca_store(tls_ctx_, store);
  19743. custom_ca_loaded_ = true;
  19744. } else if (store) {
  19745. tls::free_ca_store(store);
  19746. }
  19747. }
  19748. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19749. std::size_t size) {
  19750. if (tls_ctx_ && ca_cert && size > 0) {
  19751. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19752. custom_ca_loaded_ = true;
  19753. }
  19754. }
  19755. inline void
  19756. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19757. server_certificate_verification_ = enabled;
  19758. }
  19759. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19760. server_hostname_verification_ = enabled;
  19761. }
  19762. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19763. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19764. }
  19765. #endif // CPPHTTPLIB_SSL_ENABLED
  19766. } // namespace ws
  19767. // ----------------------------------------------------------------------------
  19768. } // namespace httplib
  19769. #endif // CPPHTTPLIB_HTTPLIB_H