1
0

httplib.h 826 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.61.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003d00"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT
  104. #define CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT 100
  105. #endif
  106. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  107. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  108. #endif
  109. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  111. #endif
  112. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  113. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  114. #endif
  115. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  116. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  117. #endif
  118. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  119. // 1400 rather than a round number: a body that already fits in one 1500-byte
  120. // MTU gains nothing from being made smaller.
  121. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  122. #endif
  123. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  124. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  125. #endif
  126. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  127. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  128. #endif
  129. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  130. // recurses roughly once per matched character for quantified patterns such
  131. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  132. // a default ~8MB thread stack that has been observed to take on the order of
  133. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  134. // margin below that (well under the 8192-byte request URI limit) while still
  135. // fitting any realistic route segment; raise it if a route legitimately needs
  136. // longer paths. Regex routes are never applied to paths longer than this.
  137. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  138. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  139. #endif
  140. #ifndef CPPHTTPLIB_TCP_NODELAY
  141. #define CPPHTTPLIB_TCP_NODELAY false
  142. #endif
  143. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  144. #define CPPHTTPLIB_IPV6_V6ONLY false
  145. #endif
  146. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  147. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  150. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  151. #endif
  152. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  153. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  154. #endif
  155. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  156. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  157. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  158. ? std::thread::hardware_concurrency() - 1 \
  159. : 0))
  160. #endif
  161. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  162. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  163. #endif
  164. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  165. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  166. #endif
  167. #ifndef CPPHTTPLIB_RECV_FLAGS
  168. #define CPPHTTPLIB_RECV_FLAGS 0
  169. #endif
  170. #ifndef CPPHTTPLIB_SEND_FLAGS
  171. #define CPPHTTPLIB_SEND_FLAGS 0
  172. #endif
  173. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  174. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  175. #endif
  176. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  177. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  178. #endif
  179. // These bound the parsing of every request, so 0 cannot lift them.
  180. static_assert(CPPHTTPLIB_REQUEST_URI_MAX_LENGTH > 0,
  181. "CPPHTTPLIB_REQUEST_URI_MAX_LENGTH must be positive");
  182. static_assert(CPPHTTPLIB_HEADER_MAX_LENGTH > 0,
  183. "CPPHTTPLIB_HEADER_MAX_LENGTH must be positive");
  184. static_assert(CPPHTTPLIB_HEADER_MAX_COUNT > 0,
  185. "CPPHTTPLIB_HEADER_MAX_COUNT must be positive");
  186. static_assert(CPPHTTPLIB_MAX_LINE_LENGTH > 0,
  187. "CPPHTTPLIB_MAX_LINE_LENGTH must be positive");
  188. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  189. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  190. #endif
  191. // One macro used to set the read timeout for both sides. They want different
  192. // defaults: a client's read timeout is the caller's own tool (it waits forever
  193. // until asked not to), while a server keeps a ceiling that reclaims a worker
  194. // from a peer that has gone quiet. The old name still works and sets both.
  195. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  196. #pragma message( \
  197. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  198. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  199. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  200. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  201. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  202. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  203. #endif
  204. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  205. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  206. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  207. #endif
  208. #endif
  209. // 0 waits forever. A read timeout is how a caller gets control back to send on
  210. // the same connection; it is not a liveness check (that is ping/pong). Only a
  211. // timeout set at runtime through set_read_timeout() is reported as
  212. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  213. // ws::Fail and closes the connection.
  214. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  215. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  216. #endif
  217. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  218. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  219. #endif
  220. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  221. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  222. #endif
  223. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  224. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  225. #endif
  226. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  227. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  228. #endif
  229. /*
  230. * Headers
  231. */
  232. #ifdef _WIN32
  233. #ifndef _CRT_SECURE_NO_WARNINGS
  234. #define _CRT_SECURE_NO_WARNINGS
  235. #endif //_CRT_SECURE_NO_WARNINGS
  236. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  237. #define _CRT_NONSTDC_NO_DEPRECATE
  238. #endif //_CRT_NONSTDC_NO_DEPRECATE
  239. #if defined(_MSC_VER)
  240. #if _MSC_VER < 1900
  241. #error Sorry, Visual Studio versions prior to 2015 are not supported
  242. #endif
  243. #pragma comment(lib, "ws2_32.lib")
  244. #ifndef _SSIZE_T_DEFINED
  245. using ssize_t = __int64;
  246. #define _SSIZE_T_DEFINED
  247. #endif
  248. #endif // _MSC_VER
  249. #ifndef S_ISREG
  250. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  251. #endif // S_ISREG
  252. #ifndef S_ISDIR
  253. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  254. #endif // S_ISDIR
  255. #ifndef NOMINMAX
  256. #define NOMINMAX
  257. #endif // NOMINMAX
  258. #include <io.h>
  259. #include <winsock2.h>
  260. #include <ws2tcpip.h>
  261. #if defined(__has_include)
  262. #if __has_include(<afunix.h>)
  263. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  264. #include <afunix.h>
  265. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  266. #endif
  267. #endif
  268. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  269. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  270. #endif
  271. using nfds_t = unsigned long;
  272. using socket_t = SOCKET;
  273. using socklen_t = int;
  274. #else // not _WIN32
  275. #include <arpa/inet.h>
  276. #if !defined(_AIX) && !defined(__MVS__)
  277. #include <ifaddrs.h>
  278. #endif
  279. #ifdef __MVS__
  280. #include <strings.h>
  281. #ifndef NI_MAXHOST
  282. #define NI_MAXHOST 1025
  283. #endif
  284. #endif
  285. #include <net/if.h>
  286. #include <netdb.h>
  287. #include <netinet/in.h>
  288. #ifdef __linux__
  289. #include <resolv.h>
  290. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  291. #endif
  292. #include <csignal>
  293. #include <netinet/tcp.h>
  294. #include <poll.h>
  295. #include <pthread.h>
  296. #include <sys/socket.h>
  297. #include <sys/un.h>
  298. #include <unistd.h>
  299. using socket_t = int;
  300. #ifndef INVALID_SOCKET
  301. #define INVALID_SOCKET (-1)
  302. #endif
  303. #endif //_WIN32
  304. #if defined(__APPLE__)
  305. #include <TargetConditionals.h>
  306. #endif
  307. #include <algorithm>
  308. #include <array>
  309. #include <atomic>
  310. #include <cassert>
  311. #include <chrono>
  312. #include <climits>
  313. #include <condition_variable>
  314. #include <cstdlib>
  315. #include <cstring>
  316. #include <errno.h>
  317. #include <exception>
  318. #include <fcntl.h>
  319. #include <fstream>
  320. #include <functional>
  321. #include <iomanip>
  322. #include <iostream>
  323. #include <iterator>
  324. #include <list>
  325. #include <map>
  326. #include <memory>
  327. #include <mutex>
  328. #include <random>
  329. #include <regex>
  330. #include <set>
  331. #include <sstream>
  332. #include <string>
  333. #include <sys/stat.h>
  334. #include <system_error>
  335. #include <thread>
  336. #include <type_traits>
  337. #include <unordered_map>
  338. #include <unordered_set>
  339. #include <utility>
  340. #include <vector>
  341. // On macOS with a TLS backend, enable Keychain root certificates by default
  342. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  343. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  344. // only; on those platforms the user must provide a CA bundle explicitly.
  345. #if defined(__APPLE__) && defined(__clang__) && \
  346. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  347. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  348. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  349. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  350. #if TARGET_OS_OSX
  351. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  352. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  353. #endif
  354. #endif
  355. #endif
  356. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  357. defined(__APPLE__) && !TARGET_OS_OSX
  358. #error \
  359. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  360. #endif
  361. // On Windows, enable Schannel certificate verification by default
  362. // unless the user explicitly opts out.
  363. #if defined(_WIN32) && \
  364. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  365. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  366. #endif
  367. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  368. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  369. #if TARGET_OS_MAC && defined(__clang__)
  370. #include <CFNetwork/CFHost.h>
  371. #include <CoreFoundation/CoreFoundation.h>
  372. #endif
  373. #endif
  374. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  375. #ifdef _WIN32
  376. #include <wincrypt.h>
  377. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  378. // used
  379. #undef X509_NAME
  380. #undef X509_CERT_PAIR
  381. #undef X509_EXTENSIONS
  382. #undef PKCS7_SIGNER_INFO
  383. #ifdef _MSC_VER
  384. #pragma comment(lib, "crypt32.lib")
  385. #endif
  386. #endif // _WIN32
  387. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  388. #if TARGET_OS_OSX
  389. #include <Security/Security.h>
  390. #endif
  391. #endif
  392. #include <openssl/err.h>
  393. #include <openssl/evp.h>
  394. #include <openssl/rand.h>
  395. #include <openssl/ssl.h>
  396. #include <openssl/x509v3.h>
  397. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  398. #include <openssl/applink.c>
  399. #endif
  400. #include <iostream>
  401. #include <sstream>
  402. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  403. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  404. #error Please use OpenSSL or a current version of BoringSSL
  405. #endif
  406. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  407. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  408. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  409. #endif
  410. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  411. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  412. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  413. // in with this first include group so the version gating below can use it.
  414. #include <mbedtls/error.h>
  415. #include <mbedtls/net_sockets.h>
  416. #include <mbedtls/oid.h>
  417. #include <mbedtls/pk.h>
  418. #include <mbedtls/ssl.h>
  419. #include <mbedtls/version.h>
  420. #include <mbedtls/x509_crt.h>
  421. #if MBEDTLS_VERSION_MAJOR >= 4
  422. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  423. #include <psa/crypto.h>
  424. #else
  425. #include <mbedtls/ctr_drbg.h>
  426. #include <mbedtls/entropy.h>
  427. #include <mbedtls/md5.h>
  428. #include <mbedtls/sha1.h>
  429. #include <mbedtls/sha256.h>
  430. #include <mbedtls/sha512.h>
  431. #endif
  432. #ifdef _WIN32
  433. #include <wincrypt.h>
  434. #ifdef _MSC_VER
  435. #pragma comment(lib, "crypt32.lib")
  436. #endif
  437. #endif // _WIN32
  438. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  439. #if TARGET_OS_OSX
  440. #include <Security/Security.h>
  441. #endif
  442. #endif
  443. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  444. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  445. #if MBEDTLS_VERSION_MAJOR >= 4
  446. #define CPPHTTPLIB_MBEDTLS_V4
  447. #endif
  448. #if MBEDTLS_VERSION_MAJOR >= 3
  449. #define CPPHTTPLIB_MBEDTLS_V3
  450. #endif
  451. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  452. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  453. #include <wolfssl/options.h>
  454. #include <wolfssl/openssl/x509v3.h>
  455. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  456. #ifndef WOLFSSL_GEN_EMAIL
  457. #define WOLFSSL_GEN_EMAIL 1
  458. #endif
  459. #ifndef WOLFSSL_GEN_DNS
  460. #define WOLFSSL_GEN_DNS 2
  461. #endif
  462. #ifndef WOLFSSL_GEN_URI
  463. #define WOLFSSL_GEN_URI 6
  464. #endif
  465. #ifndef WOLFSSL_GEN_IPADD
  466. #define WOLFSSL_GEN_IPADD 7
  467. #endif
  468. #include <wolfssl/ssl.h>
  469. #include <wolfssl/wolfcrypt/hash.h>
  470. #include <wolfssl/wolfcrypt/md5.h>
  471. #include <wolfssl/wolfcrypt/sha256.h>
  472. #include <wolfssl/wolfcrypt/sha512.h>
  473. #ifdef _WIN32
  474. #include <wincrypt.h>
  475. #ifdef _MSC_VER
  476. #pragma comment(lib, "crypt32.lib")
  477. #endif
  478. #endif // _WIN32
  479. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  480. #if TARGET_OS_OSX
  481. #include <Security/Security.h>
  482. #endif
  483. #endif
  484. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  485. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  486. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  487. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  488. #define CPPHTTPLIB_SSL_ENABLED
  489. #endif
  490. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  491. #include <zlib.h>
  492. #endif
  493. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  494. #include <brotli/decode.h>
  495. #include <brotli/encode.h>
  496. #endif
  497. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  498. #include <zstd.h>
  499. #endif
  500. /*
  501. * Declaration
  502. */
  503. namespace httplib {
  504. namespace ws {
  505. class WebSocket;
  506. } // namespace ws
  507. namespace sse {
  508. class SSEClient;
  509. } // namespace sse
  510. namespace detail {
  511. /*
  512. * Backport std::make_unique from C++14.
  513. *
  514. * NOTE: This code came up with the following stackoverflow post:
  515. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  516. *
  517. */
  518. template <class T, class... Args>
  519. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  520. make_unique(Args &&...args) {
  521. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  522. }
  523. template <class T>
  524. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  525. make_unique(std::size_t n) {
  526. typedef typename std::remove_extent<T>::type RT;
  527. return std::unique_ptr<T>(new RT[n]);
  528. }
  529. // Locale-independent ASCII character classification. The <cctype>
  530. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  531. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  532. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  533. // classified without regard to the locale.
  534. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  535. inline bool is_ascii_alpha(char c) {
  536. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  537. }
  538. inline bool is_ascii_alnum(char c) {
  539. return is_ascii_digit(c) || is_ascii_alpha(c);
  540. }
  541. namespace case_ignore {
  542. inline unsigned char to_lower(int c) {
  543. const static unsigned char table[256] = {
  544. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  545. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  546. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  547. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  548. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  549. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  550. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  551. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  552. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  553. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  554. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  555. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  556. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  557. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  558. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  559. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  560. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  561. 255,
  562. };
  563. return table[(unsigned char)(char)c];
  564. }
  565. inline std::string to_lower(const std::string &s) {
  566. std::string result = s;
  567. std::transform(
  568. result.begin(), result.end(), result.begin(),
  569. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  570. return result;
  571. }
  572. inline bool equal(const std::string &a, const std::string &b) {
  573. return a.size() == b.size() &&
  574. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  575. return to_lower(ca) == to_lower(cb);
  576. });
  577. }
  578. // For a literal, without building a std::string from it.
  579. template <size_t N>
  580. inline bool equal(const std::string &a, const char (&b)[N]) {
  581. return a.size() == N - 1 &&
  582. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  583. return to_lower(ca) == to_lower(cb);
  584. });
  585. }
  586. struct equal_to {
  587. bool operator()(const std::string &a, const std::string &b) const {
  588. return equal(a, b);
  589. }
  590. };
  591. struct hash {
  592. size_t operator()(const std::string &key) const {
  593. size_t h = 0;
  594. for (auto c : key) {
  595. // Unsets the 6 high bits of h, therefore no overflow happens
  596. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  597. static_cast<unsigned char>(to_lower(c));
  598. }
  599. return h;
  600. }
  601. };
  602. template <typename T>
  603. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  604. detail::case_ignore::equal_to>;
  605. } // namespace case_ignore
  606. // This is based on
  607. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  608. struct scope_exit {
  609. explicit scope_exit(std::function<void(void)> &&f)
  610. : exit_function(std::move(f)), execute_on_destruction{true} {}
  611. scope_exit(scope_exit &&rhs) noexcept
  612. : exit_function(std::move(rhs.exit_function)),
  613. execute_on_destruction{rhs.execute_on_destruction} {
  614. rhs.release();
  615. }
  616. ~scope_exit() {
  617. if (execute_on_destruction) { this->exit_function(); }
  618. }
  619. void release() { this->execute_on_destruction = false; }
  620. private:
  621. scope_exit(const scope_exit &) = delete;
  622. void operator=(const scope_exit &) = delete;
  623. scope_exit &operator=(scope_exit &&) = delete;
  624. std::function<void(void)> exit_function;
  625. bool execute_on_destruction;
  626. };
  627. // Simple from_chars implementation for integer and double types (C++17
  628. // substitute)
  629. template <typename T> struct from_chars_result {
  630. const char *ptr;
  631. std::errc ec;
  632. };
  633. template <typename T>
  634. inline from_chars_result<T> from_chars(const char *first, const char *last,
  635. T &value, int base = 10) {
  636. value = 0;
  637. const char *p = first;
  638. bool negative = false;
  639. if (p != last && *p == '-') {
  640. negative = true;
  641. ++p;
  642. }
  643. if (p == last) { return {first, std::errc::invalid_argument}; }
  644. auto radix = static_cast<T>(base);
  645. T result = 0;
  646. for (; p != last; ++p) {
  647. char c = *p;
  648. int digit = -1;
  649. if (is_ascii_digit(c)) {
  650. digit = c - '0';
  651. } else if ('a' <= c && c <= 'z') {
  652. digit = c - 'a' + 10;
  653. } else if ('A' <= c && c <= 'Z') {
  654. digit = c - 'A' + 10;
  655. } else {
  656. break;
  657. }
  658. if (digit < 0 || digit >= base) { break; }
  659. auto d = static_cast<T>(digit);
  660. if (result > ((std::numeric_limits<T>::max)() - d) / radix) {
  661. return {p, std::errc::result_out_of_range};
  662. }
  663. result = result * radix + d;
  664. }
  665. if (p == first || (negative && p == first + 1)) {
  666. return {first, std::errc::invalid_argument};
  667. }
  668. value = negative ? T(0) - result : result;
  669. return {p, std::errc{}};
  670. }
  671. // from_chars for double (hand-written, locale-independent)
  672. //
  673. // The only double consumed by this library is the HTTP quality value, whose
  674. // grammar is (RFC 9110 12.4.2):
  675. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  676. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  677. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  678. // '.' always the decimal separator (std::strtod would instead read it from the
  679. // global C locale, mis-parsing q-values once an embedder calls
  680. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  681. // the result to [0, 1], so inputs outside that range need not be distinguished
  682. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  683. // cases that exponent and wide-range handling would introduce.
  684. inline from_chars_result<double> from_chars(const char *first, const char *last,
  685. double &value) {
  686. value = 0.0;
  687. const char *p = first;
  688. // Each 1eN is exactly representable, so a single final division by the
  689. // matching entry yields a correctly-rounded result.
  690. static const double powers_of_ten[] = {
  691. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  692. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  693. const int max_frac_digits =
  694. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  695. // Accumulate digits into a 64-bit integer and remember how many were
  696. // fractional. Two independent caps keep this bounded and safe:
  697. // * accumulation saturates before mantissa could overflow uint64_t, and
  698. // * frac_digits is capped at max_frac_digits so it is always a valid index
  699. // into powers_of_ten (without this an input like "0.000...0" would never
  700. // grow mantissa, so the saturation cap alone would not bound it).
  701. // Both caps only drop digits far beyond the precision a q-value needs; any
  702. // value they would change is well outside [0, 1] and rejected by the caller.
  703. uint64_t mantissa = 0;
  704. int frac_digits = 0;
  705. bool seen_digit = false;
  706. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  707. auto accumulate = [&](char c) {
  708. if (mantissa <= limit) {
  709. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  710. return true;
  711. }
  712. return false;
  713. };
  714. for (; p != last && is_ascii_digit(*p); ++p) {
  715. seen_digit = true;
  716. accumulate(*p);
  717. }
  718. if (p != last && *p == '.') {
  719. ++p;
  720. for (; p != last && is_ascii_digit(*p); ++p) {
  721. seen_digit = true;
  722. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  723. }
  724. }
  725. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  726. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  727. return {p, std::errc{}};
  728. }
  729. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  730. int &out) {
  731. int val = 0;
  732. auto r = from_chars(s, s + len, val);
  733. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  734. return false;
  735. }
  736. out = val;
  737. return true;
  738. }
  739. inline bool parse_port(const char *s, size_t len, int &port) {
  740. return parse_int_in_range(s, len, 1, 65535, port);
  741. }
  742. inline bool parse_port(const std::string &s, int &port) {
  743. return parse_port(s.data(), s.size(), port);
  744. }
  745. struct UrlComponents {
  746. std::string scheme;
  747. std::string host;
  748. std::string port;
  749. std::string path;
  750. std::string query;
  751. };
  752. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  753. uc = {};
  754. size_t pos = 0;
  755. auto sep = url.find("://");
  756. if (sep != std::string::npos) {
  757. uc.scheme = url.substr(0, sep);
  758. // Scheme must be [a-z]+ only
  759. if (uc.scheme.empty()) { return false; }
  760. for (auto c : uc.scheme) {
  761. if (c < 'a' || c > 'z') { return false; }
  762. }
  763. pos = sep + 3;
  764. } else if (url.compare(0, 2, "//") == 0) {
  765. pos = 2;
  766. }
  767. auto has_authority_prefix = pos > 0;
  768. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  769. url[0] != '?' && url[0] != '#');
  770. if (has_authority) {
  771. // userinfo is not supported, and a backslash that some parsers take for
  772. // '/' would leave them seeing another host than this one.
  773. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  774. return false;
  775. }
  776. if (pos < url.size() && url[pos] == '[') {
  777. auto close = url.find(']', pos);
  778. if (close == std::string::npos) { return false; }
  779. uc.host = url.substr(pos + 1, close - pos - 1);
  780. // IPv6 host must be [a-fA-F0-9:]+ only
  781. if (uc.host.empty()) { return false; }
  782. for (auto c : uc.host) {
  783. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  784. (c >= 'A' && c <= 'F') || c == ':')) {
  785. return false;
  786. }
  787. }
  788. pos = close + 1;
  789. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  790. // path, query or fragment delimiter (or the end of input). Otherwise the
  791. // trailing bytes would be folded into the path while the connection
  792. // still targets the bracketed address.
  793. if (pos < url.size()) {
  794. auto c = url[pos];
  795. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  796. }
  797. } else {
  798. auto end = url.find_first_of(":/?#", pos);
  799. if (end == std::string::npos) { end = url.size(); }
  800. uc.host = url.substr(pos, end - pos);
  801. pos = end;
  802. }
  803. if (pos < url.size() && url[pos] == ':') {
  804. ++pos;
  805. auto end = url.find_first_of("/?#", pos);
  806. if (end == std::string::npos) { end = url.size(); }
  807. uc.port = url.substr(pos, end - pos);
  808. pos = end;
  809. }
  810. // Without :// or //, the entire input must be consumed as host[:port].
  811. // If there is leftover (path, query, etc.), this is not a valid
  812. // host[:port] string — clear and reparse as a plain path.
  813. if (!has_authority_prefix && pos < url.size()) {
  814. uc.host.clear();
  815. uc.port.clear();
  816. pos = 0;
  817. }
  818. }
  819. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  820. auto end = url.find_first_of("?#", pos);
  821. if (end == std::string::npos) { end = url.size(); }
  822. uc.path = url.substr(pos, end - pos);
  823. pos = end;
  824. }
  825. if (pos < url.size() && url[pos] == '?') {
  826. auto end = url.find('#', pos);
  827. if (end == std::string::npos) { end = url.size(); }
  828. uc.query = url.substr(pos, end - pos);
  829. }
  830. return true;
  831. }
  832. // Resolves a relative-path or query-only Location value against the path of
  833. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  834. // references starting with '/' are returned unchanged.
  835. inline std::string resolve_relative_location(const std::string &location,
  836. const std::string &base) {
  837. if (location.empty() || location[0] == '/') { return location; }
  838. // A ':' in the first segment means the value has a scheme.
  839. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  840. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  841. auto base_path = base.substr(0, base.find_first_of("?#"));
  842. if (location[0] == '?') { return base_path + location; }
  843. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  844. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  845. // Remove "." and ".." segments from the merged path.
  846. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  847. std::string path;
  848. size_t i = 0;
  849. while (i < path_end) {
  850. auto next = (std::min)(merged.find('/', i + 1), path_end);
  851. auto segment = merged.substr(i + 1, next - i - 1);
  852. auto is_last = next == path_end;
  853. if (segment == "." || segment == "..") {
  854. if (segment == "..") {
  855. path.erase((std::min)(path.rfind('/'), path.size()));
  856. }
  857. if (is_last) { path += '/'; }
  858. } else {
  859. path += '/';
  860. path += segment;
  861. }
  862. i = next;
  863. }
  864. if (path.empty()) { path = "/"; }
  865. return path + merged.substr(path_end);
  866. }
  867. } // namespace detail
  868. enum class SSLVerifierResponse {
  869. // no decision has been made, use the built-in certificate verifier
  870. NoDecisionMade,
  871. // connection certificate is verified and accepted
  872. CertificateAccepted,
  873. // connection certificate was processed but is rejected
  874. CertificateRejected
  875. };
  876. // System CA loading policy for SSL clients. Auto (the default) loads system
  877. // CA certs only when no custom CA is configured; enable_system_ca() switches
  878. // to an explicit policy.
  879. enum class SystemCAMode { Auto, Enabled, Disabled };
  880. enum StatusCode {
  881. // Information responses
  882. Continue_100 = 100,
  883. SwitchingProtocol_101 = 101,
  884. Processing_102 = 102,
  885. EarlyHints_103 = 103,
  886. // Successful responses
  887. OK_200 = 200,
  888. Created_201 = 201,
  889. Accepted_202 = 202,
  890. NonAuthoritativeInformation_203 = 203,
  891. NoContent_204 = 204,
  892. ResetContent_205 = 205,
  893. PartialContent_206 = 206,
  894. MultiStatus_207 = 207,
  895. AlreadyReported_208 = 208,
  896. IMUsed_226 = 226,
  897. // Redirection messages
  898. MultipleChoices_300 = 300,
  899. MovedPermanently_301 = 301,
  900. Found_302 = 302,
  901. SeeOther_303 = 303,
  902. NotModified_304 = 304,
  903. UseProxy_305 = 305,
  904. unused_306 = 306,
  905. TemporaryRedirect_307 = 307,
  906. PermanentRedirect_308 = 308,
  907. // Client error responses
  908. BadRequest_400 = 400,
  909. Unauthorized_401 = 401,
  910. PaymentRequired_402 = 402,
  911. Forbidden_403 = 403,
  912. NotFound_404 = 404,
  913. MethodNotAllowed_405 = 405,
  914. NotAcceptable_406 = 406,
  915. ProxyAuthenticationRequired_407 = 407,
  916. RequestTimeout_408 = 408,
  917. Conflict_409 = 409,
  918. Gone_410 = 410,
  919. LengthRequired_411 = 411,
  920. PreconditionFailed_412 = 412,
  921. PayloadTooLarge_413 = 413,
  922. UriTooLong_414 = 414,
  923. UnsupportedMediaType_415 = 415,
  924. RangeNotSatisfiable_416 = 416,
  925. ExpectationFailed_417 = 417,
  926. ImATeapot_418 = 418,
  927. MisdirectedRequest_421 = 421,
  928. UnprocessableContent_422 = 422,
  929. Locked_423 = 423,
  930. FailedDependency_424 = 424,
  931. TooEarly_425 = 425,
  932. UpgradeRequired_426 = 426,
  933. PreconditionRequired_428 = 428,
  934. TooManyRequests_429 = 429,
  935. RequestHeaderFieldsTooLarge_431 = 431,
  936. UnavailableForLegalReasons_451 = 451,
  937. // Server error responses
  938. InternalServerError_500 = 500,
  939. NotImplemented_501 = 501,
  940. BadGateway_502 = 502,
  941. ServiceUnavailable_503 = 503,
  942. GatewayTimeout_504 = 504,
  943. HttpVersionNotSupported_505 = 505,
  944. VariantAlsoNegotiates_506 = 506,
  945. InsufficientStorage_507 = 507,
  946. LoopDetected_508 = 508,
  947. NotExtended_510 = 510,
  948. NetworkAuthenticationRequired_511 = 511,
  949. };
  950. namespace detail {
  951. // A multimap that keeps its entries in the order they were inserted.
  952. //
  953. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  954. // fields sharing a field name significant and forbids a proxy from reordering
  955. // them, and a query string's parameters are meaningful in the order the caller
  956. // wrote them. Neither standard container expresses it: std::unordered_multimap
  957. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  958. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  959. // key, which would drop control data such as Host behind whatever else the
  960. // message carries and alphabetise a query string.
  961. //
  962. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  963. // scan, which beats hashing for the handful of entries a message carries
  964. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  965. //
  966. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  967. // Params, whose parameter names are case-sensitive, not.
  968. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  969. public:
  970. using key_type = std::string;
  971. using mapped_type = Mapped;
  972. using value_type = std::pair<std::string, Mapped>;
  973. using size_type = std::size_t;
  974. using difference_type = std::ptrdiff_t;
  975. using reference = value_type &;
  976. using const_reference = const value_type &;
  977. private:
  978. static size_type npos() { return static_cast<size_type>(-1); }
  979. static bool keys_equal(const std::string &a, const std::string &b) {
  980. return KeyEqual()(a, b);
  981. }
  982. // Iterating yields every entry in insertion order, but equal_range() and
  983. // find() have to walk only the entries sharing one key, which are not
  984. // adjacent. Both are the same iterator type: key_idx_ selects between the
  985. // two traversals, and since equality compares only the position, an iterator
  986. // restricted to one key still compares equal to end().
  987. template <typename V> class iterator_t {
  988. public:
  989. using iterator_category = std::bidirectional_iterator_tag;
  990. using value_type = insertion_ordered_multimap::value_type;
  991. using difference_type = insertion_ordered_multimap::difference_type;
  992. using pointer = V *;
  993. using reference = V &;
  994. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  995. template <typename U,
  996. typename std::enable_if<std::is_convertible<U *, V *>::value,
  997. int>::type = 0>
  998. iterator_t(const iterator_t<U> &rhs)
  999. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  1000. key_idx_(rhs.key_idx_) {}
  1001. reference operator*() const { return data_[idx_]; }
  1002. pointer operator->() const { return data_ + idx_; }
  1003. iterator_t &operator++() {
  1004. // Saturating, so that advancing past the last entry of a key stays at
  1005. // end() instead of running off the container.
  1006. if (idx_ >= size_) { return *this; }
  1007. ++idx_;
  1008. if (key_idx_ != npos()) {
  1009. while (idx_ < size_ && !matches(idx_)) {
  1010. ++idx_;
  1011. }
  1012. }
  1013. return *this;
  1014. }
  1015. iterator_t operator++(int) {
  1016. auto tmp = *this;
  1017. ++*this;
  1018. return tmp;
  1019. }
  1020. iterator_t &operator--() {
  1021. if (idx_ == 0) { return *this; }
  1022. --idx_;
  1023. if (key_idx_ != npos()) {
  1024. while (idx_ > 0 && !matches(idx_)) {
  1025. --idx_;
  1026. }
  1027. }
  1028. return *this;
  1029. }
  1030. iterator_t operator--(int) {
  1031. auto tmp = *this;
  1032. --*this;
  1033. return tmp;
  1034. }
  1035. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1036. return idx_ == rhs.idx_;
  1037. }
  1038. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1039. return idx_ != rhs.idx_;
  1040. }
  1041. private:
  1042. friend class insertion_ordered_multimap;
  1043. template <typename> friend class iterator_t;
  1044. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1045. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1046. bool matches(size_type i) const {
  1047. return keys_equal(data_[i].first, data_[key_idx_].first);
  1048. }
  1049. V *data_;
  1050. size_type idx_;
  1051. size_type size_;
  1052. size_type key_idx_;
  1053. };
  1054. public:
  1055. using iterator = iterator_t<value_type>;
  1056. using const_iterator = iterator_t<const value_type>;
  1057. insertion_ordered_multimap() = default;
  1058. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1059. : entries_(il) {}
  1060. template <typename InputIt>
  1061. insertion_ordered_multimap(InputIt first, InputIt last)
  1062. : entries_(first, last) {}
  1063. iterator begin() { return make_iter(0, npos()); }
  1064. iterator end() { return make_iter(entries_.size(), npos()); }
  1065. const_iterator begin() const { return make_citer(0, npos()); }
  1066. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1067. const_iterator cbegin() const { return begin(); }
  1068. const_iterator cend() const { return end(); }
  1069. bool empty() const { return entries_.empty(); }
  1070. size_type size() const { return entries_.size(); }
  1071. void clear() { entries_.clear(); }
  1072. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1073. iterator insert(const value_type &val) {
  1074. entries_.push_back(val);
  1075. return make_iter(entries_.size() - 1, npos());
  1076. }
  1077. iterator insert(value_type &&val) {
  1078. entries_.push_back(std::move(val));
  1079. return make_iter(entries_.size() - 1, npos());
  1080. }
  1081. template <typename... Args> iterator emplace(Args &&...args) {
  1082. entries_.emplace_back(std::forward<Args>(args)...);
  1083. return make_iter(entries_.size() - 1, npos());
  1084. }
  1085. // For entries that have to lead the message, such as the Host header field
  1086. // (RFC 9110 5.3 recommends sending control data first).
  1087. template <typename... Args> iterator emplace_front(Args &&...args) {
  1088. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1089. return make_iter(0, npos());
  1090. }
  1091. iterator find(const std::string &key) {
  1092. auto i = index_of(key);
  1093. return i == npos() ? end() : make_iter(i, i);
  1094. }
  1095. const_iterator find(const std::string &key) const {
  1096. auto i = index_of(key);
  1097. return i == npos() ? end() : make_citer(i, i);
  1098. }
  1099. size_type count(const std::string &key) const {
  1100. size_type n = 0;
  1101. for (const auto &entry : entries_) {
  1102. if (keys_equal(entry.first, key)) { n++; }
  1103. }
  1104. return n;
  1105. }
  1106. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1107. auto i = index_of(key);
  1108. return i == npos() ? std::make_pair(end(), end())
  1109. : std::make_pair(make_iter(i, i), end());
  1110. }
  1111. std::pair<const_iterator, const_iterator>
  1112. equal_range(const std::string &key) const {
  1113. auto i = index_of(key);
  1114. return i == npos() ? std::make_pair(end(), end())
  1115. : std::make_pair(make_citer(i, i), end());
  1116. }
  1117. size_type erase(const std::string &key) {
  1118. auto before = entries_.size();
  1119. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1120. [&](const value_type &entry) {
  1121. return keys_equal(entry.first, key);
  1122. }),
  1123. entries_.end());
  1124. return before - entries_.size();
  1125. }
  1126. iterator erase(const_iterator pos) {
  1127. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1128. return make_iter(pos.idx_, npos());
  1129. }
  1130. // Erases what iterating [first, last) would actually visit, so erasing an
  1131. // equal_range() removes only the entries with that key, not everything
  1132. // positioned between them.
  1133. iterator erase(const_iterator first, const_iterator last) {
  1134. auto from = first.idx_;
  1135. auto to = last.idx_;
  1136. if (from >= to) { return make_iter(from, npos()); }
  1137. auto begin_it = entries_.begin();
  1138. auto from_it = begin_it + static_cast<difference_type>(from);
  1139. auto to_it = begin_it + static_cast<difference_type>(to);
  1140. if (first.key_idx_ == npos()) {
  1141. entries_.erase(from_it, to_it);
  1142. } else {
  1143. auto key = entries_[first.key_idx_].first;
  1144. auto keep = from_it;
  1145. for (auto it = from_it; it != to_it; ++it) {
  1146. if (!keys_equal(it->first, key)) {
  1147. if (keep != it) { *keep = std::move(*it); }
  1148. ++keep;
  1149. }
  1150. }
  1151. if (keep != to_it) {
  1152. keep = std::move(to_it, entries_.end(), keep);
  1153. } else {
  1154. keep = entries_.end();
  1155. }
  1156. entries_.erase(keep, entries_.end());
  1157. }
  1158. return make_iter(from, npos());
  1159. }
  1160. friend bool operator==(const insertion_ordered_multimap &lhs,
  1161. const insertion_ordered_multimap &rhs) {
  1162. return lhs.entries_ == rhs.entries_;
  1163. }
  1164. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1165. const insertion_ordered_multimap &rhs) {
  1166. return !(lhs == rhs);
  1167. }
  1168. private:
  1169. size_type index_of(const std::string &key) const {
  1170. for (size_type i = 0; i < entries_.size(); i++) {
  1171. if (keys_equal(entries_[i].first, key)) { return i; }
  1172. }
  1173. return npos();
  1174. }
  1175. iterator make_iter(size_type idx, size_type key_idx) {
  1176. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1177. }
  1178. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1179. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1180. }
  1181. std::vector<value_type> entries_;
  1182. };
  1183. } // namespace detail
  1184. using Headers =
  1185. detail::insertion_ordered_multimap<std::string,
  1186. detail::case_ignore::equal_to>;
  1187. // Query parameter names are case-sensitive, unlike header field names.
  1188. using Params =
  1189. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1190. using Match = std::smatch;
  1191. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1192. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1193. /*
  1194. * detail: type-erased storage used by UserData.
  1195. * ABI-stable regardless of C++ standard — always uses this custom
  1196. * implementation instead of std::any.
  1197. */
  1198. namespace detail {
  1199. using any_type_id = const void *;
  1200. template <typename T> any_type_id any_typeid() noexcept {
  1201. static const char id = 0;
  1202. return &id;
  1203. }
  1204. struct any_storage {
  1205. virtual ~any_storage() = default;
  1206. virtual std::unique_ptr<any_storage> clone() const = 0;
  1207. virtual any_type_id type_id() const noexcept = 0;
  1208. };
  1209. template <typename T> struct any_value final : any_storage {
  1210. T value;
  1211. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1212. std::unique_ptr<any_storage> clone() const override {
  1213. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1214. }
  1215. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1216. };
  1217. } // namespace detail
  1218. class UserData {
  1219. public:
  1220. UserData() = default;
  1221. UserData(UserData &&) noexcept = default;
  1222. UserData &operator=(UserData &&) noexcept = default;
  1223. UserData(const UserData &o) {
  1224. for (const auto &e : o.entries_) {
  1225. if (e.second) { entries_[e.first] = e.second->clone(); }
  1226. }
  1227. }
  1228. UserData &operator=(const UserData &o) {
  1229. if (this != &o) {
  1230. entries_.clear();
  1231. for (const auto &e : o.entries_) {
  1232. if (e.second) { entries_[e.first] = e.second->clone(); }
  1233. }
  1234. }
  1235. return *this;
  1236. }
  1237. template <typename T> void set(const std::string &key, T &&value) {
  1238. using D = typename std::decay<T>::type;
  1239. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1240. }
  1241. template <typename T> T *get(const std::string &key) noexcept {
  1242. auto it = entries_.find(key);
  1243. if (it == entries_.end() || !it->second) { return nullptr; }
  1244. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1245. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1246. }
  1247. template <typename T> const T *get(const std::string &key) const noexcept {
  1248. auto it = entries_.find(key);
  1249. if (it == entries_.end() || !it->second) { return nullptr; }
  1250. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1251. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1252. }
  1253. bool has(const std::string &key) const noexcept {
  1254. return entries_.find(key) != entries_.end();
  1255. }
  1256. void erase(const std::string &key) { entries_.erase(key); }
  1257. void clear() noexcept { entries_.clear(); }
  1258. private:
  1259. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1260. entries_;
  1261. };
  1262. struct Response;
  1263. using ResponseHandler = std::function<bool(const Response &response)>;
  1264. struct FormData {
  1265. std::string name;
  1266. std::string content;
  1267. std::string filename;
  1268. std::string content_type;
  1269. Headers headers;
  1270. };
  1271. struct FormField {
  1272. std::string name;
  1273. std::string content;
  1274. Headers headers;
  1275. };
  1276. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1277. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1278. // should see the parts as they were sent. A std::multimap sorts by field name
  1279. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1280. // than the case-insensitive predicate Headers uses.
  1281. using FormFields =
  1282. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1283. using FormFiles =
  1284. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1285. struct MultipartFormData {
  1286. FormFields fields; // Text fields from multipart
  1287. FormFiles files; // Files from multipart
  1288. // Text field access
  1289. std::string get_field(const std::string &key, size_t id = 0) const;
  1290. std::vector<std::string> get_fields(const std::string &key) const;
  1291. bool has_field(const std::string &key) const;
  1292. size_t get_field_count(const std::string &key) const;
  1293. // File access
  1294. FormData get_file(const std::string &key, size_t id = 0) const;
  1295. std::vector<FormData> get_files(const std::string &key) const;
  1296. bool has_file(const std::string &key) const;
  1297. size_t get_file_count(const std::string &key) const;
  1298. };
  1299. struct UploadFormData {
  1300. std::string name;
  1301. std::string content;
  1302. std::string filename;
  1303. std::string content_type;
  1304. };
  1305. using UploadFormDataItems = std::vector<UploadFormData>;
  1306. class DataSink {
  1307. public:
  1308. DataSink() : os(&sb_), sb_(*this) {}
  1309. DataSink(const DataSink &) = delete;
  1310. DataSink &operator=(const DataSink &) = delete;
  1311. DataSink(DataSink &&) = delete;
  1312. DataSink &operator=(DataSink &&) = delete;
  1313. std::function<bool(const char *data, size_t data_len)> write;
  1314. // Only `write` is mandatory. The rest are defaulted so that a provider
  1315. // calling one on a writer that does not set it gets sensible behaviour
  1316. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1317. // `this` is safe: DataSink is neither copyable nor movable.
  1318. std::function<bool()> is_writable = []() { return true; };
  1319. std::function<void()> done = []() {};
  1320. std::function<void(const Headers &trailer)> done_with_trailer =
  1321. [this](const Headers & /*trailer*/) { done(); };
  1322. std::ostream os;
  1323. private:
  1324. class data_sink_streambuf final : public std::streambuf {
  1325. public:
  1326. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1327. protected:
  1328. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1329. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1330. return 0;
  1331. }
  1332. private:
  1333. DataSink &sink_;
  1334. };
  1335. data_sink_streambuf sb_;
  1336. };
  1337. using ContentProvider =
  1338. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1339. using ContentProviderWithoutLength =
  1340. std::function<bool(size_t offset, DataSink &sink)>;
  1341. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1342. struct FormDataProvider {
  1343. std::string name;
  1344. ContentProviderWithoutLength provider;
  1345. std::string filename;
  1346. std::string content_type;
  1347. };
  1348. using FormDataProviderItems = std::vector<FormDataProvider>;
  1349. inline FormDataProvider
  1350. make_file_provider(const std::string &name, const std::string &filepath,
  1351. const std::string &filename = std::string(),
  1352. const std::string &content_type = std::string()) {
  1353. FormDataProvider fdp;
  1354. fdp.name = name;
  1355. fdp.filename = filename.empty() ? filepath : filename;
  1356. fdp.content_type = content_type;
  1357. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1358. std::ifstream f(filepath, std::ios::binary);
  1359. if (!f) { return false; }
  1360. if (offset > 0) {
  1361. f.seekg(static_cast<std::streamoff>(offset));
  1362. if (!f.good()) {
  1363. sink.done();
  1364. return true;
  1365. }
  1366. }
  1367. char buf[8192];
  1368. f.read(buf, sizeof(buf));
  1369. auto n = static_cast<size_t>(f.gcount());
  1370. if (n > 0) { return sink.write(buf, n); }
  1371. sink.done(); // EOF
  1372. return true;
  1373. };
  1374. return fdp;
  1375. }
  1376. inline std::pair<size_t, ContentProvider>
  1377. make_file_body(const std::string &filepath) {
  1378. size_t size = 0;
  1379. {
  1380. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1381. if (!f) { return {0, ContentProvider{}}; }
  1382. size = static_cast<size_t>(f.tellg());
  1383. }
  1384. ContentProvider provider = [filepath](size_t offset, size_t length,
  1385. DataSink &sink) -> bool {
  1386. std::ifstream f(filepath, std::ios::binary);
  1387. if (!f) { return false; }
  1388. f.seekg(static_cast<std::streamoff>(offset));
  1389. if (!f.good()) { return false; }
  1390. char buf[8192];
  1391. while (length > 0) {
  1392. auto to_read = (std::min)(sizeof(buf), length);
  1393. f.read(buf, static_cast<std::streamsize>(to_read));
  1394. auto n = static_cast<size_t>(f.gcount());
  1395. // The file is shorter than the size make_file_body() measured, which the
  1396. // caller has already committed to as Content-Length. The body cannot be
  1397. // completed, so fail as every other error here does.
  1398. if (n == 0) { return false; }
  1399. if (!sink.write(buf, n)) { return false; }
  1400. length -= n;
  1401. }
  1402. return true;
  1403. };
  1404. return {size, std::move(provider)};
  1405. }
  1406. using ContentReceiverWithProgress = std::function<bool(
  1407. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1408. using ContentReceiver =
  1409. std::function<bool(const char *data, size_t data_length)>;
  1410. using FormDataHeader = std::function<bool(const FormData &file)>;
  1411. class ContentReader {
  1412. public:
  1413. using Reader = std::function<bool(ContentReceiver receiver)>;
  1414. using FormDataReader =
  1415. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1416. ContentReader(Reader reader, FormDataReader multipart_reader)
  1417. : reader_(std::move(reader)),
  1418. formdata_reader_(std::move(multipart_reader)) {}
  1419. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1420. return formdata_reader_(std::move(header), std::move(receiver));
  1421. }
  1422. bool operator()(ContentReceiver receiver) const {
  1423. return reader_(std::move(receiver));
  1424. }
  1425. Reader reader_;
  1426. FormDataReader formdata_reader_;
  1427. };
  1428. using Range = std::pair<ssize_t, ssize_t>;
  1429. using Ranges = std::vector<Range>;
  1430. #ifdef CPPHTTPLIB_SSL_ENABLED
  1431. // TLS abstraction layer - public type definitions and API
  1432. namespace tls {
  1433. // Opaque handles (defined as void* for abstraction)
  1434. using ctx_t = void *;
  1435. using session_t = void *;
  1436. using const_session_t = const void *; // For read-only session access
  1437. using cert_t = void *;
  1438. using ca_store_t = void *;
  1439. // TLS versions
  1440. enum class Version {
  1441. TLS1_2 = 0x0303,
  1442. TLS1_3 = 0x0304,
  1443. };
  1444. // Subject Alternative Names (SAN) entry types
  1445. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1446. // SAN entry structure
  1447. struct SanEntry {
  1448. SanType type;
  1449. std::string value;
  1450. };
  1451. // Verification context for certificate verification callback
  1452. struct VerifyContext {
  1453. session_t session; // TLS session handle
  1454. cert_t cert; // Current certificate being verified
  1455. int depth; // Certificate chain depth (0 = leaf)
  1456. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1457. long error_code; // Backend-specific error code (0 = no error)
  1458. const char *error_string; // Human-readable error description
  1459. // Certificate introspection methods
  1460. std::string subject_cn() const;
  1461. std::string issuer_name() const;
  1462. bool check_hostname(const char *hostname) const;
  1463. std::vector<SanEntry> sans() const;
  1464. bool validity(time_t &not_before, time_t &not_after) const;
  1465. std::string serial() const;
  1466. };
  1467. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1468. // TlsError codes for TLS operations (backend-independent)
  1469. enum class ErrorCode : int {
  1470. Success = 0,
  1471. WantRead, // Non-blocking: need to wait for read
  1472. WantWrite, // Non-blocking: need to wait for write
  1473. PeerClosed, // Peer closed the connection
  1474. Fatal, // Unrecoverable error
  1475. SyscallError, // System call error (check sys_errno)
  1476. CertVerifyFailed, // Certificate verification failed
  1477. HostnameMismatch, // Hostname verification failed
  1478. };
  1479. // TLS error information
  1480. struct TlsError {
  1481. ErrorCode code = ErrorCode::Fatal;
  1482. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1483. int sys_errno = 0; // errno when SyscallError
  1484. // Convert verification error code to human-readable string
  1485. static std::string verify_error_to_string(long error_code);
  1486. };
  1487. // RAII wrapper for peer certificate
  1488. class PeerCert {
  1489. public:
  1490. PeerCert();
  1491. PeerCert(PeerCert &&other) noexcept;
  1492. PeerCert &operator=(PeerCert &&other) noexcept;
  1493. ~PeerCert();
  1494. PeerCert(const PeerCert &) = delete;
  1495. PeerCert &operator=(const PeerCert &) = delete;
  1496. explicit operator bool() const;
  1497. std::string subject_cn() const;
  1498. std::string issuer_name() const;
  1499. bool check_hostname(const char *hostname) const;
  1500. std::vector<SanEntry> sans() const;
  1501. bool validity(time_t &not_before, time_t &not_after) const;
  1502. std::string serial() const;
  1503. private:
  1504. explicit PeerCert(cert_t cert);
  1505. cert_t cert_ = nullptr;
  1506. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1507. };
  1508. // Callback for TLS context setup (used by SSLServer constructor)
  1509. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1510. } // namespace tls
  1511. #endif
  1512. struct Request {
  1513. std::string method;
  1514. std::string path;
  1515. std::string matched_route;
  1516. Params params;
  1517. Headers headers;
  1518. Headers trailers;
  1519. std::string body;
  1520. std::string remote_addr;
  1521. int remote_port = -1;
  1522. std::string local_addr;
  1523. int local_port = -1;
  1524. // for server
  1525. std::string version;
  1526. std::string target;
  1527. MultipartFormData form;
  1528. Ranges ranges;
  1529. Match matches;
  1530. std::unordered_map<std::string, std::string> path_params;
  1531. std::function<bool()> is_connection_closed = []() { return true; };
  1532. // for client
  1533. std::vector<std::string> accept_content_types;
  1534. ResponseHandler response_handler;
  1535. ContentReceiverWithProgress content_receiver;
  1536. DownloadProgress download_progress;
  1537. UploadProgress upload_progress;
  1538. bool has_header(const std::string &key) const;
  1539. std::string get_header_value(const std::string &key, const char *def = "",
  1540. size_t id = 0) const;
  1541. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1542. size_t id = 0) const;
  1543. size_t get_header_value_count(const std::string &key) const;
  1544. void set_header(const std::string &key, const std::string &val);
  1545. bool has_trailer(const std::string &key) const;
  1546. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1547. size_t get_trailer_value_count(const std::string &key) const;
  1548. bool has_param(const std::string &key) const;
  1549. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1550. std::vector<std::string> get_param_values(const std::string &key) const;
  1551. size_t get_param_value_count(const std::string &key) const;
  1552. bool is_multipart_form_data() const;
  1553. // private members...
  1554. bool body_read_started_ = false;
  1555. bool body_consumed_ = false;
  1556. bool expect_100_continue_pending_ = false;
  1557. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1558. size_t content_length_ = 0;
  1559. ContentProvider content_provider_;
  1560. bool is_chunked_content_provider_ = false;
  1561. size_t authorization_count_ = 0;
  1562. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1563. (std::chrono::steady_clock::time_point::min)();
  1564. #ifdef CPPHTTPLIB_SSL_ENABLED
  1565. tls::const_session_t ssl = nullptr;
  1566. tls::PeerCert peer_cert() const;
  1567. std::string sni() const;
  1568. #endif
  1569. };
  1570. namespace detail {
  1571. // Declared up here, away from the rest of the compression helpers, because
  1572. // `Response` stores one.
  1573. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1574. } // namespace detail
  1575. struct Response {
  1576. std::string version;
  1577. int status = -1;
  1578. std::string reason;
  1579. Headers headers;
  1580. Headers trailers;
  1581. std::string body;
  1582. std::string location; // Redirect location
  1583. // User-defined context — set by pre-routing/pre-request handlers and read
  1584. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1585. UserData user_data;
  1586. bool has_header(const std::string &key) const;
  1587. std::string get_header_value(const std::string &key, const char *def = "",
  1588. size_t id = 0) const;
  1589. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1590. size_t id = 0) const;
  1591. size_t get_header_value_count(const std::string &key) const;
  1592. void set_header(const std::string &key, const std::string &val);
  1593. bool has_trailer(const std::string &key) const;
  1594. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1595. size_t get_trailer_value_count(const std::string &key) const;
  1596. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1597. void set_content(const char *s, size_t n, const std::string &content_type);
  1598. void set_content(const std::string &s, const std::string &content_type);
  1599. void set_content(std::string &&s, const std::string &content_type);
  1600. void set_content_provider(
  1601. size_t length, const std::string &content_type, ContentProvider provider,
  1602. ContentProviderResourceReleaser resource_releaser = nullptr);
  1603. void set_content_provider(
  1604. const std::string &content_type, ContentProviderWithoutLength provider,
  1605. ContentProviderResourceReleaser resource_releaser = nullptr);
  1606. void set_chunked_content_provider(
  1607. const std::string &content_type, ContentProviderWithoutLength provider,
  1608. ContentProviderResourceReleaser resource_releaser = nullptr);
  1609. void set_file_content(const std::string &path,
  1610. const std::string &content_type);
  1611. void set_file_content(const std::string &path);
  1612. Response() = default;
  1613. Response(const Response &) = default;
  1614. Response &operator=(const Response &) = default;
  1615. Response(Response &&) = default;
  1616. Response &operator=(Response &&) = default;
  1617. ~Response() {
  1618. if (content_provider_resource_releaser_) {
  1619. content_provider_resource_releaser_(content_provider_success_);
  1620. }
  1621. }
  1622. // private members...
  1623. size_t content_length_ = 0;
  1624. ContentProvider content_provider_;
  1625. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1626. bool is_chunked_content_provider_ = false;
  1627. bool is_file_content_provider_ = false;
  1628. bool content_provider_success_ = false;
  1629. std::string file_content_path_;
  1630. std::string file_content_content_type_;
  1631. // Content coding chosen for the response body, decided once so that the
  1632. // headers and the body cannot disagree: where the file is opened for a
  1633. // file-backed content provider (keeping the ETag honest), and in
  1634. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1635. // for every other kind of response.
  1636. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1637. };
  1638. enum class Error {
  1639. Success = 0,
  1640. Unknown,
  1641. Connection,
  1642. BindIPAddress,
  1643. Read,
  1644. Write,
  1645. ExceedRedirectCount,
  1646. Canceled,
  1647. SSLConnection,
  1648. SSLLoadingCerts,
  1649. SSLServerVerification,
  1650. SSLServerHostnameVerification,
  1651. UnsupportedMultipartBoundaryChars,
  1652. Compression,
  1653. ConnectionTimeout,
  1654. ProxyConnection,
  1655. ConnectionClosed,
  1656. Timeout,
  1657. ResourceExhaustion,
  1658. TooManyFormDataFiles,
  1659. ExceedMaxPayloadSize,
  1660. ExceedUriMaxLength,
  1661. ExceedMaxSocketDescriptorCount,
  1662. InvalidRequestLine,
  1663. InvalidHTTPMethod,
  1664. InvalidHTTPVersion,
  1665. InvalidHeaders,
  1666. MultipartParsing,
  1667. OpenFile,
  1668. Listen,
  1669. GetSockName,
  1670. UnsupportedAddressFamily,
  1671. HTTPParsing,
  1672. InvalidRangeHeader,
  1673. UnsupportedContentEncoding,
  1674. WebSocketHandshake,
  1675. UserCallbackException,
  1676. // For internal use only
  1677. SSLPeerCouldBeClosed_,
  1678. };
  1679. std::string to_string(Error error);
  1680. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1681. class Stream {
  1682. public:
  1683. virtual ~Stream() = default;
  1684. virtual bool is_readable() const = 0;
  1685. virtual bool wait_readable() const = 0;
  1686. virtual bool wait_writable() const = 0;
  1687. virtual bool is_peer_alive() const { return wait_writable(); }
  1688. virtual ssize_t read(char *ptr, size_t size) = 0;
  1689. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1690. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1691. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1692. virtual socket_t socket() const = 0;
  1693. virtual time_t duration() const = 0;
  1694. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1695. (void)sec;
  1696. (void)usec;
  1697. }
  1698. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1699. // each one. 0 lifts the bound.
  1700. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1701. // Lets a wait for data end early once `interrupted` returns true, so that
  1702. // another thread can stop a blocked read on every platform.
  1703. virtual void set_read_interrupt(std::function<bool()> interrupted) {
  1704. (void)interrupted;
  1705. }
  1706. // Bytes already pulled off the socket and sitting in this stream's own
  1707. // buffer. Exposing them lets a line reader scan for a terminator in one
  1708. // pass instead of asking for a byte at a time. A stream that does no
  1709. // buffering of its own reports none, and readers fall back to read().
  1710. virtual const char *buffered_data(size_t &size) const {
  1711. size = 0;
  1712. return nullptr;
  1713. }
  1714. // Discards `size` bytes previously returned by buffered_data().
  1715. virtual void consume_buffered(size_t size) { (void)size; }
  1716. ssize_t write(const char *ptr);
  1717. ssize_t write(const std::string &s);
  1718. Error get_error() const { return error_; }
  1719. protected:
  1720. Error error_ = Error::Success;
  1721. };
  1722. class TaskQueue {
  1723. public:
  1724. TaskQueue() = default;
  1725. virtual ~TaskQueue() = default;
  1726. virtual bool enqueue(std::function<void()> fn) = 0;
  1727. virtual void shutdown() = 0;
  1728. virtual void on_idle() {}
  1729. };
  1730. class ThreadPool final : public TaskQueue {
  1731. public:
  1732. explicit ThreadPool(
  1733. size_t n, size_t max_n = 0, size_t mqr = 0,
  1734. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1735. ThreadPool(const ThreadPool &) = delete;
  1736. ~ThreadPool() override = default;
  1737. bool enqueue(std::function<void()> fn) override;
  1738. void shutdown() override;
  1739. private:
  1740. void worker(bool is_dynamic);
  1741. void move_to_finished(std::thread::id id);
  1742. void cleanup_finished_threads();
  1743. size_t base_thread_count_;
  1744. size_t max_thread_count_;
  1745. size_t max_queued_requests_;
  1746. time_t idle_timeout_sec_;
  1747. size_t idle_thread_count_;
  1748. bool shutdown_;
  1749. std::list<std::function<void()>> jobs_;
  1750. std::vector<std::thread> threads_; // base threads
  1751. std::list<std::thread> dynamic_threads_; // dynamic threads
  1752. std::vector<std::thread>
  1753. finished_threads_; // exited dynamic threads awaiting join
  1754. std::condition_variable cond_;
  1755. std::mutex mutex_;
  1756. };
  1757. using Logger = std::function<void(const Request &, const Response &)>;
  1758. // Forward declaration for Error type
  1759. enum class Error;
  1760. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1761. using SocketOptions = std::function<void(socket_t sock)>;
  1762. void default_socket_options(socket_t sock);
  1763. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1764. const char *status_message(int status);
  1765. std::string to_string(Error error);
  1766. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1767. std::string get_bearer_token_auth(const Request &req);
  1768. namespace detail {
  1769. class MatcherBase {
  1770. public:
  1771. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1772. virtual ~MatcherBase() = default;
  1773. const std::string &pattern() const { return pattern_; }
  1774. // Match request path and populate its matches and
  1775. virtual bool match(Request &request) const = 0;
  1776. private:
  1777. std::string pattern_;
  1778. };
  1779. /**
  1780. * Captures parameters in request path and stores them in Request::path_params
  1781. *
  1782. * Capture name is a substring of a pattern from : to /.
  1783. * The rest of the pattern is matched against the request path directly
  1784. * Parameters are captured starting from the next character after
  1785. * the end of the last matched static pattern fragment until the next /.
  1786. *
  1787. * Example pattern:
  1788. * "/path/fragments/:capture/more/fragments/:second_capture"
  1789. * Static fragments:
  1790. * "/path/fragments/", "more/fragments/"
  1791. *
  1792. * Given the following request path:
  1793. * "/path/fragments/:1/more/fragments/:2"
  1794. * the resulting capture will be
  1795. * {{"capture", "1"}, {"second_capture", "2"}}
  1796. */
  1797. class PathParamsMatcher final : public MatcherBase {
  1798. public:
  1799. PathParamsMatcher(const std::string &pattern);
  1800. bool match(Request &request) const override;
  1801. private:
  1802. // Treat segment separators as the end of path parameter capture
  1803. // Does not need to handle query parameters as they are parsed before path
  1804. // matching
  1805. static constexpr char separator = '/';
  1806. // Contains static path fragments to match against, excluding the '/' after
  1807. // path params
  1808. // Fragments are separated by path params
  1809. std::vector<std::string> static_fragments_;
  1810. // Stores the names of the path parameters to be used as keys in the
  1811. // Request::path_params map
  1812. std::vector<std::string> param_names_;
  1813. };
  1814. /**
  1815. * Performs std::regex_match on request path
  1816. * and stores the result in Request::matches
  1817. *
  1818. * Note that regex match is performed directly on the whole request.
  1819. * This means that wildcard patterns may match multiple path segments with /:
  1820. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1821. */
  1822. class RegexMatcher final : public MatcherBase {
  1823. public:
  1824. RegexMatcher(const std::string &pattern)
  1825. : MatcherBase(pattern), regex_(pattern) {}
  1826. bool match(Request &request) const override;
  1827. private:
  1828. std::regex regex_;
  1829. };
  1830. int close_socket(socket_t sock) noexcept;
  1831. bool is_accept_resource_error();
  1832. bool is_accept_transient_error();
  1833. ssize_t write_headers(Stream &strm, const Headers &headers);
  1834. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1835. time_t usec);
  1836. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1837. const std::string &boundary);
  1838. ContentProvider
  1839. make_multipart_content_provider(const UploadFormDataItems &items,
  1840. const std::string &boundary);
  1841. } // namespace detail
  1842. bool is_valid_multipart_boundary(const std::string &boundary);
  1843. // Serializer for multipart/form-data request bodies. The boundary is owned
  1844. // by the writer so that per-part framing and the final terminator always
  1845. // agree. Field names and filenames are escaped following the WHATWG HTML
  1846. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1847. // in content types.
  1848. class MultipartFormDataWriter {
  1849. public:
  1850. MultipartFormDataWriter();
  1851. // precondition: is_valid_multipart_boundary(boundary)
  1852. explicit MultipartFormDataWriter(std::string boundary);
  1853. const std::string &boundary() const;
  1854. std::string content_type() const;
  1855. // In-memory items -> whole body (known length)
  1856. std::string serialize(const UploadFormDataItems &items) const;
  1857. size_t content_length(const UploadFormDataItems &items) const;
  1858. // Per-part framing for streaming via a content provider
  1859. std::string item_begin(const UploadFormData &item) const;
  1860. static std::string item_end();
  1861. std::string finish() const;
  1862. private:
  1863. std::string boundary_;
  1864. };
  1865. class Server {
  1866. public:
  1867. using Handler = std::function<void(const Request &, Response &)>;
  1868. using ExceptionHandler =
  1869. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1870. enum class HandlerResponse {
  1871. Handled,
  1872. Unhandled,
  1873. };
  1874. using HandlerWithResponse =
  1875. std::function<HandlerResponse(const Request &, Response &)>;
  1876. using HandlerWithContentReader = std::function<void(
  1877. const Request &, Response &, const ContentReader &content_reader)>;
  1878. using Expect100ContinueHandler =
  1879. std::function<int(const Request &, Response &)>;
  1880. using StartHandler = std::function<void()>;
  1881. using WebSocketHandler =
  1882. std::function<void(const Request &, ws::WebSocket &)>;
  1883. using SubProtocolSelector =
  1884. std::function<std::string(const std::vector<std::string> &protocols)>;
  1885. Server();
  1886. virtual ~Server();
  1887. virtual bool is_valid() const;
  1888. Server &Get(const std::string &pattern, Handler handler);
  1889. Server &Post(const std::string &pattern, Handler handler);
  1890. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1891. Server &Put(const std::string &pattern, Handler handler);
  1892. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1893. Server &Patch(const std::string &pattern, Handler handler);
  1894. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1895. Server &Delete(const std::string &pattern, Handler handler);
  1896. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1897. Server &Options(const std::string &pattern, Handler handler);
  1898. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1899. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1900. // server accept it; an unregistered method is still rejected with 400.
  1901. // `method` must be a valid HTTP method token and must not be one of the
  1902. // built-in methods, which have their own registration functions above. A
  1903. // rejected registration makes is_valid() return false, so listen() fails.
  1904. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1905. Handler handler);
  1906. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1907. HandlerWithContentReader handler);
  1908. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1909. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1910. SubProtocolSelector sub_protocol_selector);
  1911. bool set_base_dir(const std::string &dir,
  1912. const std::string &mount_point = std::string());
  1913. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1914. Headers headers = Headers());
  1915. bool remove_mount_point(const std::string &mount_point);
  1916. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1917. const std::string &mime);
  1918. Server &set_default_file_mimetype(const std::string &mime);
  1919. Server &set_file_request_handler(Handler handler);
  1920. template <class ErrorHandlerFunc>
  1921. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1922. return set_error_handler_core(
  1923. std::forward<ErrorHandlerFunc>(handler),
  1924. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1925. }
  1926. Server &set_exception_handler(ExceptionHandler handler);
  1927. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1928. Server &set_post_routing_handler(Handler handler);
  1929. Server &set_pre_request_handler(HandlerWithResponse handler);
  1930. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1931. Server &set_start_handler(StartHandler handler);
  1932. Server &set_logger(Logger logger);
  1933. Server &set_pre_compression_logger(Logger logger);
  1934. Server &set_error_logger(ErrorLogger error_logger);
  1935. Server &set_address_family(int family);
  1936. Server &set_tcp_nodelay(bool on);
  1937. Server &set_ipv6_v6only(bool on);
  1938. Server &set_socket_options(SocketOptions socket_options);
  1939. Server &set_default_headers(Headers headers);
  1940. Server &
  1941. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1942. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1943. Server &set_keep_alive_max_count(size_t count);
  1944. Server &set_keep_alive_timeout(time_t sec);
  1945. template <class Rep, class Period>
  1946. Server &
  1947. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1948. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1949. template <class Rep, class Period>
  1950. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1951. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1952. template <class Rep, class Period>
  1953. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1954. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1955. template <class Rep, class Period>
  1956. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1957. Server &set_payload_max_length(size_t length);
  1958. Server &set_static_file_compression(bool on);
  1959. Server &set_static_file_compression_min_length(size_t length);
  1960. Server &set_static_file_compression_max_length(size_t length);
  1961. Server &set_websocket_ping_interval(time_t sec);
  1962. template <class Rep, class Period>
  1963. Server &set_websocket_ping_interval(
  1964. const std::chrono::duration<Rep, Period> &duration);
  1965. Server &set_websocket_max_missed_pongs(int count);
  1966. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1967. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1968. bool listen_after_bind();
  1969. bool listen(const std::string &host, int port, int socket_flags = 0);
  1970. bool is_running() const;
  1971. void wait_until_ready() const;
  1972. void stop() noexcept;
  1973. void decommission();
  1974. std::function<TaskQueue *(void)> new_task_queue;
  1975. protected:
  1976. bool process_request(Stream &strm, const std::string &remote_addr,
  1977. int remote_port, const std::string &local_addr,
  1978. int local_port, bool close_connection,
  1979. bool &connection_closed,
  1980. const std::function<void(Request &)> &setup_request,
  1981. bool *websocket_upgraded = nullptr);
  1982. // Runs the per-connection serving loop and stops an exception thrown by a
  1983. // user callback from escaping the worker thread.
  1984. //
  1985. // process_request() wraps only routing() in a try/catch. Content providers,
  1986. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1987. // handlers all run outside it, and the task queue calls the job without a
  1988. // catch, so an exception from any of those would terminate the process.
  1989. //
  1990. // No 500 is possible here: by the time a content provider runs, the status
  1991. // line and headers are already on the wire. Report it through the error
  1992. // logger and drop the connection, which is what the peer observes either
  1993. // way. Other connections are unaffected.
  1994. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1995. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1996. return serve();
  1997. #else
  1998. try {
  1999. return serve();
  2000. } catch (...) {
  2001. // The error logger is a user callback too, so it must not be able to
  2002. // throw the guard back open.
  2003. try {
  2004. output_error_log(Error::UserCallbackException, nullptr);
  2005. } catch (...) {}
  2006. return false;
  2007. }
  2008. #endif
  2009. }
  2010. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  2011. std::vector<std::string> trusted_proxies_;
  2012. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  2013. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  2014. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  2015. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  2016. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  2017. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  2018. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  2019. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  2020. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2021. bool static_file_compression_ = false;
  2022. size_t static_file_compression_min_length_ =
  2023. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2024. size_t static_file_compression_max_length_ =
  2025. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2026. time_t websocket_ping_interval_sec_ =
  2027. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2028. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2029. private:
  2030. using Handlers =
  2031. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2032. using HandlersForContentReader =
  2033. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2034. HandlerWithContentReader>>;
  2035. // Both handler tables for one custom method live in a single entry, so that
  2036. // routing() needs only one map lookup per request to reach either of them.
  2037. struct CustomHandlerEntry {
  2038. Handlers handlers;
  2039. HandlersForContentReader handlers_for_content_reader;
  2040. };
  2041. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2042. static std::unique_ptr<detail::MatcherBase>
  2043. make_matcher(const std::string &pattern);
  2044. static const std::set<std::string> &builtin_methods();
  2045. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2046. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2047. template <typename H>
  2048. Server &add_handler(
  2049. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2050. const std::string &pattern, H handler) {
  2051. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2052. return *this;
  2053. }
  2054. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2055. Server &set_error_handler_core(Handler handler, std::false_type);
  2056. socket_t create_server_socket(const std::string &host, int port,
  2057. int socket_flags,
  2058. SocketOptions socket_options) const;
  2059. int bind_internal(const std::string &host, int port, int socket_flags);
  2060. bool listen_internal();
  2061. bool routing(Request &req, Response &res, Stream &strm,
  2062. bool skip_pre_routing);
  2063. bool handle_file_request(Request &req, Response &res);
  2064. bool check_if_not_modified(const Request &req, Response &res,
  2065. const std::string &etag, time_t mtime) const;
  2066. bool check_if_range(Request &req, const std::string &etag,
  2067. time_t mtime) const;
  2068. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2069. Stream &strm);
  2070. bool dispatch_request_for_content_reader(
  2071. Request &req, Response &res, ContentReader content_reader,
  2072. const HandlersForContentReader &handlers) const;
  2073. bool parse_request_line(const char *s, Request &req) const;
  2074. detail::EncodingType static_file_encoding(const Request &req,
  2075. const Response &res,
  2076. const std::string &content_type,
  2077. size_t length) const;
  2078. bool apply_static_file_compression(const Request &req, Response &res) const;
  2079. void apply_ranges(const Request &req, Response &res,
  2080. std::string &content_type, std::string &boundary) const;
  2081. bool write_response(Stream &strm, bool close_connection, Request &req,
  2082. Response &res);
  2083. bool write_response_with_content(Stream &strm, bool close_connection,
  2084. const Request &req, Response &res);
  2085. bool write_response_core(Stream &strm, bool close_connection,
  2086. const Request &req, Response &res,
  2087. bool need_apply_ranges);
  2088. bool write_content_with_provider(Stream &strm, const Request &req,
  2089. Response &res, const std::string &boundary,
  2090. const std::string &content_type);
  2091. bool read_content(Stream &strm, Request &req, Response &res);
  2092. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2093. Response &res,
  2094. ContentReceiver receiver,
  2095. FormDataHeader multipart_header,
  2096. ContentReceiver multipart_receiver);
  2097. bool read_content_core(Stream &strm, Request &req, Response &res,
  2098. ContentReceiver receiver,
  2099. FormDataHeader multipart_header,
  2100. ContentReceiver multipart_receiver) const;
  2101. virtual bool process_and_close_socket(socket_t sock);
  2102. void output_log(const Request &req, const Response &res) const;
  2103. void output_pre_compression_log(const Request &req,
  2104. const Response &res) const;
  2105. void output_error_log(const Error &err, const Request *req) const;
  2106. std::atomic<bool> is_running_{false};
  2107. std::atomic<bool> is_decommissioned{false};
  2108. // Set when CustomRoute() refuses a registration. Written before listen(),
  2109. // read by is_valid() on the same thread, so it needs no synchronization.
  2110. bool has_invalid_registration_ = false;
  2111. struct MountPointEntry {
  2112. std::string mount_point;
  2113. std::string base_dir;
  2114. std::string resolved_base_dir;
  2115. Headers headers;
  2116. };
  2117. std::vector<MountPointEntry> base_dirs_;
  2118. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2119. std::string default_file_mimetype_ = "application/octet-stream";
  2120. Handler file_request_handler_;
  2121. Handlers get_handlers_;
  2122. Handlers post_handlers_;
  2123. HandlersForContentReader post_handlers_for_content_reader_;
  2124. Handlers put_handlers_;
  2125. HandlersForContentReader put_handlers_for_content_reader_;
  2126. Handlers patch_handlers_;
  2127. HandlersForContentReader patch_handlers_for_content_reader_;
  2128. Handlers delete_handlers_;
  2129. HandlersForContentReader delete_handlers_for_content_reader_;
  2130. Handlers options_handlers_;
  2131. CustomHandlers custom_handlers_;
  2132. struct WebSocketHandlerEntry {
  2133. std::unique_ptr<detail::MatcherBase> matcher;
  2134. WebSocketHandler handler;
  2135. SubProtocolSelector sub_protocol_selector;
  2136. };
  2137. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2138. WebSocketHandlers websocket_handlers_;
  2139. HandlerWithResponse error_handler_;
  2140. ExceptionHandler exception_handler_;
  2141. HandlerWithResponse pre_routing_handler_;
  2142. Handler post_routing_handler_;
  2143. HandlerWithResponse pre_request_handler_;
  2144. Expect100ContinueHandler expect_100_continue_handler_;
  2145. StartHandler start_handler_;
  2146. mutable std::mutex logger_mutex_;
  2147. Logger logger_;
  2148. Logger pre_compression_logger_;
  2149. ErrorLogger error_logger_;
  2150. int address_family_ = AF_UNSPEC;
  2151. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2152. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2153. SocketOptions socket_options_ = default_socket_options;
  2154. Headers default_headers_;
  2155. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2156. detail::write_headers;
  2157. };
  2158. class Result {
  2159. public:
  2160. Result() = default;
  2161. Result(std::unique_ptr<Response> &&res, Error err,
  2162. Headers &&request_headers = Headers{})
  2163. : res_(std::move(res)), err_(err),
  2164. request_headers_(std::move(request_headers)) {}
  2165. // Response
  2166. operator bool() const { return res_ != nullptr; }
  2167. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2168. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2169. const Response &value() const { return *res_; }
  2170. Response &value() { return *res_; }
  2171. const Response &operator*() const { return *res_; }
  2172. Response &operator*() { return *res_; }
  2173. const Response *operator->() const { return res_.get(); }
  2174. Response *operator->() { return res_.get(); }
  2175. // Error
  2176. Error error() const { return err_; }
  2177. // Request Headers
  2178. bool has_request_header(const std::string &key) const;
  2179. std::string get_request_header_value(const std::string &key,
  2180. const char *def = "",
  2181. size_t id = 0) const;
  2182. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2183. size_t id = 0) const;
  2184. size_t get_request_header_value_count(const std::string &key) const;
  2185. private:
  2186. std::unique_ptr<Response> res_;
  2187. Error err_ = Error::Unknown;
  2188. Headers request_headers_;
  2189. #ifdef CPPHTTPLIB_SSL_ENABLED
  2190. public:
  2191. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2192. int ssl_error)
  2193. : res_(std::move(res)), err_(err),
  2194. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2195. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2196. int ssl_error, uint64_t ssl_backend_error)
  2197. : res_(std::move(res)), err_(err),
  2198. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2199. ssl_backend_error_(ssl_backend_error) {}
  2200. int ssl_error() const { return ssl_error_; }
  2201. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2202. private:
  2203. int ssl_error_ = 0;
  2204. uint64_t ssl_backend_error_ = 0;
  2205. #endif
  2206. };
  2207. struct ClientConnection {
  2208. socket_t sock = INVALID_SOCKET;
  2209. bool is_open() const { return sock != INVALID_SOCKET; }
  2210. ClientConnection() = default;
  2211. ~ClientConnection();
  2212. ClientConnection(const ClientConnection &) = delete;
  2213. ClientConnection &operator=(const ClientConnection &) = delete;
  2214. ClientConnection(ClientConnection &&other) noexcept
  2215. : sock(other.sock)
  2216. #ifdef CPPHTTPLIB_SSL_ENABLED
  2217. ,
  2218. session(other.session)
  2219. #endif
  2220. {
  2221. other.sock = INVALID_SOCKET;
  2222. #ifdef CPPHTTPLIB_SSL_ENABLED
  2223. other.session = nullptr;
  2224. #endif
  2225. }
  2226. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2227. if (this != &other) {
  2228. sock = other.sock;
  2229. other.sock = INVALID_SOCKET;
  2230. #ifdef CPPHTTPLIB_SSL_ENABLED
  2231. session = other.session;
  2232. other.session = nullptr;
  2233. #endif
  2234. }
  2235. return *this;
  2236. }
  2237. #ifdef CPPHTTPLIB_SSL_ENABLED
  2238. tls::session_t session = nullptr;
  2239. #endif
  2240. };
  2241. namespace detail {
  2242. struct ChunkedDecoder;
  2243. struct BodyReader {
  2244. Stream *stream = nullptr;
  2245. bool has_content_length = false;
  2246. size_t content_length = 0;
  2247. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2248. size_t bytes_read = 0;
  2249. bool chunked = false;
  2250. bool eof = false;
  2251. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2252. Error last_error = Error::Success;
  2253. ssize_t read(char *buf, size_t len);
  2254. bool has_error() const { return last_error != Error::Success; }
  2255. };
  2256. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2257. size_t len) {
  2258. (void)stream;
  2259. return br.read(buf, len);
  2260. }
  2261. class decompressor;
  2262. enum class NoProxyKind {
  2263. Wildcard, // "*"
  2264. HostnameSuffix, // "example.com" or ".example.com"
  2265. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2266. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2267. };
  2268. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2269. // Lets one CIDR matcher cover both families.
  2270. using IPBytes = std::array<uint8_t, 16>;
  2271. struct NoProxyEntry {
  2272. NoProxyKind kind = NoProxyKind::Wildcard;
  2273. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2274. IPBytes net{};
  2275. int prefix_bits = 0;
  2276. };
  2277. struct NormalizedTarget {
  2278. std::string hostname; // lowercase; brackets and trailing dot removed
  2279. bool is_ipv4 = false;
  2280. bool is_ipv6 = false;
  2281. IPBytes ip{};
  2282. };
  2283. } // namespace detail
  2284. class ClientImpl {
  2285. public:
  2286. explicit ClientImpl(const std::string &host);
  2287. explicit ClientImpl(const std::string &host, int port);
  2288. explicit ClientImpl(const std::string &host, int port,
  2289. const std::string &client_cert_path,
  2290. const std::string &client_key_path);
  2291. virtual ~ClientImpl();
  2292. virtual bool is_valid() const;
  2293. struct StreamHandle {
  2294. std::unique_ptr<Response> response;
  2295. Error error = Error::Success;
  2296. StreamHandle() = default;
  2297. StreamHandle(const StreamHandle &) = delete;
  2298. StreamHandle &operator=(const StreamHandle &) = delete;
  2299. StreamHandle(StreamHandle &&) = default;
  2300. StreamHandle &operator=(StreamHandle &&) = default;
  2301. ~StreamHandle() = default;
  2302. bool is_valid() const {
  2303. return response != nullptr && error == Error::Success;
  2304. }
  2305. ssize_t read(char *buf, size_t len);
  2306. void parse_trailers_if_needed();
  2307. Error get_read_error() const { return body_reader_.last_error; }
  2308. bool has_read_error() const { return body_reader_.has_error(); }
  2309. bool trailers_parsed_ = false;
  2310. private:
  2311. friend class ClientImpl;
  2312. friend class sse::SSEClient;
  2313. ssize_t read_with_decompression(char *buf, size_t len);
  2314. std::unique_ptr<ClientConnection> connection_;
  2315. std::unique_ptr<Stream> socket_stream_;
  2316. Stream *stream_ = nullptr;
  2317. detail::BodyReader body_reader_;
  2318. std::unique_ptr<detail::decompressor> decompressor_;
  2319. std::string decompress_buffer_;
  2320. size_t decompress_offset_ = 0;
  2321. size_t decompressed_bytes_read_ = 0;
  2322. };
  2323. // clang-format off
  2324. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2325. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2326. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2327. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2328. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2329. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2330. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2331. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2332. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2333. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2334. Result Head(const std::string &path);
  2335. Result Head(const std::string &path, const Headers &headers);
  2336. Result Post(const std::string &path);
  2337. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2338. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2339. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2340. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2341. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2343. Result Post(const std::string &path, const Params &params);
  2344. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2345. Result Post(const std::string &path, const Headers &headers);
  2346. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2347. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2348. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2349. 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);
  2350. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2351. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2352. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2353. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2354. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2355. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2356. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2357. Result Put(const std::string &path);
  2358. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2359. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2360. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2361. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2362. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2363. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2364. Result Put(const std::string &path, const Params &params);
  2365. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2366. Result Put(const std::string &path, const Headers &headers);
  2367. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2368. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2369. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2370. 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);
  2371. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2372. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2373. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2374. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2375. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2376. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2377. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2378. Result Patch(const std::string &path);
  2379. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2380. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2381. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2382. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2383. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2384. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2385. Result Patch(const std::string &path, const Params &params);
  2386. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2387. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2388. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2389. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2390. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2391. 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);
  2392. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2393. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2394. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2395. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2396. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2397. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2398. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2399. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2400. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2401. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2402. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2403. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2404. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2405. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2406. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2407. Result Options(const std::string &path);
  2408. Result Options(const std::string &path, const Headers &headers);
  2409. // clang-format on
  2410. // Streaming API: Open a stream for reading response body incrementally
  2411. // Socket ownership is transferred to StreamHandle for true streaming
  2412. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2413. StreamHandle open_stream(const std::string &method, const std::string &path,
  2414. const Params &params = {},
  2415. const Headers &headers = {},
  2416. const std::string &body = {},
  2417. const std::string &content_type = {});
  2418. bool send(Request &req, Response &res, Error &error);
  2419. Result send(const Request &req);
  2420. void stop();
  2421. std::string host() const;
  2422. int port() const;
  2423. size_t is_socket_open() const;
  2424. socket_t socket() const;
  2425. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2426. void set_default_headers(Headers headers);
  2427. void
  2428. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2429. void set_address_family(int family);
  2430. void set_tcp_nodelay(bool on);
  2431. void set_ipv6_v6only(bool on);
  2432. void set_socket_options(SocketOptions socket_options);
  2433. void set_connection_timeout(time_t sec, time_t usec = 0);
  2434. template <class Rep, class Period>
  2435. void
  2436. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2437. void set_read_timeout(time_t sec, time_t usec = 0);
  2438. template <class Rep, class Period>
  2439. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2440. void set_write_timeout(time_t sec, time_t usec = 0);
  2441. template <class Rep, class Period>
  2442. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2443. void set_max_timeout(time_t msec);
  2444. template <class Rep, class Period>
  2445. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2446. void set_basic_auth(const std::string &username, const std::string &password);
  2447. void set_bearer_token_auth(const std::string &token);
  2448. void set_keep_alive(bool on);
  2449. void set_follow_location(bool on);
  2450. void set_path_encode(bool on);
  2451. void set_compress(bool on);
  2452. void set_decompress(bool on);
  2453. void set_payload_max_length(size_t length);
  2454. void set_interface(const std::string &intf);
  2455. void set_proxy(const std::string &host, int port);
  2456. void set_proxy_basic_auth(const std::string &username,
  2457. const std::string &password);
  2458. void set_proxy_bearer_token_auth(const std::string &token);
  2459. void set_no_proxy(const std::vector<std::string> &patterns);
  2460. void set_logger(Logger logger);
  2461. void set_error_logger(ErrorLogger error_logger);
  2462. protected:
  2463. struct Socket {
  2464. socket_t sock = INVALID_SOCKET;
  2465. // For Mbed TLS compatibility: start_time for request timeout tracking
  2466. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2467. bool is_open() const { return sock != INVALID_SOCKET; }
  2468. #ifdef CPPHTTPLIB_SSL_ENABLED
  2469. tls::session_t ssl = nullptr;
  2470. #endif
  2471. };
  2472. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2473. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2474. virtual bool setup_proxy_connection(
  2475. Socket &socket,
  2476. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2477. Response &res, bool &success, Error &error);
  2478. bool is_proxy_enabled_for_host(const std::string &host) const;
  2479. // All of:
  2480. // shutdown_ssl
  2481. // shutdown_socket
  2482. // close_socket
  2483. // disconnect
  2484. // should ONLY be called when socket_mutex_ is locked, and only when
  2485. // no other thread is using the socket.
  2486. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2487. void shutdown_socket(Socket &socket) const;
  2488. void close_socket(Socket &socket);
  2489. void disconnect(bool gracefully);
  2490. std::string make_request_target(const Request &req) const;
  2491. bool process_request(Stream &strm, Request &req, Response &res,
  2492. bool close_connection, Error &error);
  2493. bool write_content_with_provider(Stream &strm, const Request &req,
  2494. Error &error) const;
  2495. void output_log(const Request &req, const Response &res) const;
  2496. void output_error_log(const Error &err, const Request *req) const;
  2497. // Socket endpoint information
  2498. const std::string host_;
  2499. const int port_;
  2500. // Current open socket
  2501. Socket socket_;
  2502. mutable std::mutex socket_mutex_;
  2503. std::recursive_mutex request_mutex_;
  2504. // These are all protected under socket_mutex
  2505. size_t socket_requests_in_flight_ = 0;
  2506. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2507. bool socket_should_be_closed_when_request_is_done_ = false;
  2508. // Hostname to connection target map. The value is an IP literal or another
  2509. // hostname; only the connection target changes, never the identity.
  2510. std::map<std::string, std::string> addr_map_;
  2511. // Default headers
  2512. Headers default_headers_;
  2513. // Header writer
  2514. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2515. detail::write_headers;
  2516. // Settings
  2517. std::string client_cert_path_;
  2518. std::string client_key_path_;
  2519. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2520. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2521. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2522. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2523. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2524. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2525. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2526. std::string basic_auth_username_;
  2527. std::string basic_auth_password_;
  2528. std::string bearer_token_auth_token_;
  2529. bool keep_alive_ = false;
  2530. bool follow_location_ = false;
  2531. bool path_encode_ = true;
  2532. int address_family_ = AF_UNSPEC;
  2533. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2534. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2535. SocketOptions socket_options_ = nullptr;
  2536. bool compress_ = false;
  2537. bool decompress_ = true;
  2538. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2539. bool has_payload_max_length_ = false;
  2540. std::string interface_;
  2541. std::string proxy_host_;
  2542. int proxy_port_ = -1;
  2543. std::string proxy_basic_auth_username_;
  2544. std::string proxy_basic_auth_password_;
  2545. std::string proxy_bearer_token_auth_token_;
  2546. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2547. mutable detail::NormalizedTarget host_normalized_;
  2548. mutable bool host_normalized_valid_ = false;
  2549. mutable std::mutex logger_mutex_;
  2550. Logger logger_;
  2551. ErrorLogger error_logger_;
  2552. private:
  2553. bool send_(Request &req, Response &res, Error &error);
  2554. Result send_(Request &&req);
  2555. socket_t create_client_socket(Error &error) const;
  2556. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2557. bool skip_100_continue = true) const;
  2558. bool write_request(Stream &strm, Request &req, bool close_connection,
  2559. Error &error, bool skip_body, bool &rejected_locally);
  2560. bool write_request_body(Stream &strm, Request &req, Error &error);
  2561. void prepare_default_headers(Request &r, bool for_stream,
  2562. const std::string &ct);
  2563. bool redirect(Request &req, Response &res, Error &error);
  2564. bool create_redirect_client(const std::string &scheme,
  2565. const std::string &host, int port, Request &req,
  2566. Response &res, const std::string &path,
  2567. const std::string &location, Error &error);
  2568. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2569. bool handle_request(Stream &strm, Request &req, Response &res,
  2570. bool close_connection, Error &error);
  2571. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2572. Request &req, const char *body, size_t content_length,
  2573. ContentProvider content_provider,
  2574. ContentProviderWithoutLength content_provider_without_length,
  2575. const std::string &content_type, ContentReceiver content_receiver,
  2576. Error &error);
  2577. Result send_with_content_provider_and_receiver(
  2578. const std::string &method, const std::string &path,
  2579. const Headers &headers, const char *body, size_t content_length,
  2580. ContentProvider content_provider,
  2581. ContentProviderWithoutLength content_provider_without_length,
  2582. const std::string &content_type, ContentReceiver content_receiver,
  2583. UploadProgress progress);
  2584. ContentProviderWithoutLength get_multipart_content_provider(
  2585. const std::string &boundary, const UploadFormDataItems &items,
  2586. const FormDataProviderItems &provider_items) const;
  2587. virtual bool
  2588. process_socket(const Socket &socket,
  2589. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2590. std::function<bool(Stream &strm)> callback);
  2591. virtual bool is_ssl() const;
  2592. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2593. #ifdef CPPHTTPLIB_SSL_ENABLED
  2594. public:
  2595. void set_digest_auth(const std::string &username,
  2596. const std::string &password);
  2597. void set_proxy_digest_auth(const std::string &username,
  2598. const std::string &password);
  2599. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2600. const std::string &ca_cert_dir_path = std::string());
  2601. void enable_server_certificate_verification(bool enabled);
  2602. void enable_server_hostname_verification(bool enabled);
  2603. void enable_system_ca(bool enabled);
  2604. protected:
  2605. std::string digest_auth_username_;
  2606. std::string digest_auth_password_;
  2607. std::string proxy_digest_auth_username_;
  2608. std::string proxy_digest_auth_password_;
  2609. std::string ca_cert_file_path_;
  2610. std::string ca_cert_dir_path_;
  2611. bool server_certificate_verification_ = true;
  2612. bool server_hostname_verification_ = true;
  2613. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2614. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2615. int last_ssl_error_ = 0;
  2616. uint64_t last_backend_error_ = 0;
  2617. #endif
  2618. };
  2619. namespace detail {
  2620. // Stands in for a client that Client could not make from its arguments, so a
  2621. // request fails rather than going through a null pointer.
  2622. class InvalidClientImpl final : public ClientImpl {
  2623. public:
  2624. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2625. bool is_valid() const override { return false; }
  2626. private:
  2627. bool create_and_connect_socket(Socket &, Error &error) override {
  2628. error = Error::Connection;
  2629. return false;
  2630. }
  2631. };
  2632. } // namespace detail
  2633. class Client {
  2634. public:
  2635. // Universal interface
  2636. explicit Client(const std::string &scheme_host_port);
  2637. explicit Client(const std::string &scheme_host_port,
  2638. const std::string &client_cert_path,
  2639. const std::string &client_key_path);
  2640. // HTTP only interface
  2641. explicit Client(const std::string &host, int port);
  2642. explicit Client(const std::string &host, int port,
  2643. const std::string &client_cert_path,
  2644. const std::string &client_key_path);
  2645. Client(Client &&) = default;
  2646. Client &operator=(Client &&) = default;
  2647. ~Client();
  2648. bool is_valid() const;
  2649. // clang-format off
  2650. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2651. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2652. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2653. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2654. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2655. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2656. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2657. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2658. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2659. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2660. Result Head(const std::string &path);
  2661. Result Head(const std::string &path, const Headers &headers);
  2662. Result Post(const std::string &path);
  2663. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2664. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2665. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2666. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2667. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2668. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2669. Result Post(const std::string &path, const Params &params);
  2670. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2671. Result Post(const std::string &path, const Headers &headers);
  2672. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2673. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2674. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2675. 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);
  2676. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2677. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2678. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2679. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2680. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2681. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2682. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2683. Result Put(const std::string &path);
  2684. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2685. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2686. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2687. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2688. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2689. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2690. Result Put(const std::string &path, const Params &params);
  2691. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2692. Result Put(const std::string &path, const Headers &headers);
  2693. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2694. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2695. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2696. 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);
  2697. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2698. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2699. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2700. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2701. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2702. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2703. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2704. Result Patch(const std::string &path);
  2705. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2706. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2707. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2708. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2709. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2710. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2711. Result Patch(const std::string &path, const Params &params);
  2712. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2713. Result Patch(const std::string &path, const Headers &headers);
  2714. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2715. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2716. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2717. 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);
  2718. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2719. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2720. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2721. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2722. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2723. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2724. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2725. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2726. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2727. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2728. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2729. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2730. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2731. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2732. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2733. Result Options(const std::string &path);
  2734. Result Options(const std::string &path, const Headers &headers);
  2735. // clang-format on
  2736. // Streaming API: Open a stream for reading response body incrementally
  2737. // Socket ownership is transferred to StreamHandle for true streaming
  2738. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2739. ClientImpl::StreamHandle open_stream(const std::string &method,
  2740. const std::string &path,
  2741. const Params &params = {},
  2742. const Headers &headers = {},
  2743. const std::string &body = {},
  2744. const std::string &content_type = {});
  2745. bool send(Request &req, Response &res, Error &error);
  2746. Result send(const Request &req);
  2747. void stop();
  2748. std::string host() const;
  2749. int port() const;
  2750. size_t is_socket_open() const;
  2751. socket_t socket() const;
  2752. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2753. void set_default_headers(Headers headers);
  2754. void
  2755. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2756. void set_address_family(int family);
  2757. void set_tcp_nodelay(bool on);
  2758. void set_socket_options(SocketOptions socket_options);
  2759. void set_connection_timeout(time_t sec, time_t usec = 0);
  2760. template <class Rep, class Period>
  2761. void
  2762. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2763. void set_read_timeout(time_t sec, time_t usec = 0);
  2764. template <class Rep, class Period>
  2765. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2766. void set_write_timeout(time_t sec, time_t usec = 0);
  2767. template <class Rep, class Period>
  2768. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2769. void set_max_timeout(time_t msec);
  2770. template <class Rep, class Period>
  2771. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2772. void set_basic_auth(const std::string &username, const std::string &password);
  2773. void set_bearer_token_auth(const std::string &token);
  2774. void set_keep_alive(bool on);
  2775. void set_follow_location(bool on);
  2776. void set_path_encode(bool on);
  2777. void set_compress(bool on);
  2778. void set_decompress(bool on);
  2779. void set_payload_max_length(size_t length);
  2780. void set_interface(const std::string &intf);
  2781. void set_proxy(const std::string &host, int port);
  2782. void set_proxy_basic_auth(const std::string &username,
  2783. const std::string &password);
  2784. void set_proxy_bearer_token_auth(const std::string &token);
  2785. void set_no_proxy(const std::vector<std::string> &patterns);
  2786. void set_logger(Logger logger);
  2787. void set_error_logger(ErrorLogger error_logger);
  2788. private:
  2789. std::unique_ptr<ClientImpl> cli_;
  2790. #ifdef CPPHTTPLIB_SSL_ENABLED
  2791. public:
  2792. void set_digest_auth(const std::string &username,
  2793. const std::string &password);
  2794. void set_proxy_digest_auth(const std::string &username,
  2795. const std::string &password);
  2796. void enable_server_certificate_verification(bool enabled);
  2797. void enable_server_hostname_verification(bool enabled);
  2798. void enable_system_ca(bool enabled);
  2799. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2800. const std::string &ca_cert_dir_path = std::string());
  2801. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2802. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2803. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2804. void set_session_verifier(
  2805. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2806. tls::ctx_t tls_context() const;
  2807. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2808. void enable_windows_certificate_verification(bool enabled);
  2809. #endif
  2810. private:
  2811. bool is_ssl_ = false;
  2812. #endif
  2813. };
  2814. #ifdef CPPHTTPLIB_SSL_ENABLED
  2815. class SSLServer : public Server {
  2816. public:
  2817. SSLServer(const char *cert_path, const char *private_key_path,
  2818. const char *client_ca_cert_file_path = nullptr,
  2819. const char *client_ca_cert_dir_path = nullptr,
  2820. const char *private_key_password = nullptr);
  2821. struct PemMemory {
  2822. const char *cert_pem;
  2823. size_t cert_pem_len;
  2824. const char *key_pem;
  2825. size_t key_pem_len;
  2826. const char *client_ca_pem;
  2827. size_t client_ca_pem_len;
  2828. const char *private_key_password;
  2829. };
  2830. explicit SSLServer(const PemMemory &pem);
  2831. // The callback receives the ctx_t handle which can be cast to the
  2832. // appropriate backend type (SSL_CTX* for OpenSSL,
  2833. // tls::impl::MbedTlsContext* for Mbed TLS)
  2834. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2835. ~SSLServer() override;
  2836. bool is_valid() const override;
  2837. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2838. const char *client_ca_pem = nullptr,
  2839. const char *password = nullptr);
  2840. tls::ctx_t tls_context() const { return ctx_; }
  2841. int ssl_last_error() const { return last_ssl_error_; }
  2842. private:
  2843. bool process_and_close_socket(socket_t sock) override;
  2844. tls::ctx_t ctx_ = nullptr;
  2845. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2846. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2847. // bounds, and new ones wait while it is pending so that they cannot keep it
  2848. // waiting.
  2849. std::mutex ctx_mutex_;
  2850. std::condition_variable ctx_cv_;
  2851. size_t handshakes_in_progress_ = 0;
  2852. size_t updates_pending_ = 0;
  2853. int last_ssl_error_ = 0;
  2854. };
  2855. class SSLClient final : public ClientImpl {
  2856. public:
  2857. explicit SSLClient(const std::string &host);
  2858. explicit SSLClient(const std::string &host, int port);
  2859. explicit SSLClient(const std::string &host, int port,
  2860. const std::string &client_cert_path,
  2861. const std::string &client_key_path,
  2862. const std::string &private_key_password = std::string());
  2863. struct PemMemory {
  2864. const char *cert_pem;
  2865. size_t cert_pem_len;
  2866. const char *key_pem;
  2867. size_t key_pem_len;
  2868. const char *private_key_password;
  2869. };
  2870. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2871. ~SSLClient() override;
  2872. bool is_valid() const override;
  2873. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2874. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2875. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2876. // Post-handshake session verifier (backend-independent)
  2877. void set_session_verifier(
  2878. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2879. tls::ctx_t tls_context() const { return ctx_; }
  2880. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2881. void enable_windows_certificate_verification(bool enabled);
  2882. #endif
  2883. private:
  2884. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2885. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2886. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2887. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2888. bool
  2889. process_socket(const Socket &socket,
  2890. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2891. std::function<bool(Stream &strm)> callback) override;
  2892. bool is_ssl() const override;
  2893. bool setup_proxy_connection(
  2894. Socket &socket,
  2895. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2896. Response &res, bool &success, Error &error) override;
  2897. bool connect_with_proxy(
  2898. Socket &sock,
  2899. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2900. Response &res, bool &success, Error &error);
  2901. bool initialize_ssl(Socket &socket, Error &error);
  2902. void init_ctx();
  2903. void reset_ctx_on_error();
  2904. bool load_certs();
  2905. tls::ctx_t ctx_ = nullptr;
  2906. std::mutex ctx_mutex_;
  2907. std::once_flag initialize_cert_;
  2908. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2909. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2910. // Used to keep custom CA configuration exclusive with system CA loading.
  2911. bool ca_cert_store_set_ = false;
  2912. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2913. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2914. // set_server_certificate_verifier() installed there.
  2915. tls::VerifyCallback server_certificate_verifier_;
  2916. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2917. bool enable_windows_cert_verification_ = true;
  2918. #endif
  2919. friend class ClientImpl;
  2920. };
  2921. #endif // CPPHTTPLIB_SSL_ENABLED
  2922. namespace detail {
  2923. template <typename T, typename U>
  2924. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2925. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2926. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2927. duration - std::chrono::seconds(sec))
  2928. .count();
  2929. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2930. }
  2931. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2932. return N - 1;
  2933. }
  2934. inline bool is_numeric(const std::string &str) {
  2935. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2936. }
  2937. // std::ranges::next(first, n, last) for C++11
  2938. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2939. for (; n > 0 && first != last; --n) {
  2940. ++first;
  2941. }
  2942. return first;
  2943. }
  2944. inline size_t get_header_value_u64(const Headers &headers,
  2945. const std::string &key, size_t def,
  2946. size_t id, bool &is_invalid_value) {
  2947. is_invalid_value = false;
  2948. auto rng = headers.equal_range(key);
  2949. auto it = bounded_next(rng.first, id, rng.second);
  2950. if (it != rng.second) {
  2951. if (is_numeric(it->second)) {
  2952. // Parse at size_t width so an out-of-range Content-Length is reported
  2953. // rather than silently saturated/truncated (a value above 2^32 would
  2954. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2955. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2956. size_t val = 0;
  2957. const auto &s = it->second;
  2958. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2959. if (r.ec == std::errc::result_out_of_range) {
  2960. is_invalid_value = true;
  2961. return (std::numeric_limits<size_t>::max)();
  2962. }
  2963. return val;
  2964. } else {
  2965. is_invalid_value = true;
  2966. }
  2967. }
  2968. return def;
  2969. }
  2970. inline size_t get_header_value_u64(const Headers &headers,
  2971. const std::string &key, size_t def,
  2972. size_t id) {
  2973. auto dummy = false;
  2974. return get_header_value_u64(headers, key, def, id, dummy);
  2975. }
  2976. } // namespace detail
  2977. template <class Rep, class Period>
  2978. inline Server &
  2979. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2980. detail::duration_to_sec_and_usec(
  2981. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2982. return *this;
  2983. }
  2984. template <class Rep, class Period>
  2985. inline Server &
  2986. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2987. detail::duration_to_sec_and_usec(
  2988. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2989. return *this;
  2990. }
  2991. template <class Rep, class Period>
  2992. inline Server &
  2993. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2994. detail::duration_to_sec_and_usec(
  2995. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2996. return *this;
  2997. }
  2998. template <class Rep, class Period>
  2999. inline void ClientImpl::set_connection_timeout(
  3000. const std::chrono::duration<Rep, Period> &duration) {
  3001. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3002. set_connection_timeout(sec, usec);
  3003. });
  3004. }
  3005. template <class Rep, class Period>
  3006. inline void ClientImpl::set_read_timeout(
  3007. const std::chrono::duration<Rep, Period> &duration) {
  3008. detail::duration_to_sec_and_usec(
  3009. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3010. }
  3011. template <class Rep, class Period>
  3012. inline void ClientImpl::set_write_timeout(
  3013. const std::chrono::duration<Rep, Period> &duration) {
  3014. detail::duration_to_sec_and_usec(
  3015. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3016. }
  3017. template <class Rep, class Period>
  3018. inline void ClientImpl::set_max_timeout(
  3019. const std::chrono::duration<Rep, Period> &duration) {
  3020. auto msec =
  3021. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3022. set_max_timeout(static_cast<time_t>(msec));
  3023. }
  3024. template <class Rep, class Period>
  3025. inline void Client::set_connection_timeout(
  3026. const std::chrono::duration<Rep, Period> &duration) {
  3027. cli_->set_connection_timeout(duration);
  3028. }
  3029. template <class Rep, class Period>
  3030. inline void
  3031. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3032. cli_->set_read_timeout(duration);
  3033. }
  3034. template <class Rep, class Period>
  3035. inline void
  3036. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3037. cli_->set_write_timeout(duration);
  3038. }
  3039. inline void Client::set_max_timeout(time_t msec) {
  3040. cli_->set_max_timeout(msec);
  3041. }
  3042. template <class Rep, class Period>
  3043. inline void
  3044. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3045. cli_->set_max_timeout(duration);
  3046. }
  3047. /*
  3048. * Forward declarations and types that will be part of the .h file if split into
  3049. * .h + .cc.
  3050. */
  3051. std::string hosted_at(const std::string &hostname);
  3052. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3053. // JavaScript-style URL encoding/decoding functions
  3054. std::string encode_uri_component(const std::string &value);
  3055. std::string encode_uri(const std::string &value);
  3056. std::string decode_uri_component(const std::string &value);
  3057. std::string decode_uri(const std::string &value);
  3058. // RFC 3986 compliant URL component encoding/decoding functions
  3059. std::string encode_path_component(const std::string &component);
  3060. std::string decode_path_component(const std::string &component);
  3061. std::string encode_query_component(const std::string &component,
  3062. bool space_as_plus = true);
  3063. std::string decode_query_component(const std::string &component,
  3064. bool plus_as_space = true);
  3065. std::string sanitize_filename(const std::string &filename);
  3066. std::string append_query_params(const std::string &path, const Params &params);
  3067. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3068. std::pair<std::string, std::string>
  3069. make_basic_authentication_header(const std::string &username,
  3070. const std::string &password,
  3071. bool is_proxy = false);
  3072. namespace detail {
  3073. #if defined(_WIN32)
  3074. inline std::wstring u8string_to_wstring(const char *s) {
  3075. if (!s) { return std::wstring(); }
  3076. auto len = static_cast<int>(strlen(s));
  3077. if (!len) { return std::wstring(); }
  3078. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3079. if (!wlen) { return std::wstring(); }
  3080. std::wstring ws;
  3081. ws.resize(wlen);
  3082. wlen = ::MultiByteToWideChar(
  3083. CP_UTF8, 0, s, len,
  3084. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3085. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3086. return ws;
  3087. }
  3088. #endif
  3089. struct FileStat {
  3090. FileStat(const std::string &path);
  3091. bool is_file() const;
  3092. bool is_dir() const;
  3093. time_t mtime() const;
  3094. size_t size() const;
  3095. private:
  3096. #if defined(_WIN32)
  3097. struct _stat st_;
  3098. #else
  3099. struct stat st_;
  3100. #endif
  3101. int ret_ = -1;
  3102. };
  3103. std::string make_host_and_port_string(const std::string &host, int port,
  3104. bool is_ssl);
  3105. template <typename T>
  3106. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3107. Error &error);
  3108. std::string trim_copy(const std::string &s);
  3109. void divide(
  3110. const char *data, std::size_t size, char d,
  3111. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3112. fn);
  3113. void divide(
  3114. const std::string &str, char d,
  3115. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3116. fn);
  3117. void split(const char *b, const char *e, char d,
  3118. std::function<void(const char *, const char *)> fn);
  3119. void split(const char *b, const char *e, char d, size_t m,
  3120. std::function<void(const char *, const char *)> fn);
  3121. bool split_find(const char *b, const char *e, char d,
  3122. std::function<bool(const char *, const char *)> fn);
  3123. bool has_header_token(const Headers &headers, const std::string &key,
  3124. const std::string &token);
  3125. std::string websocket_accept_key(const std::string &client_key);
  3126. bool is_websocket_upgrade(const Request &req);
  3127. bool process_client_socket(
  3128. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3129. time_t write_timeout_sec, time_t write_timeout_usec,
  3130. time_t max_timeout_msec,
  3131. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3132. std::function<bool(Stream &)> callback);
  3133. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3134. int port, int address_family, bool tcp_nodelay,
  3135. bool ipv6_v6only, SocketOptions socket_options,
  3136. time_t connection_timeout_sec,
  3137. time_t connection_timeout_usec,
  3138. time_t read_timeout_sec, time_t read_timeout_usec,
  3139. time_t write_timeout_sec,
  3140. time_t write_timeout_usec,
  3141. const std::string &intf, Error &error);
  3142. const char *get_header_value(const Headers &headers, const std::string &key,
  3143. const char *def, size_t id);
  3144. std::string get_combined_header_value(const Headers &headers,
  3145. const std::string &key);
  3146. std::string params_to_query_str(const Params &params);
  3147. void parse_query_text(const char *data, std::size_t size, Params &params);
  3148. void parse_query_text(const std::string &s, Params &params);
  3149. bool parse_multipart_boundary(const std::string &content_type,
  3150. std::string &boundary);
  3151. bool parse_range_header(const std::string &s, Ranges &ranges);
  3152. bool parse_accept_header(const std::string &s,
  3153. std::vector<std::string> &content_types);
  3154. void parse_disposition_params(const std::string &s, Params &params);
  3155. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3156. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3157. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3158. EncodingType encoding_type(const Request &req, const Response &res,
  3159. const std::string &content_type);
  3160. EncodingType encoding_type(const Request &req, const Response &res);
  3161. class BufferStream final : public Stream {
  3162. public:
  3163. BufferStream() = default;
  3164. ~BufferStream() override = default;
  3165. bool is_readable() const override;
  3166. bool wait_readable() const override;
  3167. bool wait_writable() const override;
  3168. ssize_t read(char *ptr, size_t size) override;
  3169. ssize_t write(const char *ptr, size_t size) override;
  3170. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3171. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3172. socket_t socket() const override;
  3173. time_t duration() const override;
  3174. const std::string &get_buffer() const;
  3175. private:
  3176. std::string buffer;
  3177. size_t position = 0;
  3178. };
  3179. class compressor {
  3180. public:
  3181. virtual ~compressor() = default;
  3182. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3183. virtual bool compress(const char *data, size_t data_length, bool last,
  3184. Callback callback) = 0;
  3185. };
  3186. class decompressor {
  3187. public:
  3188. virtual ~decompressor() = default;
  3189. virtual bool is_valid() const = 0;
  3190. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3191. virtual bool decompress(const char *data, size_t data_length,
  3192. Callback callback) = 0;
  3193. };
  3194. class nocompressor final : public compressor {
  3195. public:
  3196. ~nocompressor() override = default;
  3197. bool compress(const char *data, size_t data_length, bool /*last*/,
  3198. Callback callback) override;
  3199. };
  3200. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3201. class gzip_compressor final : public compressor {
  3202. public:
  3203. gzip_compressor();
  3204. ~gzip_compressor() override;
  3205. bool compress(const char *data, size_t data_length, bool last,
  3206. Callback callback) override;
  3207. private:
  3208. bool is_valid_ = false;
  3209. z_stream strm_;
  3210. };
  3211. class gzip_decompressor final : public decompressor {
  3212. public:
  3213. gzip_decompressor();
  3214. ~gzip_decompressor() override;
  3215. bool is_valid() const override;
  3216. bool decompress(const char *data, size_t data_length,
  3217. Callback callback) override;
  3218. private:
  3219. bool is_valid_ = false;
  3220. z_stream strm_;
  3221. };
  3222. #endif
  3223. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3224. class brotli_compressor final : public compressor {
  3225. public:
  3226. brotli_compressor();
  3227. ~brotli_compressor();
  3228. bool compress(const char *data, size_t data_length, bool last,
  3229. Callback callback) override;
  3230. private:
  3231. BrotliEncoderState *state_ = nullptr;
  3232. };
  3233. class brotli_decompressor final : public decompressor {
  3234. public:
  3235. brotli_decompressor();
  3236. ~brotli_decompressor();
  3237. bool is_valid() const override;
  3238. bool decompress(const char *data, size_t data_length,
  3239. Callback callback) override;
  3240. private:
  3241. BrotliDecoderResult decoder_r;
  3242. BrotliDecoderState *decoder_s = nullptr;
  3243. };
  3244. #endif
  3245. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3246. class zstd_compressor : public compressor {
  3247. public:
  3248. zstd_compressor();
  3249. ~zstd_compressor();
  3250. bool compress(const char *data, size_t data_length, bool last,
  3251. Callback callback) override;
  3252. private:
  3253. ZSTD_CCtx *ctx_ = nullptr;
  3254. };
  3255. class zstd_decompressor : public decompressor {
  3256. public:
  3257. zstd_decompressor();
  3258. ~zstd_decompressor();
  3259. bool is_valid() const override;
  3260. bool decompress(const char *data, size_t data_length,
  3261. Callback callback) override;
  3262. private:
  3263. ZSTD_DCtx *ctx_ = nullptr;
  3264. };
  3265. #endif
  3266. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3267. // to store data. The call can set memory on stack for performance.
  3268. class stream_line_reader {
  3269. public:
  3270. stream_line_reader(Stream &strm, char *fixed_buffer,
  3271. size_t fixed_buffer_size);
  3272. const char *ptr() const;
  3273. size_t size() const;
  3274. bool end_with_crlf() const;
  3275. bool getline();
  3276. private:
  3277. void append(char c);
  3278. void append(const char *data, size_t size);
  3279. Stream &strm_;
  3280. char *fixed_buffer_;
  3281. const size_t fixed_buffer_size_;
  3282. size_t fixed_buffer_used_size_ = 0;
  3283. std::string growable_buffer_;
  3284. };
  3285. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3286. const Headers &src_headers);
  3287. struct ChunkedDecoder {
  3288. Stream &strm;
  3289. size_t chunk_remaining = 0;
  3290. bool finished = false;
  3291. char line_buf[64];
  3292. size_t last_chunk_total = 0;
  3293. size_t last_chunk_offset = 0;
  3294. explicit ChunkedDecoder(Stream &s);
  3295. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3296. size_t &out_chunk_total);
  3297. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3298. };
  3299. // A regular file opened to be served: mapped on Windows, read with pread()
  3300. // elsewhere.
  3301. class mmap {
  3302. public:
  3303. mmap(const char *path);
  3304. ~mmap();
  3305. bool open(const char *path);
  3306. void close();
  3307. bool is_open() const;
  3308. size_t size() const;
  3309. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3310. // down to 0, if the file has shrunk since it was opened.
  3311. size_t read(size_t offset, char *buf, size_t len) const;
  3312. private:
  3313. #if defined(_WIN32)
  3314. HANDLE hFile_ = NULL;
  3315. HANDLE hMapping_ = NULL;
  3316. void *addr_ = nullptr;
  3317. bool is_open_empty_file = false;
  3318. #else
  3319. int fd_ = -1;
  3320. #endif
  3321. size_t size_ = 0;
  3322. };
  3323. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3324. namespace fields {
  3325. bool is_token_char(char c);
  3326. bool is_token(const std::string &s);
  3327. bool is_field_name(const std::string &s);
  3328. bool is_vchar(char c);
  3329. bool is_obs_text(char c);
  3330. bool is_field_vchar(char c);
  3331. bool is_field_content(const std::string &s);
  3332. bool is_field_value(const std::string &s);
  3333. bool is_field_valid(const std::string &name, const std::string &value);
  3334. bool is_request_target(const std::string &s);
  3335. bool is_host(const std::string &s);
  3336. } // namespace fields
  3337. } // namespace detail
  3338. /*
  3339. * TLS Abstraction Layer Declarations
  3340. */
  3341. #ifdef CPPHTTPLIB_SSL_ENABLED
  3342. // TLS abstraction layer - backend-specific type declarations
  3343. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3344. namespace tls {
  3345. namespace impl {
  3346. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3347. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3348. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3349. struct MbedTlsContext {
  3350. mbedtls_ssl_config conf;
  3351. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3352. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3353. mbedtls_entropy_context entropy;
  3354. mbedtls_ctr_drbg_context ctr_drbg;
  3355. #endif
  3356. mbedtls_x509_crt ca_chain;
  3357. mbedtls_x509_crt own_cert;
  3358. mbedtls_pk_context own_key;
  3359. bool is_server = false;
  3360. // Peer certificate required (set_verify_client()); a client defaults to true
  3361. bool verify_client = false;
  3362. // Set by tls::set_verify_callback().
  3363. VerifyCallback verify_callback;
  3364. MbedTlsContext();
  3365. ~MbedTlsContext();
  3366. MbedTlsContext(const MbedTlsContext &) = delete;
  3367. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3368. };
  3369. } // namespace impl
  3370. } // namespace tls
  3371. #endif
  3372. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3373. namespace tls {
  3374. namespace impl {
  3375. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3376. // This struct is accessible via tls::impl for use in SSL context
  3377. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3378. struct WolfSSLContext {
  3379. WOLFSSL_CTX *ctx = nullptr;
  3380. bool is_server = false;
  3381. // Peer certificate required (set_verify_client()); a client defaults to true
  3382. bool verify_client = false;
  3383. // Replaced under verify_callback_mutex()
  3384. std::shared_ptr<VerifyCallback> verify_callback;
  3385. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3386. WolfSSLContext();
  3387. ~WolfSSLContext();
  3388. WolfSSLContext(const WolfSSLContext &) = delete;
  3389. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3390. };
  3391. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3392. struct WolfSSLCAStore {
  3393. std::string pem_data;
  3394. };
  3395. } // namespace impl
  3396. } // namespace tls
  3397. #endif
  3398. #endif // CPPHTTPLIB_SSL_ENABLED
  3399. namespace stream {
  3400. class Result {
  3401. public:
  3402. Result();
  3403. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3404. Result(Result &&other) noexcept;
  3405. Result &operator=(Result &&other) noexcept;
  3406. Result(const Result &) = delete;
  3407. Result &operator=(const Result &) = delete;
  3408. // Response info
  3409. bool is_valid() const;
  3410. explicit operator bool() const;
  3411. int status() const;
  3412. const Headers &headers() const;
  3413. std::string get_header_value(const std::string &key,
  3414. const char *def = "") const;
  3415. bool has_header(const std::string &key) const;
  3416. Error error() const;
  3417. Error read_error() const;
  3418. bool has_read_error() const;
  3419. // Stream reading
  3420. bool next();
  3421. const char *data() const;
  3422. size_t size() const;
  3423. std::string read_all();
  3424. private:
  3425. ClientImpl::StreamHandle handle_;
  3426. std::string buffer_;
  3427. size_t current_size_ = 0;
  3428. size_t chunk_size_;
  3429. bool finished_ = false;
  3430. };
  3431. // GET
  3432. template <typename ClientType>
  3433. inline Result Get(ClientType &cli, const std::string &path,
  3434. size_t chunk_size = 8192) {
  3435. return Result{cli.open_stream("GET", path), chunk_size};
  3436. }
  3437. template <typename ClientType>
  3438. inline Result Get(ClientType &cli, const std::string &path,
  3439. const Headers &headers, size_t chunk_size = 8192) {
  3440. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3441. }
  3442. template <typename ClientType>
  3443. inline Result Get(ClientType &cli, const std::string &path,
  3444. const Params &params, size_t chunk_size = 8192) {
  3445. return Result{cli.open_stream("GET", path, params), chunk_size};
  3446. }
  3447. template <typename ClientType>
  3448. inline Result Get(ClientType &cli, const std::string &path,
  3449. const Params &params, const Headers &headers,
  3450. size_t chunk_size = 8192) {
  3451. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3452. }
  3453. // POST
  3454. template <typename ClientType>
  3455. inline Result Post(ClientType &cli, const std::string &path,
  3456. const std::string &body, const std::string &content_type,
  3457. size_t chunk_size = 8192) {
  3458. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3459. chunk_size};
  3460. }
  3461. template <typename ClientType>
  3462. inline Result Post(ClientType &cli, const std::string &path,
  3463. const Headers &headers, const std::string &body,
  3464. const std::string &content_type, size_t chunk_size = 8192) {
  3465. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3466. chunk_size};
  3467. }
  3468. template <typename ClientType>
  3469. inline Result Post(ClientType &cli, const std::string &path,
  3470. const Params &params, const std::string &body,
  3471. const std::string &content_type, size_t chunk_size = 8192) {
  3472. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3473. chunk_size};
  3474. }
  3475. template <typename ClientType>
  3476. inline Result Post(ClientType &cli, const std::string &path,
  3477. const Params &params, const Headers &headers,
  3478. const std::string &body, const std::string &content_type,
  3479. size_t chunk_size = 8192) {
  3480. return Result{
  3481. cli.open_stream("POST", path, params, headers, body, content_type),
  3482. chunk_size};
  3483. }
  3484. // PUT
  3485. template <typename ClientType>
  3486. inline Result Put(ClientType &cli, const std::string &path,
  3487. const std::string &body, const std::string &content_type,
  3488. size_t chunk_size = 8192) {
  3489. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3490. chunk_size};
  3491. }
  3492. template <typename ClientType>
  3493. inline Result Put(ClientType &cli, const std::string &path,
  3494. const Headers &headers, const std::string &body,
  3495. const std::string &content_type, size_t chunk_size = 8192) {
  3496. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3497. chunk_size};
  3498. }
  3499. template <typename ClientType>
  3500. inline Result Put(ClientType &cli, const std::string &path,
  3501. const Params &params, const std::string &body,
  3502. const std::string &content_type, size_t chunk_size = 8192) {
  3503. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3504. chunk_size};
  3505. }
  3506. template <typename ClientType>
  3507. inline Result Put(ClientType &cli, const std::string &path,
  3508. const Params &params, const Headers &headers,
  3509. const std::string &body, const std::string &content_type,
  3510. size_t chunk_size = 8192) {
  3511. return Result{
  3512. cli.open_stream("PUT", path, params, headers, body, content_type),
  3513. chunk_size};
  3514. }
  3515. // PATCH
  3516. template <typename ClientType>
  3517. inline Result Patch(ClientType &cli, const std::string &path,
  3518. const std::string &body, const std::string &content_type,
  3519. size_t chunk_size = 8192) {
  3520. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3521. chunk_size};
  3522. }
  3523. template <typename ClientType>
  3524. inline Result Patch(ClientType &cli, const std::string &path,
  3525. const Headers &headers, const std::string &body,
  3526. const std::string &content_type, size_t chunk_size = 8192) {
  3527. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3528. chunk_size};
  3529. }
  3530. template <typename ClientType>
  3531. inline Result Patch(ClientType &cli, const std::string &path,
  3532. const Params &params, const std::string &body,
  3533. const std::string &content_type, size_t chunk_size = 8192) {
  3534. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3535. chunk_size};
  3536. }
  3537. template <typename ClientType>
  3538. inline Result Patch(ClientType &cli, const std::string &path,
  3539. const Params &params, const Headers &headers,
  3540. const std::string &body, const std::string &content_type,
  3541. size_t chunk_size = 8192) {
  3542. return Result{
  3543. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3544. chunk_size};
  3545. }
  3546. // DELETE
  3547. template <typename ClientType>
  3548. inline Result Delete(ClientType &cli, const std::string &path,
  3549. size_t chunk_size = 8192) {
  3550. return Result{cli.open_stream("DELETE", path), chunk_size};
  3551. }
  3552. template <typename ClientType>
  3553. inline Result Delete(ClientType &cli, const std::string &path,
  3554. const Headers &headers, size_t chunk_size = 8192) {
  3555. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3556. }
  3557. template <typename ClientType>
  3558. inline Result Delete(ClientType &cli, const std::string &path,
  3559. const std::string &body, const std::string &content_type,
  3560. size_t chunk_size = 8192) {
  3561. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3562. chunk_size};
  3563. }
  3564. template <typename ClientType>
  3565. inline Result Delete(ClientType &cli, const std::string &path,
  3566. const Headers &headers, const std::string &body,
  3567. const std::string &content_type,
  3568. size_t chunk_size = 8192) {
  3569. return Result{
  3570. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3571. chunk_size};
  3572. }
  3573. template <typename ClientType>
  3574. inline Result Delete(ClientType &cli, const std::string &path,
  3575. const Params &params, size_t chunk_size = 8192) {
  3576. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3577. }
  3578. template <typename ClientType>
  3579. inline Result Delete(ClientType &cli, const std::string &path,
  3580. const Params &params, const Headers &headers,
  3581. size_t chunk_size = 8192) {
  3582. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3583. }
  3584. template <typename ClientType>
  3585. inline Result Delete(ClientType &cli, const std::string &path,
  3586. const Params &params, const std::string &body,
  3587. const std::string &content_type,
  3588. size_t chunk_size = 8192) {
  3589. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3590. chunk_size};
  3591. }
  3592. template <typename ClientType>
  3593. inline Result Delete(ClientType &cli, const std::string &path,
  3594. const Params &params, const Headers &headers,
  3595. const std::string &body, const std::string &content_type,
  3596. size_t chunk_size = 8192) {
  3597. return Result{
  3598. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3599. chunk_size};
  3600. }
  3601. // HEAD
  3602. template <typename ClientType>
  3603. inline Result Head(ClientType &cli, const std::string &path,
  3604. size_t chunk_size = 8192) {
  3605. return Result{cli.open_stream("HEAD", path), chunk_size};
  3606. }
  3607. template <typename ClientType>
  3608. inline Result Head(ClientType &cli, const std::string &path,
  3609. const Headers &headers, size_t chunk_size = 8192) {
  3610. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3611. }
  3612. template <typename ClientType>
  3613. inline Result Head(ClientType &cli, const std::string &path,
  3614. const Params &params, size_t chunk_size = 8192) {
  3615. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3616. }
  3617. template <typename ClientType>
  3618. inline Result Head(ClientType &cli, const std::string &path,
  3619. const Params &params, const Headers &headers,
  3620. size_t chunk_size = 8192) {
  3621. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3622. }
  3623. // OPTIONS
  3624. template <typename ClientType>
  3625. inline Result Options(ClientType &cli, const std::string &path,
  3626. size_t chunk_size = 8192) {
  3627. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3628. }
  3629. template <typename ClientType>
  3630. inline Result Options(ClientType &cli, const std::string &path,
  3631. const Headers &headers, size_t chunk_size = 8192) {
  3632. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3633. }
  3634. template <typename ClientType>
  3635. inline Result Options(ClientType &cli, const std::string &path,
  3636. const Params &params, size_t chunk_size = 8192) {
  3637. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3638. }
  3639. template <typename ClientType>
  3640. inline Result Options(ClientType &cli, const std::string &path,
  3641. const Params &params, const Headers &headers,
  3642. size_t chunk_size = 8192) {
  3643. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3644. }
  3645. } // namespace stream
  3646. namespace sse {
  3647. struct SSEMessage {
  3648. std::string event; // Event type (default: "message")
  3649. std::string data; // Event payload
  3650. std::string id; // Event ID for Last-Event-ID header
  3651. SSEMessage();
  3652. void clear();
  3653. };
  3654. class SSEClient {
  3655. public:
  3656. using MessageHandler = std::function<void(const SSEMessage &)>;
  3657. using ErrorHandler = std::function<void(Error)>;
  3658. using OpenHandler = std::function<void()>;
  3659. SSEClient(Client &client, const std::string &path);
  3660. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3661. ~SSEClient();
  3662. SSEClient(const SSEClient &) = delete;
  3663. SSEClient &operator=(const SSEClient &) = delete;
  3664. // Event handlers
  3665. SSEClient &on_message(MessageHandler handler);
  3666. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3667. SSEClient &on_open(OpenHandler handler);
  3668. SSEClient &on_error(ErrorHandler handler);
  3669. SSEClient &set_reconnect_interval(int ms);
  3670. SSEClient &set_max_reconnect_attempts(int n);
  3671. // Update headers (thread-safe)
  3672. SSEClient &set_headers(const Headers &headers);
  3673. // State accessors
  3674. bool is_connected() const;
  3675. const std::string &last_event_id() const;
  3676. // Blocking start - runs event loop with auto-reconnect
  3677. void start();
  3678. // Non-blocking start - runs in background thread
  3679. void start_async();
  3680. // Stop the client (thread-safe)
  3681. void stop();
  3682. private:
  3683. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3684. bool &has_data, bool &has_id);
  3685. void run_event_loop();
  3686. void dispatch_event(const SSEMessage &msg);
  3687. bool should_reconnect(int count) const;
  3688. void wait_for_reconnect();
  3689. // Client and path
  3690. Client &client_;
  3691. std::string path_;
  3692. Headers headers_;
  3693. mutable std::mutex headers_mutex_;
  3694. // Callbacks
  3695. MessageHandler on_message_;
  3696. std::map<std::string, MessageHandler> event_handlers_;
  3697. OpenHandler on_open_;
  3698. ErrorHandler on_error_;
  3699. // Configuration
  3700. int reconnect_interval_ms_ = 3000;
  3701. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3702. // State
  3703. std::atomic<bool> running_{false};
  3704. std::atomic<bool> connected_{false};
  3705. std::string last_event_id_;
  3706. // Async support
  3707. std::thread async_thread_;
  3708. };
  3709. } // namespace sse
  3710. namespace ws {
  3711. class WebSocketClient;
  3712. enum class Opcode : uint8_t {
  3713. Continuation = 0x0,
  3714. Text = 0x1,
  3715. Binary = 0x2,
  3716. Close = 0x8,
  3717. Ping = 0x9,
  3718. Pong = 0xA,
  3719. };
  3720. enum class CloseStatus : uint16_t {
  3721. Normal = 1000,
  3722. GoingAway = 1001,
  3723. ProtocolError = 1002,
  3724. UnsupportedData = 1003,
  3725. NoStatus = 1005,
  3726. Abnormal = 1006,
  3727. InvalidPayload = 1007,
  3728. PolicyViolation = 1008,
  3729. MessageTooBig = 1009,
  3730. MandatoryExtension = 1010,
  3731. InternalError = 1011,
  3732. };
  3733. // Timeout is returned only when a read timeout was set and it elapsed before
  3734. // any byte of a frame arrived: nothing was consumed and the connection is
  3735. // still open, so the caller can send on it and read again. `msg` is left
  3736. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3737. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3738. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3739. // upgrade handshake fully succeeded. On failure error() identifies the
  3740. // failing layer; status()/headers() expose the server's upgrade response
  3741. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3742. // CONNECT when error() is ProxyConnection.
  3743. class Result {
  3744. public:
  3745. Result() = default;
  3746. Result(Error err, int status, Headers &&headers)
  3747. : err_(err), status_(status), headers_(std::move(headers)) {}
  3748. explicit operator bool() const { return err_ == Error::Success; }
  3749. Error error() const { return err_; }
  3750. // Upgrade response info
  3751. int status() const { return status_; }
  3752. const Headers &headers() const { return headers_; }
  3753. std::string get_header_value(const std::string &key,
  3754. const char *def = "") const {
  3755. return detail::get_header_value(headers_, key, def, 0);
  3756. }
  3757. bool has_header(const std::string &key) const {
  3758. return headers_.find(key) != headers_.end();
  3759. }
  3760. #ifdef CPPHTTPLIB_SSL_ENABLED
  3761. Result(Error err, int status, Headers &&headers, int ssl_error,
  3762. uint64_t ssl_backend_error)
  3763. : err_(err), status_(status), headers_(std::move(headers)),
  3764. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3765. int ssl_error() const { return ssl_error_; }
  3766. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3767. #endif
  3768. private:
  3769. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3770. int status_ = -1;
  3771. Headers headers_;
  3772. #ifdef CPPHTTPLIB_SSL_ENABLED
  3773. int ssl_error_ = 0;
  3774. uint64_t ssl_backend_error_ = 0;
  3775. #endif
  3776. };
  3777. class WebSocket {
  3778. public:
  3779. WebSocket(const WebSocket &) = delete;
  3780. WebSocket &operator=(const WebSocket &) = delete;
  3781. ~WebSocket();
  3782. ReadResult read(std::string &msg);
  3783. bool send(const std::string &data);
  3784. bool send(const char *data, size_t len);
  3785. void close(CloseStatus status = CloseStatus::Normal,
  3786. const std::string &reason = "");
  3787. const Request &request() const;
  3788. bool is_open() const;
  3789. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3790. // A server handler owns its connection's timeout this way; a client sets it
  3791. // through WebSocketClient. Safe to call while another thread is in read().
  3792. //
  3793. // Only a timeout set here is reported as Timeout. The compile-time default
  3794. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3795. // than a request for control, so when it elapses read() returns Fail and
  3796. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3797. void set_read_timeout(time_t sec, time_t usec = 0);
  3798. template <class Rep, class Period>
  3799. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3800. private:
  3801. friend class httplib::Server;
  3802. friend class httplib::ws::WebSocketClient;
  3803. WebSocket(
  3804. Stream &strm, const Request &req, bool is_server,
  3805. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3806. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3807. : strm_(strm), req_(req), is_server_(is_server),
  3808. ping_interval_sec_(ping_interval_sec),
  3809. max_missed_pongs_(max_missed_pongs) {
  3810. start_heartbeat();
  3811. }
  3812. WebSocket(
  3813. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3814. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3815. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3816. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3817. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3818. max_missed_pongs_(max_missed_pongs) {
  3819. start_heartbeat();
  3820. }
  3821. void start_heartbeat();
  3822. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3823. Stream &strm_;
  3824. std::unique_ptr<Stream> owned_strm_;
  3825. Request req_;
  3826. bool is_server_;
  3827. time_t ping_interval_sec_;
  3828. int max_missed_pongs_;
  3829. int unacked_pings_ = 0;
  3830. std::atomic<bool> closed_{false};
  3831. // Set once the caller has bounded read() through set_read_timeout(). Until
  3832. // then the timeout in effect is the compile-time default, and elapsing it
  3833. // is a failure that closes the connection, not a Timeout.
  3834. std::atomic<bool> read_timeout_set_{false};
  3835. std::mutex write_mutex_;
  3836. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3837. // may do so: read_websocket_frame() reads a payload until it has the whole
  3838. // declared length, so a second parser stealing bytes silently corrupts the
  3839. // message the first one is assembling.
  3840. std::mutex read_mutex_;
  3841. std::thread ping_thread_;
  3842. std::mutex ping_mutex_;
  3843. std::condition_variable ping_cv_;
  3844. };
  3845. class WebSocketClient {
  3846. public:
  3847. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3848. const Headers &headers = {});
  3849. ~WebSocketClient();
  3850. WebSocketClient(const WebSocketClient &) = delete;
  3851. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3852. bool is_valid() const;
  3853. Result connect();
  3854. ReadResult read(std::string &msg);
  3855. bool send(const std::string &data);
  3856. bool send(const char *data, size_t len);
  3857. void close(CloseStatus status = CloseStatus::Normal,
  3858. const std::string &reason = "");
  3859. bool is_open() const;
  3860. const std::string &subprotocol() const;
  3861. void set_read_timeout(time_t sec, time_t usec = 0);
  3862. template <class Rep, class Period>
  3863. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3864. void set_write_timeout(time_t sec, time_t usec = 0);
  3865. template <class Rep, class Period>
  3866. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3867. void set_websocket_ping_interval(time_t sec);
  3868. void set_websocket_max_missed_pongs(int count);
  3869. void set_tcp_nodelay(bool on);
  3870. void set_address_family(int family);
  3871. void set_ipv6_v6only(bool on);
  3872. void set_socket_options(SocketOptions socket_options);
  3873. void set_connection_timeout(time_t sec, time_t usec = 0);
  3874. template <class Rep, class Period>
  3875. void
  3876. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3877. void set_interface(const std::string &intf);
  3878. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3879. void set_proxy(const std::string &host, int port);
  3880. void set_proxy_basic_auth(const std::string &username,
  3881. const std::string &password);
  3882. void set_proxy_bearer_token_auth(const std::string &token);
  3883. void set_no_proxy(const std::vector<std::string> &patterns);
  3884. #ifdef CPPHTTPLIB_SSL_ENABLED
  3885. struct PemMemory {
  3886. const char *cert_pem;
  3887. size_t cert_pem_len;
  3888. const char *key_pem;
  3889. size_t key_pem_len;
  3890. const char *private_key_password;
  3891. };
  3892. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3893. const PemMemory &pem, const Headers &headers = {});
  3894. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3895. const std::string &ca_cert_dir_path = std::string());
  3896. void set_ca_cert_store(tls::ca_store_t store);
  3897. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3898. void enable_server_certificate_verification(bool enabled);
  3899. void enable_server_hostname_verification(bool enabled);
  3900. void enable_system_ca(bool enabled);
  3901. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3902. void set_session_verifier(
  3903. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3904. void set_proxy_digest_auth(const std::string &username,
  3905. const std::string &password);
  3906. #endif
  3907. private:
  3908. void shutdown_and_close();
  3909. std::pair<time_t, time_t> handshake_timeout() const;
  3910. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3911. int &ssl_error, uint64_t &ssl_backend_error);
  3912. void prepare_default_headers(Request &req);
  3913. bool is_proxy_enabled() const;
  3914. bool create_and_connect_socket(Error &error);
  3915. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3916. bool connect_with_proxy(Response &proxy_res, Error &error);
  3917. std::string host_;
  3918. int port_;
  3919. std::string path_;
  3920. Headers headers_;
  3921. std::string subprotocol_;
  3922. bool is_valid_ = false;
  3923. socket_t sock_ = INVALID_SOCKET;
  3924. std::unique_ptr<WebSocket> ws_;
  3925. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3926. time_t read_timeout_usec_ = 0;
  3927. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3928. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3929. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3930. time_t websocket_ping_interval_sec_ =
  3931. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3932. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3933. int address_family_ = AF_UNSPEC;
  3934. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3935. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3936. SocketOptions socket_options_ = nullptr;
  3937. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3938. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3939. std::string interface_;
  3940. // Hostname to connection target map. The value is an IP literal or another
  3941. // hostname; only the connection target changes, never the identity.
  3942. std::map<std::string, std::string> addr_map_;
  3943. std::string proxy_host_;
  3944. int proxy_port_ = -1;
  3945. std::string proxy_basic_auth_username_;
  3946. std::string proxy_basic_auth_password_;
  3947. std::string proxy_bearer_token_auth_token_;
  3948. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  3949. #ifdef CPPHTTPLIB_SSL_ENABLED
  3950. bool is_ssl_ = false;
  3951. tls::ctx_t tls_ctx_ = nullptr;
  3952. tls::session_t tls_session_ = nullptr;
  3953. std::string ca_cert_file_path_;
  3954. std::string ca_cert_dir_path_;
  3955. bool custom_ca_loaded_ = false;
  3956. bool certs_loaded_ = false;
  3957. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3958. bool server_certificate_verification_ = true;
  3959. bool server_hostname_verification_ = true;
  3960. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3961. std::string proxy_digest_auth_username_;
  3962. std::string proxy_digest_auth_password_;
  3963. #endif
  3964. };
  3965. template <class Rep, class Period>
  3966. inline void WebSocket::set_read_timeout(
  3967. const std::chrono::duration<Rep, Period> &duration) {
  3968. detail::duration_to_sec_and_usec(
  3969. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3970. }
  3971. template <class Rep, class Period>
  3972. inline void WebSocketClient::set_read_timeout(
  3973. const std::chrono::duration<Rep, Period> &duration) {
  3974. detail::duration_to_sec_and_usec(
  3975. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3976. }
  3977. template <class Rep, class Period>
  3978. inline void WebSocketClient::set_write_timeout(
  3979. const std::chrono::duration<Rep, Period> &duration) {
  3980. detail::duration_to_sec_and_usec(
  3981. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3982. }
  3983. template <class Rep, class Period>
  3984. inline void WebSocketClient::set_connection_timeout(
  3985. const std::chrono::duration<Rep, Period> &duration) {
  3986. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3987. set_connection_timeout(sec, usec);
  3988. });
  3989. }
  3990. namespace impl {
  3991. bool is_valid_utf8(const std::string &s);
  3992. // Three states, because a failure that consumed bytes and one that consumed
  3993. // none are not the same thing: the first has left the stream in the middle of
  3994. // a frame and the connection cannot be reused, the second can just be retried.
  3995. enum class FrameRead { Ok, Fail, Timeout };
  3996. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3997. std::string &payload, bool &fin,
  3998. bool expect_masked, size_t max_len);
  3999. } // namespace impl
  4000. } // namespace ws
  4001. // ----------------------------------------------------------------------------
  4002. /*
  4003. * Implementation that will be part of the .cc file if split into .h + .cc.
  4004. */
  4005. namespace stream {
  4006. // stream::Result implementations
  4007. inline Result::Result() : chunk_size_(8192) {}
  4008. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4009. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4010. inline Result::Result(Result &&other) noexcept
  4011. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4012. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4013. finished_(other.finished_) {
  4014. other.current_size_ = 0;
  4015. other.finished_ = true;
  4016. }
  4017. inline Result &Result::operator=(Result &&other) noexcept {
  4018. if (this != &other) {
  4019. handle_ = std::move(other.handle_);
  4020. buffer_ = std::move(other.buffer_);
  4021. current_size_ = other.current_size_;
  4022. chunk_size_ = other.chunk_size_;
  4023. finished_ = other.finished_;
  4024. other.current_size_ = 0;
  4025. other.finished_ = true;
  4026. }
  4027. return *this;
  4028. }
  4029. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4030. inline Result::operator bool() const { return is_valid(); }
  4031. inline int Result::status() const {
  4032. return handle_.response ? handle_.response->status : -1;
  4033. }
  4034. inline const Headers &Result::headers() const {
  4035. static const Headers empty_headers;
  4036. return handle_.response ? handle_.response->headers : empty_headers;
  4037. }
  4038. inline std::string Result::get_header_value(const std::string &key,
  4039. const char *def) const {
  4040. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4041. }
  4042. inline bool Result::has_header(const std::string &key) const {
  4043. return handle_.response ? handle_.response->has_header(key) : false;
  4044. }
  4045. inline Error Result::error() const { return handle_.error; }
  4046. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4047. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4048. inline bool Result::next() {
  4049. if (!handle_.is_valid() || finished_) { return false; }
  4050. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4051. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4052. if (n > 0) {
  4053. current_size_ = static_cast<size_t>(n);
  4054. return true;
  4055. }
  4056. current_size_ = 0;
  4057. finished_ = true;
  4058. return false;
  4059. }
  4060. inline const char *Result::data() const { return buffer_.data(); }
  4061. inline size_t Result::size() const { return current_size_; }
  4062. inline std::string Result::read_all() {
  4063. std::string result;
  4064. while (next()) {
  4065. result.append(data(), size());
  4066. }
  4067. return result;
  4068. }
  4069. } // namespace stream
  4070. namespace sse {
  4071. // SSEMessage implementations
  4072. inline SSEMessage::SSEMessage() : event("message") {}
  4073. inline void SSEMessage::clear() {
  4074. event = "message";
  4075. data.clear();
  4076. id.clear();
  4077. }
  4078. // SSEClient implementations
  4079. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4080. : client_(client), path_(path) {}
  4081. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4082. const Headers &headers)
  4083. : client_(client), path_(path), headers_(headers) {}
  4084. inline SSEClient::~SSEClient() { stop(); }
  4085. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4086. on_message_ = std::move(handler);
  4087. return *this;
  4088. }
  4089. inline SSEClient &SSEClient::on_event(const std::string &type,
  4090. MessageHandler handler) {
  4091. event_handlers_[type] = std::move(handler);
  4092. return *this;
  4093. }
  4094. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4095. on_open_ = std::move(handler);
  4096. return *this;
  4097. }
  4098. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4099. on_error_ = std::move(handler);
  4100. return *this;
  4101. }
  4102. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4103. reconnect_interval_ms_ = ms;
  4104. return *this;
  4105. }
  4106. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4107. max_reconnect_attempts_ = n;
  4108. return *this;
  4109. }
  4110. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4111. std::lock_guard<std::mutex> lock(headers_mutex_);
  4112. headers_ = headers;
  4113. return *this;
  4114. }
  4115. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4116. inline const std::string &SSEClient::last_event_id() const {
  4117. return last_event_id_;
  4118. }
  4119. inline void SSEClient::start() {
  4120. running_.store(true);
  4121. run_event_loop();
  4122. }
  4123. inline void SSEClient::start_async() {
  4124. running_.store(true);
  4125. async_thread_ = std::thread([this]() { run_event_loop(); });
  4126. }
  4127. inline void SSEClient::stop() {
  4128. running_.store(false);
  4129. client_.stop(); // Cancel any pending operations
  4130. if (async_thread_.joinable()) { async_thread_.join(); }
  4131. }
  4132. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4133. int &retry_ms, bool &has_data,
  4134. bool &has_id) {
  4135. // Blank line signals end of event
  4136. if (line.empty()) { return true; }
  4137. // Lines starting with ':' are comments (ignored)
  4138. if (line[0] == ':') { return false; }
  4139. // Find the colon separator
  4140. auto colon_pos = line.find(':');
  4141. auto field = line.substr(0, colon_pos);
  4142. std::string value;
  4143. // Value starts after colon, skip optional single space
  4144. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4145. auto value_start = colon_pos + 1;
  4146. if (line[value_start] == ' ') { value_start++; }
  4147. value = line.substr(value_start);
  4148. }
  4149. // Handle known fields
  4150. if (field == "event") {
  4151. // An empty event type is dispatched as "message" per the SSE spec
  4152. msg.event = value.empty() ? std::string("message") : std::move(value);
  4153. } else if (field == "data") {
  4154. // Multiple data lines are concatenated with newlines
  4155. if (has_data) { msg.data += "\n"; }
  4156. msg.data += value;
  4157. has_data = true;
  4158. } else if (field == "id") {
  4159. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4160. // valid (clears the last event ID)
  4161. if (detail::fields::is_field_value(value)) {
  4162. msg.id = value;
  4163. has_id = true;
  4164. }
  4165. } else if (field == "retry") {
  4166. // Parse retry interval in milliseconds
  4167. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4168. if (detail::is_numeric(value)) {
  4169. int v = 0;
  4170. auto res =
  4171. detail::from_chars(value.data(), value.data() + value.size(), v);
  4172. if (res.ec == std::errc{}) { retry_ms = v; }
  4173. }
  4174. }
  4175. // Unknown fields are ignored per SSE spec
  4176. return false;
  4177. }
  4178. inline void SSEClient::run_event_loop() {
  4179. auto reconnect_count = 0;
  4180. while (running_.load()) {
  4181. // Build headers, including Last-Event-ID if we have one
  4182. Headers request_headers;
  4183. {
  4184. std::lock_guard<std::mutex> lock(headers_mutex_);
  4185. request_headers = headers_;
  4186. }
  4187. if (!last_event_id_.empty()) {
  4188. request_headers.emplace("Last-Event-ID", last_event_id_);
  4189. }
  4190. // Open streaming connection. An event stream has no end, so each event is
  4191. // bounded instead of the whole body.
  4192. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4193. handle.body_reader_.payload_max_length = 0;
  4194. // stop() ends a read that is waiting for the next event
  4195. if (handle.stream_) {
  4196. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4197. }
  4198. stream::Result result{std::move(handle)};
  4199. // Connection error handling
  4200. if (!result) {
  4201. connected_.store(false);
  4202. if (on_error_) { on_error_(result.error()); }
  4203. if (!should_reconnect(reconnect_count)) { break; }
  4204. wait_for_reconnect();
  4205. reconnect_count++;
  4206. continue;
  4207. }
  4208. if (result.status() != StatusCode::OK_200) {
  4209. connected_.store(false);
  4210. if (on_error_) { on_error_(Error::Connection); }
  4211. // For certain errors, don't reconnect.
  4212. // Note: 401 is intentionally absent so that handlers can refresh
  4213. // credentials via set_headers() and let the client reconnect.
  4214. if (result.status() == StatusCode::NoContent_204 ||
  4215. result.status() == StatusCode::NotFound_404 ||
  4216. result.status() == StatusCode::Forbidden_403) {
  4217. break;
  4218. }
  4219. if (!should_reconnect(reconnect_count)) { break; }
  4220. wait_for_reconnect();
  4221. reconnect_count++;
  4222. continue;
  4223. }
  4224. // Connection successful
  4225. connected_.store(true);
  4226. reconnect_count = 0;
  4227. if (on_open_) { on_open_(); }
  4228. // Event receiving loop
  4229. std::string buffer;
  4230. SSEMessage current_msg;
  4231. auto has_data = false;
  4232. auto has_id = false;
  4233. auto first_line = true;
  4234. auto after_cr = false;
  4235. auto event_too_long = false;
  4236. while (running_.load() && result.next()) {
  4237. // What is left in the buffer has no line ending
  4238. auto search_pos = buffer.size();
  4239. buffer.append(result.data(), result.size());
  4240. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4241. // per the SSE spec
  4242. size_t line_start = 0;
  4243. size_t eol_pos;
  4244. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4245. std::string::npos) {
  4246. auto line = buffer.substr(line_start, eol_pos - line_start);
  4247. line_start = eol_pos + 1;
  4248. search_pos = line_start;
  4249. // The \n of a \r\n may arrive in a later chunk than its \r
  4250. auto is_lf_of_crlf =
  4251. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4252. after_cr = buffer[eol_pos] == '\r';
  4253. if (is_lf_of_crlf) { continue; }
  4254. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4255. if (first_line) {
  4256. first_line = false;
  4257. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4258. }
  4259. // Parse the line and check if event is complete
  4260. auto event_complete = parse_sse_line(
  4261. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4262. if (event_complete) {
  4263. // Update last_event_id for reconnection, even for an event that
  4264. // has no data. An empty id clears it.
  4265. if (has_id) { last_event_id_ = current_msg.id; }
  4266. // An event without a data field is not dispatched
  4267. if (has_data) { dispatch_event(current_msg); }
  4268. // Reset the message for the next event either way
  4269. current_msg.clear();
  4270. has_data = false;
  4271. has_id = false;
  4272. }
  4273. }
  4274. // Keep unprocessed data in buffer
  4275. buffer.erase(0, line_start);
  4276. // Neither an event nor a line still waiting for its end may grow
  4277. // without bound. 0 means no limit.
  4278. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4279. buffer.size() + current_msg.data.size() >
  4280. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4281. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4282. event_too_long = true;
  4283. break;
  4284. }
  4285. }
  4286. // Connection ended
  4287. connected_.store(false);
  4288. // Reconnecting would only get the same event again
  4289. if (!running_.load() || event_too_long) { break; }
  4290. // Check for read errors
  4291. if (result.has_read_error()) {
  4292. if (on_error_) { on_error_(result.read_error()); }
  4293. }
  4294. if (!should_reconnect(reconnect_count)) { break; }
  4295. wait_for_reconnect();
  4296. reconnect_count++;
  4297. }
  4298. connected_.store(false);
  4299. }
  4300. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4301. // Check for specific event type handler first
  4302. auto it = event_handlers_.find(msg.event);
  4303. if (it != event_handlers_.end()) {
  4304. it->second(msg);
  4305. return;
  4306. }
  4307. // Fall back to generic message handler
  4308. if (on_message_) { on_message_(msg); }
  4309. }
  4310. inline bool SSEClient::should_reconnect(int count) const {
  4311. if (!running_.load()) { return false; }
  4312. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4313. return count < max_reconnect_attempts_;
  4314. }
  4315. inline void SSEClient::wait_for_reconnect() {
  4316. // Use small increments to check running_ flag frequently.
  4317. // Always wait at least one increment, so that a zero interval (e.g.
  4318. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4319. const auto step_ms = 100;
  4320. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4321. auto waited = 0;
  4322. while (running_.load() && waited < interval_ms) {
  4323. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4324. waited += step_ms;
  4325. }
  4326. }
  4327. } // namespace sse
  4328. #ifdef CPPHTTPLIB_SSL_ENABLED
  4329. /*
  4330. * TLS abstraction layer - internal function declarations
  4331. * These are implementation details and not part of the public API.
  4332. */
  4333. namespace tls {
  4334. // Client context
  4335. ctx_t create_client_context();
  4336. void free_context(ctx_t ctx);
  4337. bool set_min_version(ctx_t ctx, Version version);
  4338. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4339. bool load_ca_file(ctx_t ctx, const char *file_path);
  4340. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4341. bool load_system_certs(ctx_t ctx);
  4342. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4343. const char *password);
  4344. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4345. const char *key_path, const char *password);
  4346. // Server context
  4347. ctx_t create_server_context();
  4348. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4349. const char *password);
  4350. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4351. const char *key_path, const char *password);
  4352. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4353. void set_verify_client(ctx_t ctx, bool require);
  4354. // Session management
  4355. session_t create_session(ctx_t ctx, socket_t sock);
  4356. void free_session(session_t session);
  4357. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4358. // Handshake (non-blocking capable)
  4359. TlsError connect(session_t session);
  4360. TlsError accept(session_t session);
  4361. // Handshake with timeout (blocking until timeout)
  4362. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4363. time_t timeout_usec, TlsError *err);
  4364. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4365. time_t timeout_usec, TlsError *err);
  4366. // I/O (non-blocking capable)
  4367. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4368. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4369. int pending(const_session_t session);
  4370. void shutdown(session_t session, bool graceful);
  4371. // Connection state
  4372. bool is_peer_closed(session_t session, socket_t sock);
  4373. // Certificate verification
  4374. cert_t get_peer_cert(const_session_t session);
  4375. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4376. // do not use them after free_session(), as with get_peer_cert().
  4377. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4378. void free_cert(cert_t cert);
  4379. bool verify_hostname(cert_t cert, const char *hostname);
  4380. uint64_t hostname_mismatch_code();
  4381. long get_verify_result(const_session_t session);
  4382. // Certificate introspection
  4383. std::string get_cert_subject_cn(cert_t cert);
  4384. std::string get_cert_issuer_name(cert_t cert);
  4385. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4386. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4387. std::string get_cert_serial(cert_t cert);
  4388. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4389. const char *get_sni(const_session_t session);
  4390. // CA store management
  4391. ca_store_t create_ca_store(const char *pem, size_t len);
  4392. void free_ca_store(ca_store_t store);
  4393. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4394. // Free each with free_cert(), and do not use them once the context's CA
  4395. // certificates change.
  4396. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4397. std::vector<std::string> get_ca_names(ctx_t ctx);
  4398. // Dynamic certificate update (for servers)
  4399. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4400. const char *password);
  4401. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4402. // Certificate verification callback
  4403. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4404. long get_verify_error(const_session_t session);
  4405. std::string verify_error_string(long error_code);
  4406. // TlsError information
  4407. uint64_t peek_error();
  4408. uint64_t get_error();
  4409. std::string error_string(uint64_t code);
  4410. } // namespace tls
  4411. #endif // CPPHTTPLIB_SSL_ENABLED
  4412. /*
  4413. * Group 1: detail namespace - Non-SSL utilities
  4414. */
  4415. namespace detail {
  4416. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4417. const void *optval, socklen_t optlen) {
  4418. return setsockopt(sock, level, optname,
  4419. #ifdef _WIN32
  4420. reinterpret_cast<const char *>(optval),
  4421. #else
  4422. optval,
  4423. #endif
  4424. optlen) == 0;
  4425. }
  4426. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4427. time_t sec, time_t usec) {
  4428. #ifdef _WIN32
  4429. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4430. #else
  4431. timeval timeout;
  4432. timeout.tv_sec = static_cast<long>(sec);
  4433. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4434. #endif
  4435. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4436. }
  4437. inline bool is_hex(char c, int &v) {
  4438. if (is_ascii_digit(c)) {
  4439. v = c - '0';
  4440. return true;
  4441. } else if ('A' <= c && c <= 'F') {
  4442. v = c - 'A' + 10;
  4443. return true;
  4444. } else if ('a' <= c && c <= 'f') {
  4445. v = c - 'a' + 10;
  4446. return true;
  4447. }
  4448. return false;
  4449. }
  4450. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4451. int &val) {
  4452. if (i >= s.size()) { return false; }
  4453. val = 0;
  4454. for (; cnt; i++, cnt--) {
  4455. if (!s[i]) { return false; }
  4456. auto v = 0;
  4457. if (is_hex(s[i], v)) {
  4458. val = val * 16 + v;
  4459. } else {
  4460. return false;
  4461. }
  4462. }
  4463. return true;
  4464. }
  4465. inline std::string from_i_to_hex(size_t n) {
  4466. static const auto charset = "0123456789abcdef";
  4467. std::string ret;
  4468. do {
  4469. ret = charset[n & 15] + ret;
  4470. n >>= 4;
  4471. } while (n > 0);
  4472. return ret;
  4473. }
  4474. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4475. // builds and trips -Wtautological-type-limit-compare.
  4476. inline bool fits_in_size_t(uint64_t n) {
  4477. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4478. }
  4479. inline std::string compute_etag(const FileStat &fs,
  4480. const std::string &suffix = std::string()) {
  4481. if (!fs.is_file()) { return std::string(); }
  4482. // If mtime cannot be determined (negative value indicates an error
  4483. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4484. // value like 0 could collide with a real file that legitimately has
  4485. // mtime == 0 (epoch) and lead to misleading validators.
  4486. auto mtime_raw = fs.mtime();
  4487. if (mtime_raw < 0) { return std::string(); }
  4488. auto mtime = static_cast<size_t>(mtime_raw);
  4489. auto size = fs.size();
  4490. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4491. from_i_to_hex(size) + suffix + "\"";
  4492. }
  4493. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4494. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4495. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4496. inline std::string file_mtime_to_http_date(time_t mtime) {
  4497. if (mtime < 0) { return std::string(); }
  4498. struct tm tm_buf;
  4499. #ifdef _WIN32
  4500. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4501. #else
  4502. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4503. #endif
  4504. char buf[64];
  4505. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4506. return std::string();
  4507. }
  4508. return std::string(buf);
  4509. }
  4510. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4511. inline time_t parse_http_date(const std::string &date_str) {
  4512. struct tm tm_buf;
  4513. // Create a classic locale object once for all parsing attempts
  4514. const std::locale classic_locale = std::locale::classic();
  4515. // Try to parse using std::get_time (C++11, cross-platform)
  4516. auto try_parse = [&](const char *fmt) -> bool {
  4517. std::istringstream ss(date_str);
  4518. ss.imbue(classic_locale);
  4519. memset(&tm_buf, 0, sizeof(tm_buf));
  4520. ss >> std::get_time(&tm_buf, fmt);
  4521. return !ss.fail();
  4522. };
  4523. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4524. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4525. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4526. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4527. // asctime format: "Sun Nov 6 08:49:37 1994"
  4528. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4529. return static_cast<time_t>(-1);
  4530. }
  4531. }
  4532. }
  4533. #ifdef _WIN32
  4534. return _mkgmtime(&tm_buf);
  4535. #elif defined _AIX
  4536. return mktime(&tm_buf);
  4537. #else
  4538. return timegm(&tm_buf);
  4539. #endif
  4540. }
  4541. inline bool is_weak_etag(const std::string &s) {
  4542. // Check if the string is a weak ETag (starts with 'W/"')
  4543. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4544. }
  4545. inline bool is_strong_etag(const std::string &s) {
  4546. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4547. // chars)
  4548. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4549. }
  4550. inline size_t to_utf8(int code, char *buff) {
  4551. if (code < 0x0080) {
  4552. buff[0] = static_cast<char>(code & 0x7F);
  4553. return 1;
  4554. } else if (code < 0x0800) {
  4555. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4556. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4557. return 2;
  4558. } else if (code < 0xD800) {
  4559. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4560. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4561. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4562. return 3;
  4563. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4564. return 0;
  4565. } else if (code < 0x10000) {
  4566. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4567. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4568. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4569. return 3;
  4570. } else if (code < 0x110000) {
  4571. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4572. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4573. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4574. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4575. return 4;
  4576. }
  4577. // NOTREACHED
  4578. return 0;
  4579. }
  4580. } // namespace detail
  4581. namespace ws {
  4582. namespace impl {
  4583. inline bool is_valid_utf8(const std::string &s) {
  4584. size_t i = 0;
  4585. auto n = s.size();
  4586. while (i < n) {
  4587. auto c = static_cast<unsigned char>(s[i]);
  4588. size_t len;
  4589. uint32_t cp;
  4590. if (c < 0x80) {
  4591. i++;
  4592. continue;
  4593. } else if ((c & 0xE0) == 0xC0) {
  4594. len = 2;
  4595. cp = c & 0x1F;
  4596. } else if ((c & 0xF0) == 0xE0) {
  4597. len = 3;
  4598. cp = c & 0x0F;
  4599. } else if ((c & 0xF8) == 0xF0) {
  4600. len = 4;
  4601. cp = c & 0x07;
  4602. } else {
  4603. return false;
  4604. }
  4605. if (i + len > n) { return false; }
  4606. for (size_t j = 1; j < len; j++) {
  4607. auto b = static_cast<unsigned char>(s[i + j]);
  4608. if ((b & 0xC0) != 0x80) { return false; }
  4609. cp = (cp << 6) | (b & 0x3F);
  4610. }
  4611. // Overlong encoding check
  4612. if (len == 2 && cp < 0x80) { return false; }
  4613. if (len == 3 && cp < 0x800) { return false; }
  4614. if (len == 4 && cp < 0x10000) { return false; }
  4615. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4616. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4617. if (cp > 0x10FFFF) { return false; }
  4618. i += len;
  4619. }
  4620. return true;
  4621. }
  4622. } // namespace impl
  4623. } // namespace ws
  4624. namespace detail {
  4625. // NOTE: This code came up with the following stackoverflow post:
  4626. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4627. inline std::string base64_encode(const std::string &in) {
  4628. static const auto lookup =
  4629. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4630. std::string out;
  4631. out.reserve(in.size());
  4632. // Unsigned: the accumulator is never masked, so with a signed int the
  4633. // `val << 8` below overflows once enough bytes are folded in (undefined
  4634. // behaviour before C++20). Only the low bits are ever emitted, so the
  4635. // wrap-around of an unsigned accumulator does not affect the output.
  4636. uint32_t val = 0;
  4637. auto valb = -6;
  4638. for (auto c : in) {
  4639. val = (val << 8) + static_cast<uint8_t>(c);
  4640. valb += 8;
  4641. while (valb >= 0) {
  4642. out.push_back(lookup[(val >> valb) & 0x3F]);
  4643. valb -= 6;
  4644. }
  4645. }
  4646. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4647. while (out.size() % 4) {
  4648. out.push_back('=');
  4649. }
  4650. return out;
  4651. }
  4652. inline std::string sha1(const std::string &input) {
  4653. // RFC 3174 SHA-1 implementation
  4654. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4655. return (x << n) | (x >> (32 - n));
  4656. };
  4657. uint32_t h0 = 0x67452301;
  4658. uint32_t h1 = 0xEFCDAB89;
  4659. uint32_t h2 = 0x98BADCFE;
  4660. uint32_t h3 = 0x10325476;
  4661. uint32_t h4 = 0xC3D2E1F0;
  4662. // Pre-processing: adding padding bits
  4663. std::string msg = input;
  4664. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4665. msg.push_back(static_cast<char>(0x80u));
  4666. while (msg.size() % 64 != 56) {
  4667. msg.push_back(0);
  4668. }
  4669. // Append original length in bits as 64-bit big-endian
  4670. for (int i = 56; i >= 0; i -= 8) {
  4671. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4672. }
  4673. // Process each 512-bit chunk
  4674. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4675. uint32_t w[80];
  4676. for (size_t i = 0; i < 16; i++) {
  4677. w[i] =
  4678. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4679. << 24) |
  4680. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4681. << 16) |
  4682. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4683. << 8) |
  4684. (static_cast<uint32_t>(
  4685. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4686. }
  4687. for (int i = 16; i < 80; i++) {
  4688. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4689. }
  4690. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4691. for (int i = 0; i < 80; i++) {
  4692. uint32_t f, k;
  4693. if (i < 20) {
  4694. f = (b & c) | ((~b) & d);
  4695. k = 0x5A827999;
  4696. } else if (i < 40) {
  4697. f = b ^ c ^ d;
  4698. k = 0x6ED9EBA1;
  4699. } else if (i < 60) {
  4700. f = (b & c) | (b & d) | (c & d);
  4701. k = 0x8F1BBCDC;
  4702. } else {
  4703. f = b ^ c ^ d;
  4704. k = 0xCA62C1D6;
  4705. }
  4706. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4707. e = d;
  4708. d = c;
  4709. c = left_rotate(b, 30);
  4710. b = a;
  4711. a = temp;
  4712. }
  4713. h0 += a;
  4714. h1 += b;
  4715. h2 += c;
  4716. h3 += d;
  4717. h4 += e;
  4718. }
  4719. // Produce the final hash as a 20-byte binary string
  4720. std::string hash(20, '\0');
  4721. for (size_t i = 0; i < 4; i++) {
  4722. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4723. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4724. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4725. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4726. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4727. }
  4728. return hash;
  4729. }
  4730. inline std::string websocket_accept_key(const std::string &client_key) {
  4731. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4732. return base64_encode(sha1(client_key + magic));
  4733. }
  4734. inline bool is_websocket_upgrade(const Request &req) {
  4735. if (req.method != "GET") { return false; }
  4736. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4737. // list of protocols and asks recipients to match each name
  4738. // case-insensitively, so look for the token rather than compare the whole
  4739. // field value.
  4740. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4741. // Check Connection: Upgrade
  4742. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4743. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4744. // RFC 6455 Section 4.2.1
  4745. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4746. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4747. return false;
  4748. }
  4749. static const std::string b64chars =
  4750. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4751. for (size_t i = 0; i < 22; i++) {
  4752. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4753. }
  4754. // Check Sec-WebSocket-Version: 13
  4755. auto version = req.get_header_value("Sec-WebSocket-Version");
  4756. if (version != "13") { return false; }
  4757. return true;
  4758. }
  4759. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4760. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4761. thread_local std::random_device rd;
  4762. size_t filled = 0;
  4763. while (filled < n) {
  4764. auto v = rd();
  4765. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4766. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4767. }
  4768. }
  4769. }
  4770. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4771. const char *data, size_t len, bool fin,
  4772. bool mask) {
  4773. // First byte: FIN + opcode
  4774. uint8_t header[2];
  4775. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4776. (static_cast<uint8_t>(opcode) & 0x0F));
  4777. // Second byte: MASK + payload length
  4778. if (len < 126) {
  4779. header[1] = static_cast<uint8_t>(len);
  4780. if (mask) { header[1] |= 0x80; }
  4781. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4782. } else if (len <= 0xFFFF) {
  4783. header[1] = 126;
  4784. if (mask) { header[1] |= 0x80; }
  4785. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4786. uint8_t ext[2];
  4787. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4788. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4789. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4790. } else {
  4791. header[1] = 127;
  4792. if (mask) { header[1] |= 0x80; }
  4793. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4794. uint8_t ext[8];
  4795. for (int i = 7; i >= 0; i--) {
  4796. ext[7 - i] =
  4797. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4798. }
  4799. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4800. }
  4801. if (mask) {
  4802. // Generate random mask key
  4803. uint8_t mask_key[4];
  4804. fill_random_bytes(mask_key, sizeof(mask_key));
  4805. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4806. // Write masked payload in chunks
  4807. const size_t chunk_size = 4096;
  4808. std::vector<char> buf((std::min)(len, chunk_size));
  4809. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4810. size_t n = (std::min)(chunk_size, len - offset);
  4811. for (size_t i = 0; i < n; i++) {
  4812. buf[i] =
  4813. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4814. }
  4815. if (strm.write(buf.data(), n) < 0) { return false; }
  4816. }
  4817. } else {
  4818. if (len > 0) {
  4819. if (strm.write(data, len) < 0) { return false; }
  4820. }
  4821. }
  4822. return true;
  4823. }
  4824. } // namespace detail
  4825. namespace ws {
  4826. namespace impl {
  4827. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4828. // hands back whatever its buffer already holds -- so every multi-byte field has
  4829. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4830. // header straddles the read buffer's boundary.
  4831. //
  4832. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4833. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4834. // there is a failure like any other. (When read() fails it always records why,
  4835. // so the error belongs to this call and not to an earlier one.)
  4836. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4837. auto p = static_cast<char *>(buf);
  4838. size_t total = 0;
  4839. while (total < size) {
  4840. auto n = strm.read(p + total, size - total);
  4841. if (n <= 0) {
  4842. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4843. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4844. }
  4845. total += static_cast<size_t>(n);
  4846. }
  4847. return FrameRead::Ok;
  4848. }
  4849. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4850. std::string &payload, bool &fin,
  4851. bool expect_masked, size_t max_len) {
  4852. // Read first 2 bytes. This is the only read that may report a timeout: it
  4853. // sits on a frame boundary, where nothing has been consumed yet.
  4854. uint8_t header[2];
  4855. FrameRead first = read_exact(strm, header, 2);
  4856. if (first != FrameRead::Ok) { return first; }
  4857. fin = (header[0] & 0x80) != 0;
  4858. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4859. if (header[0] & 0x70) { return FrameRead::Fail; }
  4860. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4861. bool masked = (header[1] & 0x80) != 0;
  4862. uint64_t payload_len = header[1] & 0x7F;
  4863. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4864. // MUST have a payload length of 125 bytes or less
  4865. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4866. if (is_control) {
  4867. if (!fin) { return FrameRead::Fail; }
  4868. if (payload_len > 125) { return FrameRead::Fail; }
  4869. }
  4870. if (masked != expect_masked) { return FrameRead::Fail; }
  4871. // Extended payload length
  4872. if (payload_len == 126) {
  4873. uint8_t ext[2];
  4874. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4875. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4876. } else if (payload_len == 127) {
  4877. uint8_t ext[8];
  4878. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4879. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4880. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4881. payload_len = 0;
  4882. for (int i = 0; i < 8; i++) {
  4883. payload_len = (payload_len << 8) | ext[i];
  4884. }
  4885. }
  4886. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4887. // size_t cannot hold (32-bit builds) is refused either way.
  4888. if ((max_len > 0 && payload_len > max_len) ||
  4889. !detail::fits_in_size_t(payload_len)) {
  4890. return FrameRead::Fail;
  4891. }
  4892. // Read mask key if present
  4893. uint8_t mask_key[4] = {0};
  4894. if (masked) {
  4895. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4896. return FrameRead::Fail;
  4897. }
  4898. }
  4899. // Grow the payload only as it arrives, since a header alone can announce
  4900. // max_len bytes that never come.
  4901. payload.clear();
  4902. auto len = static_cast<size_t>(payload_len);
  4903. while (payload.size() < len) {
  4904. auto offset = payload.size();
  4905. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4906. payload.resize(offset + n);
  4907. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4908. return FrameRead::Fail;
  4909. }
  4910. }
  4911. // Unmask if needed
  4912. if (masked) {
  4913. for (size_t i = 0; i < payload.size(); i++) {
  4914. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4915. }
  4916. }
  4917. return FrameRead::Ok;
  4918. }
  4919. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4920. // be sent followed by a UTF-8 reason.
  4921. inline bool is_valid_close_payload(const std::string &payload) {
  4922. if (payload.empty()) { return true; }
  4923. if (payload.size() < 2) { return false; }
  4924. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4925. static_cast<uint8_t>(payload[1]);
  4926. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4927. (1007 <= code && code <= 1014) ||
  4928. (3000 <= code && code <= 4999);
  4929. return may_be_sent && is_valid_utf8(payload.substr(2));
  4930. }
  4931. } // namespace impl
  4932. } // namespace ws
  4933. namespace detail {
  4934. inline bool is_valid_path(const std::string &path) {
  4935. size_t level = 0;
  4936. size_t i = 0;
  4937. // Skip slash
  4938. while (i < path.size() && path[i] == '/') {
  4939. i++;
  4940. }
  4941. while (i < path.size()) {
  4942. // Read component
  4943. auto beg = i;
  4944. while (i < path.size() && path[i] != '/') {
  4945. if (path[i] == '\0') {
  4946. return false;
  4947. } else if (path[i] == '\\') {
  4948. return false;
  4949. }
  4950. i++;
  4951. }
  4952. auto len = i - beg;
  4953. assert(len > 0);
  4954. if (!path.compare(beg, len, ".")) {
  4955. ;
  4956. } else if (!path.compare(beg, len, "..")) {
  4957. if (level == 0) { return false; }
  4958. level--;
  4959. } else {
  4960. level++;
  4961. }
  4962. // Skip slash
  4963. while (i < path.size() && path[i] == '/') {
  4964. i++;
  4965. }
  4966. }
  4967. return true;
  4968. }
  4969. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4970. #if defined(_WIN32)
  4971. char buf[_MAX_PATH];
  4972. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4973. resolved = buf;
  4974. #elif defined(PATH_MAX)
  4975. char buf[PATH_MAX];
  4976. if (realpath(path, buf) == nullptr) { return false; }
  4977. resolved = buf;
  4978. #else
  4979. auto buf = realpath(path, nullptr);
  4980. auto guard = scope_exit([&]() { std::free(buf); });
  4981. if (buf == nullptr) { return false; }
  4982. resolved = buf;
  4983. #endif
  4984. return true;
  4985. }
  4986. inline bool is_path_within_base(const std::string &resolved_path,
  4987. const std::string &resolved_base) {
  4988. #if defined(_WIN32)
  4989. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4990. resolved_base.size()) == 0;
  4991. #else
  4992. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4993. resolved_base.size()) == 0;
  4994. #endif
  4995. }
  4996. inline FileStat::FileStat(const std::string &path) {
  4997. #if defined(_WIN32)
  4998. auto wpath = u8string_to_wstring(path.c_str());
  4999. ret_ = _wstat(wpath.c_str(), &st_);
  5000. #else
  5001. ret_ = stat(path.c_str(), &st_);
  5002. #endif
  5003. }
  5004. inline bool FileStat::is_file() const {
  5005. return ret_ >= 0 && S_ISREG(st_.st_mode);
  5006. }
  5007. inline bool FileStat::is_dir() const {
  5008. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  5009. }
  5010. inline time_t FileStat::mtime() const {
  5011. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  5012. : static_cast<time_t>(-1);
  5013. }
  5014. inline size_t FileStat::size() const {
  5015. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  5016. }
  5017. inline std::string encode_path(const std::string &s) {
  5018. std::string result;
  5019. result.reserve(s.size());
  5020. for (size_t i = 0; s[i]; i++) {
  5021. switch (s[i]) {
  5022. case ' ': result += "%20"; break;
  5023. case '+': result += "%2B"; break;
  5024. case '\'': result += "%27"; break;
  5025. case ',': result += "%2C"; break;
  5026. // case ':': result += "%3A"; break; // ok? probably...
  5027. case ';': result += "%3B"; break;
  5028. default:
  5029. auto c = static_cast<uint8_t>(s[i]);
  5030. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  5031. // in a request-target as-is.
  5032. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  5033. result += '%';
  5034. char hex[4];
  5035. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  5036. assert(len == 2);
  5037. result.append(hex, static_cast<size_t>(len));
  5038. } else {
  5039. result += s[i];
  5040. }
  5041. break;
  5042. }
  5043. }
  5044. return result;
  5045. }
  5046. inline std::string file_extension(const std::string &path) {
  5047. auto i = path.size();
  5048. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  5049. i--;
  5050. }
  5051. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  5052. return std::string();
  5053. }
  5054. return path.substr(i);
  5055. }
  5056. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  5057. template <typename T>
  5058. inline bool parse_header(const char *beg, const char *end, T fn);
  5059. template <typename T>
  5060. inline bool parse_header(const char *beg, const char *end, T fn) {
  5061. // Skip trailing spaces and tabs.
  5062. while (beg < end && is_space_or_tab(end[-1])) {
  5063. end--;
  5064. }
  5065. auto p = beg;
  5066. while (p < end && *p != ':') {
  5067. p++;
  5068. }
  5069. auto name = std::string(beg, p);
  5070. if (!detail::fields::is_field_name(name)) { return false; }
  5071. if (p == end) { return false; }
  5072. auto key_end = p;
  5073. if (*p++ != ':') { return false; }
  5074. while (p < end && is_space_or_tab(*p)) {
  5075. p++;
  5076. }
  5077. if (p <= end) {
  5078. auto key_len = key_end - beg;
  5079. if (!key_len) { return false; }
  5080. auto key = std::string(beg, key_end);
  5081. auto val = std::string(p, end);
  5082. if (!detail::fields::is_field_value(val)) { return false; }
  5083. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5084. // percent-decoded by the recipient. Applications that need to interpret a
  5085. // value as a URI component should call httplib::decode_uri_component()
  5086. // (or decode_path_component()) explicitly.
  5087. fn(key, val);
  5088. return true;
  5089. }
  5090. return false;
  5091. }
  5092. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5093. const Headers &src_headers) {
  5094. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5095. // transfer coding is complete when a chunk with a chunk-size of zero is
  5096. // received, possibly followed by a trailer section, and finally terminated by
  5097. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5098. //
  5099. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5100. // doesn't care for the existence of the final CRLF. In other words, it seems
  5101. // to be ok whether the final CRLF exists or not in the chunked data.
  5102. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5103. //
  5104. // According to the reference code in RFC 9112, cpp-httplib now allows
  5105. // chunked transfer coding data without the final CRLF.
  5106. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5107. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5108. "transfer-encoding",
  5109. "content-length",
  5110. "host",
  5111. "authorization",
  5112. "www-authenticate",
  5113. "proxy-authenticate",
  5114. "proxy-authorization",
  5115. "cookie",
  5116. "set-cookie",
  5117. "cache-control",
  5118. "expect",
  5119. "max-forwards",
  5120. "pragma",
  5121. "range",
  5122. "te",
  5123. "age",
  5124. "expires",
  5125. "date",
  5126. "location",
  5127. "retry-after",
  5128. "vary",
  5129. "warning",
  5130. "content-encoding",
  5131. "content-type",
  5132. "content-range",
  5133. "trailer"};
  5134. case_ignore::unordered_set<std::string> declared_trailers;
  5135. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5136. if (!trailer_header.empty()) {
  5137. // split() trims each token and skips empty ones, so the name arrives ready
  5138. // to look up.
  5139. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5140. ',', [&](const char *b, const char *e) {
  5141. // A legitimate message declares only a handful of trailers. Cap the
  5142. // set so a peer cannot grow it without bound: an oversized set only
  5143. // arises from an attempt to force many colliding names into
  5144. // quadratic lookups (case_ignore::hash is unkeyed).
  5145. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5146. return;
  5147. }
  5148. std::string key(b, e);
  5149. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5150. declared_trailers.insert(key);
  5151. }
  5152. });
  5153. }
  5154. size_t trailer_header_count = 0;
  5155. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5156. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5157. // Count every received trailer field, not only the declared ones stored in
  5158. // dest, so undeclared fields cannot keep this loop running past the limit.
  5159. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5160. constexpr auto line_terminator_len = 2;
  5161. auto line_beg = line_reader.ptr();
  5162. auto line_end =
  5163. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5164. if (!parse_header(line_beg, line_end,
  5165. [&](const std::string &key, const std::string &val) {
  5166. if (declared_trailers.find(key) !=
  5167. declared_trailers.end()) {
  5168. dest.emplace(key, val);
  5169. }
  5170. })) {
  5171. return false;
  5172. }
  5173. trailer_header_count++;
  5174. if (!line_reader.getline()) { return false; }
  5175. }
  5176. return true;
  5177. }
  5178. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5179. size_t right) {
  5180. while (b + left < e && is_space_or_tab(b[left])) {
  5181. left++;
  5182. }
  5183. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5184. right--;
  5185. }
  5186. return std::make_pair(left, right);
  5187. }
  5188. inline std::string trim_copy(const std::string &s) {
  5189. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5190. return s.substr(r.first, r.second - r.first);
  5191. }
  5192. inline std::string trim_double_quotes_copy(const std::string &s) {
  5193. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5194. return s.substr(1, s.size() - 2);
  5195. }
  5196. return s;
  5197. }
  5198. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5199. // here, as browsers send any other backslash, such as one in a Windows path,
  5200. // as it is.
  5201. inline std::string unquote_param(const std::string &s) {
  5202. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5203. std::string out;
  5204. for (size_t i = 1; i + 1 < s.size(); i++) {
  5205. if (s[i] == '\\' && i + 2 < s.size() &&
  5206. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5207. i++;
  5208. }
  5209. out += s[i];
  5210. }
  5211. return out;
  5212. }
  5213. inline void
  5214. divide(const char *data, std::size_t size, char d,
  5215. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5216. fn) {
  5217. const auto it = std::find(data, data + size, d);
  5218. const auto found = static_cast<std::size_t>(it != data + size);
  5219. const auto lhs_data = data;
  5220. const auto lhs_size = static_cast<std::size_t>(it - data);
  5221. const auto rhs_data = it + found;
  5222. const auto rhs_size = size - lhs_size - found;
  5223. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5224. }
  5225. inline void
  5226. divide(const std::string &str, char d,
  5227. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5228. fn) {
  5229. divide(str.data(), str.size(), d, std::move(fn));
  5230. }
  5231. inline void split(const char *b, const char *e, char d,
  5232. std::function<void(const char *, const char *)> fn) {
  5233. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5234. }
  5235. inline void split(const char *b, const char *e, char d, size_t m,
  5236. std::function<void(const char *, const char *)> fn) {
  5237. size_t i = 0;
  5238. size_t beg = 0;
  5239. size_t count = 1;
  5240. while (e ? (b + i < e) : (b[i] != '\0')) {
  5241. if (b[i] == d && count < m) {
  5242. auto r = trim(b, e, beg, i);
  5243. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5244. beg = i + 1;
  5245. count++;
  5246. }
  5247. i++;
  5248. }
  5249. if (i) {
  5250. auto r = trim(b, e, beg, i);
  5251. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5252. }
  5253. }
  5254. // Same contract as split(), except that a delimiter inside a quoted-string is
  5255. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5256. // quoted-string, and ';' and '=' are legal characters inside one.
  5257. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5258. std::function<void(const char *, const char *)> fn) {
  5259. size_t i = 0;
  5260. size_t beg = 0;
  5261. size_t count = 1;
  5262. auto in_quotes = false;
  5263. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5264. while (has(i)) {
  5265. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5266. // A quoted-pair, whose second character does not end the string.
  5267. i++;
  5268. } else if (b[i] == '"') {
  5269. in_quotes = !in_quotes;
  5270. } else if (b[i] == d && !in_quotes && count < m) {
  5271. auto r = trim(b, e, beg, i);
  5272. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5273. beg = i + 1;
  5274. count++;
  5275. }
  5276. i++;
  5277. }
  5278. if (i) {
  5279. auto r = trim(b, e, beg, i);
  5280. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5281. }
  5282. }
  5283. inline void split_unquoted(const char *b, const char *e, char d,
  5284. std::function<void(const char *, const char *)> fn) {
  5285. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5286. std::move(fn));
  5287. }
  5288. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5289. // key a token, so the first '=' is the separator even when the value is a
  5290. // quoted-string carrying more of them.
  5291. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5292. std::string &val) {
  5293. divide(
  5294. b, static_cast<std::size_t>(e - b), '=',
  5295. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5296. const auto kr = trim(kb, kb + klen, 0, klen);
  5297. key.assign(kb + kr.first, kb + kr.second);
  5298. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5299. val.assign(vb + vr.first, vb + vr.second);
  5300. });
  5301. }
  5302. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5303. std::function<bool(const char *, const char *)> fn) {
  5304. size_t i = 0;
  5305. size_t beg = 0;
  5306. size_t count = 1;
  5307. while (e ? (b + i < e) : (b[i] != '\0')) {
  5308. if (b[i] == d && count < m) {
  5309. auto r = trim(b, e, beg, i);
  5310. if (r.first < r.second) {
  5311. auto found = fn(&b[r.first], &b[r.second]);
  5312. if (found) { return true; }
  5313. }
  5314. beg = i + 1;
  5315. count++;
  5316. }
  5317. i++;
  5318. }
  5319. if (i) {
  5320. auto r = trim(b, e, beg, i);
  5321. if (r.first < r.second) {
  5322. auto found = fn(&b[r.first], &b[r.second]);
  5323. if (found) { return true; }
  5324. }
  5325. }
  5326. return false;
  5327. }
  5328. inline bool split_find(const char *b, const char *e, char d,
  5329. std::function<bool(const char *, const char *)> fn) {
  5330. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5331. std::move(fn));
  5332. }
  5333. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5334. size_t fixed_buffer_size)
  5335. : strm_(strm), fixed_buffer_(fixed_buffer),
  5336. fixed_buffer_size_(fixed_buffer_size) {}
  5337. inline const char *stream_line_reader::ptr() const {
  5338. if (growable_buffer_.empty()) {
  5339. return fixed_buffer_;
  5340. } else {
  5341. return growable_buffer_.data();
  5342. }
  5343. }
  5344. inline size_t stream_line_reader::size() const {
  5345. if (growable_buffer_.empty()) {
  5346. return fixed_buffer_used_size_;
  5347. } else {
  5348. return growable_buffer_.size();
  5349. }
  5350. }
  5351. inline bool stream_line_reader::end_with_crlf() const {
  5352. auto end = ptr() + size();
  5353. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5354. }
  5355. inline bool stream_line_reader::getline() {
  5356. fixed_buffer_used_size_ = 0;
  5357. growable_buffer_.clear();
  5358. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5359. char prev_byte = 0;
  5360. #endif
  5361. for (size_t i = 0;; i++) {
  5362. // Fast path: whatever the stream has already buffered can be scanned for
  5363. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5364. // call, a bounds check and a one-byte copy per character of the request.
  5365. size_t buffered_size = 0;
  5366. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5367. auto take = buffered_size;
  5368. auto terminated = false;
  5369. for (size_t at = 0; at < buffered_size;) {
  5370. auto nl = static_cast<const char *>(
  5371. memchr(buffered + at, '\n', buffered_size - at));
  5372. if (!nl) { break; }
  5373. auto pos = static_cast<size_t>(nl - buffered);
  5374. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5375. take = pos + 1;
  5376. terminated = true;
  5377. break;
  5378. #else
  5379. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5380. // be the last byte of an earlier chunk, hence prev_byte.
  5381. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5382. take = pos + 1;
  5383. terminated = true;
  5384. break;
  5385. }
  5386. at = pos + 1;
  5387. #endif
  5388. }
  5389. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5390. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5391. prev_byte = buffered[take - 1];
  5392. #endif
  5393. append(buffered, take);
  5394. strm_.consume_buffered(take);
  5395. i += take;
  5396. if (terminated) { return true; }
  5397. continue;
  5398. }
  5399. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5400. // Treat exceptionally long lines as an error to
  5401. // prevent infinite loops/memory exhaustion
  5402. return false;
  5403. }
  5404. char byte;
  5405. auto n = strm_.read(&byte, 1);
  5406. if (n < 0) {
  5407. return false;
  5408. } else if (n == 0) {
  5409. if (i == 0) {
  5410. return false;
  5411. } else {
  5412. break;
  5413. }
  5414. }
  5415. append(byte);
  5416. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5417. if (byte == '\n') { break; }
  5418. #else
  5419. if (prev_byte == '\r' && byte == '\n') { break; }
  5420. prev_byte = byte;
  5421. #endif
  5422. }
  5423. return true;
  5424. }
  5425. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5426. inline void stream_line_reader::append(const char *data, size_t size) {
  5427. // Once the line has outgrown the fixed buffer everything must keep going to
  5428. // the growable one, even if a later chunk would have fit. Without the
  5429. // emptiness check a short append after a long one would land in the fixed
  5430. // buffer, which ptr() and size() no longer look at, and be lost.
  5431. if (growable_buffer_.empty() &&
  5432. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5433. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5434. fixed_buffer_used_size_ += size;
  5435. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5436. } else {
  5437. // Unlike the per-character overload, this can be the very first append of
  5438. // the line, so the fixed buffer may hold nothing and carry no terminator
  5439. // yet. assign() takes an explicit length and does not need one.
  5440. if (growable_buffer_.empty()) {
  5441. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5442. }
  5443. growable_buffer_.append(data, size);
  5444. }
  5445. }
  5446. inline mmap::mmap(const char *path) { open(path); }
  5447. inline mmap::~mmap() { close(); }
  5448. inline bool mmap::open(const char *path) {
  5449. close();
  5450. #if defined(_WIN32)
  5451. auto wpath = u8string_to_wstring(path);
  5452. if (wpath.empty()) { return false; }
  5453. hFile_ =
  5454. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5455. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5456. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5457. LARGE_INTEGER size{};
  5458. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5459. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5460. // See:
  5461. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5462. if (!fits_in_size_t(static_cast<uint64_t>(size.QuadPart))) { return false; }
  5463. size_ = static_cast<size_t>(size.QuadPart);
  5464. hMapping_ =
  5465. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5466. // Special treatment for an empty file...
  5467. if (hMapping_ == NULL && size_ == 0) {
  5468. close();
  5469. is_open_empty_file = true;
  5470. return true;
  5471. }
  5472. if (hMapping_ == NULL) {
  5473. close();
  5474. return false;
  5475. }
  5476. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5477. if (addr_ == nullptr) {
  5478. close();
  5479. return false;
  5480. }
  5481. #else
  5482. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5483. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5484. if (fd_ == -1) { return false; }
  5485. // Only a regular file has a size to serve, unlike a directory or a device.
  5486. struct stat sb;
  5487. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5488. !fits_in_size_t(static_cast<uint64_t>(sb.st_size))) {
  5489. close();
  5490. return false;
  5491. }
  5492. size_ = static_cast<size_t>(sb.st_size);
  5493. #endif
  5494. return true;
  5495. }
  5496. inline bool mmap::is_open() const {
  5497. #if defined(_WIN32)
  5498. return is_open_empty_file ? true : addr_ != nullptr;
  5499. #else
  5500. return fd_ != -1;
  5501. #endif
  5502. }
  5503. inline size_t mmap::size() const { return size_; }
  5504. inline void mmap::close() {
  5505. #if defined(_WIN32)
  5506. if (addr_) {
  5507. ::UnmapViewOfFile(addr_);
  5508. addr_ = nullptr;
  5509. }
  5510. if (hMapping_) {
  5511. ::CloseHandle(hMapping_);
  5512. hMapping_ = NULL;
  5513. }
  5514. if (hFile_ != INVALID_HANDLE_VALUE) {
  5515. ::CloseHandle(hFile_);
  5516. hFile_ = INVALID_HANDLE_VALUE;
  5517. }
  5518. is_open_empty_file = false;
  5519. #else
  5520. if (fd_ != -1) {
  5521. ::close(fd_);
  5522. fd_ = -1;
  5523. }
  5524. #endif
  5525. size_ = 0;
  5526. }
  5527. inline int close_socket(socket_t sock) noexcept {
  5528. #ifdef _WIN32
  5529. return closesocket(sock);
  5530. #else
  5531. return close(sock);
  5532. #endif
  5533. }
  5534. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5535. ssize_t res = 0;
  5536. while (true) {
  5537. res = fn();
  5538. if (res < 0 && errno == EINTR) {
  5539. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5540. continue;
  5541. }
  5542. break;
  5543. }
  5544. return res;
  5545. }
  5546. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5547. if (offset >= size_) { return 0; }
  5548. len = (std::min)(len, size_ - offset);
  5549. #if defined(_WIN32)
  5550. // Windows does not let a mapped file be truncated.
  5551. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5552. return len;
  5553. #else
  5554. auto n = handle_EINTR(
  5555. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5556. return n > 0 ? static_cast<size_t>(n) : 0;
  5557. #endif
  5558. }
  5559. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5560. return handle_EINTR([&]() {
  5561. return recv(sock,
  5562. #ifdef _WIN32
  5563. static_cast<char *>(ptr), static_cast<int>(size),
  5564. #else
  5565. ptr, size,
  5566. #endif
  5567. flags);
  5568. });
  5569. }
  5570. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5571. int flags) {
  5572. return handle_EINTR([&]() {
  5573. return send(sock,
  5574. #ifdef _WIN32
  5575. static_cast<const char *>(ptr), static_cast<int>(size),
  5576. #else
  5577. ptr, size,
  5578. #endif
  5579. flags);
  5580. });
  5581. }
  5582. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5583. #ifdef _WIN32
  5584. return ::WSAPoll(fds, nfds, timeout);
  5585. #else
  5586. return ::poll(fds, nfds, timeout);
  5587. #endif
  5588. }
  5589. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5590. time_t usec) {
  5591. struct pollfd pfd;
  5592. pfd.fd = sock;
  5593. pfd.events = events;
  5594. pfd.revents = 0;
  5595. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5596. // "return immediately", which callers here rely on to probe a socket.
  5597. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5598. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5599. }
  5600. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5601. return select_impl(sock, POLLIN, sec, usec);
  5602. }
  5603. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5604. return select_impl(sock, POLLOUT, sec, usec);
  5605. }
  5606. // The point sec and usec from now, for select_until(). A negative sec never
  5607. // comes, as a negative timeout waits forever in select_impl().
  5608. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5609. time_t usec) {
  5610. if (sec < 0) { return (std::chrono::steady_clock::time_point::max)(); }
  5611. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5612. std::chrono::microseconds(usec);
  5613. }
  5614. // Waits only for the time left until deadline, so that all the waits of one
  5615. // TLS handshake come out of a single timeout.
  5616. inline ssize_t select_until(socket_t sock, short events,
  5617. std::chrono::steady_clock::time_point deadline) {
  5618. if (deadline == (std::chrono::steady_clock::time_point::max)()) {
  5619. return select_impl(sock, events, -1, 0);
  5620. }
  5621. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5622. deadline - std::chrono::steady_clock::now())
  5623. .count();
  5624. if (left <= 0) { return 0; }
  5625. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5626. static_cast<time_t>(left % 1000000));
  5627. }
  5628. // select_read(), but waits in slices and gives up once interrupted() returns
  5629. // true. A local shutdown() would not wake the wait on Windows.
  5630. inline ssize_t
  5631. select_read_interruptible(socket_t sock, time_t sec, time_t usec,
  5632. const std::function<bool()> &interrupted) {
  5633. if (!interrupted) { return select_read(sock, sec, usec); }
  5634. const auto slice = std::chrono::microseconds(100000);
  5635. auto deadline = deadline_after(sec, usec);
  5636. while (!interrupted()) {
  5637. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5638. deadline - std::chrono::steady_clock::now());
  5639. auto wait =
  5640. (std::max)((std::min)(left, slice), std::chrono::microseconds(0));
  5641. auto ret = select_impl(sock, POLLIN, 0, static_cast<time_t>(wait.count()));
  5642. if (ret != 0 || wait < slice) { return ret; }
  5643. }
  5644. return 0;
  5645. }
  5646. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5647. time_t usec) {
  5648. struct pollfd pfd_read;
  5649. pfd_read.fd = sock;
  5650. pfd_read.events = POLLIN | POLLOUT;
  5651. pfd_read.revents = 0;
  5652. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5653. auto poll_res =
  5654. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5655. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5656. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5657. auto error = 0;
  5658. socklen_t len = sizeof(error);
  5659. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5660. reinterpret_cast<char *>(&error), &len);
  5661. auto successful = res >= 0 && !error;
  5662. return successful ? Error::Success : Error::Connection;
  5663. }
  5664. return Error::Connection;
  5665. }
  5666. inline bool is_socket_alive(socket_t sock) {
  5667. const auto val = detail::select_read(sock, 0, 0);
  5668. if (val == 0) {
  5669. return true;
  5670. } else if (val < 0 && errno == EBADF) {
  5671. return false;
  5672. }
  5673. char buf[1];
  5674. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5675. }
  5676. class SocketStream final : public Stream {
  5677. public:
  5678. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5679. time_t write_timeout_sec, time_t write_timeout_usec,
  5680. time_t max_timeout_msec = 0,
  5681. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5682. (std::chrono::steady_clock::time_point::min)());
  5683. ~SocketStream() override;
  5684. bool is_readable() const override;
  5685. bool wait_readable() const override;
  5686. bool wait_writable() const override;
  5687. bool is_peer_alive() const override;
  5688. ssize_t read(char *ptr, size_t size) override;
  5689. ssize_t write(const char *ptr, size_t size) override;
  5690. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5691. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5692. socket_t socket() const override;
  5693. time_t duration() const override;
  5694. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5695. void set_max_timeout(time_t msec) override;
  5696. void set_read_interrupt(std::function<bool()> interrupted) override;
  5697. const char *buffered_data(size_t &size) const override;
  5698. void consume_buffered(size_t size) override;
  5699. // The caller has just seen this socket become readable. Lets the next read
  5700. // skip its own readiness wait, which would otherwise ask the kernel a
  5701. // question that was answered a moment ago. Consumed by that read.
  5702. void set_readable_hint() { readable_hint_ = true; }
  5703. private:
  5704. bool ensure_readable();
  5705. socket_t sock_;
  5706. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5707. // thread while a read is in flight -- that is the point of it, for a caller
  5708. // holding one connection and wanting control back to send on it.
  5709. std::atomic<time_t> read_timeout_sec_;
  5710. std::atomic<time_t> read_timeout_usec_;
  5711. time_t write_timeout_sec_;
  5712. time_t write_timeout_usec_;
  5713. time_t max_timeout_msec_;
  5714. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5715. std::function<bool()> read_interrupted_;
  5716. std::vector<char> read_buff_;
  5717. size_t read_buff_off_ = 0;
  5718. size_t read_buff_content_size_ = 0;
  5719. bool readable_hint_ = false;
  5720. static const size_t read_buff_size_ = 1024l * 4;
  5721. };
  5722. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5723. time_t keep_alive_timeout_sec) {
  5724. using namespace std::chrono;
  5725. const auto interval_usec =
  5726. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5727. // Avoid expensive `steady_clock::now()` call for the first time
  5728. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5729. const auto start = steady_clock::now() - microseconds{interval_usec};
  5730. const auto timeout = seconds{keep_alive_timeout_sec};
  5731. while (true) {
  5732. if (svr_sock == INVALID_SOCKET) {
  5733. break; // Server socket is closed
  5734. }
  5735. auto val = select_read(sock, 0, interval_usec);
  5736. if (val < 0) {
  5737. break; // Ssocket error
  5738. } else if (val == 0) {
  5739. if (steady_clock::now() - start > timeout) {
  5740. break; // Timeout
  5741. }
  5742. } else {
  5743. return true; // Ready for read
  5744. }
  5745. }
  5746. return false;
  5747. }
  5748. // `has_buffered_request` reports whether the connection's stream already holds
  5749. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5750. // 9.3.2), so reading one request can pull the start of the next one into the
  5751. // stream's buffer; that request must be served without waiting for the socket
  5752. // to become readable again, since its bytes are no longer on the socket.
  5753. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5754. template <typename P, typename T>
  5755. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5756. socket_t sock,
  5757. size_t keep_alive_max_count,
  5758. time_t keep_alive_timeout_sec,
  5759. P has_buffered_request, T callback) {
  5760. auto ret = false;
  5761. // A keep_alive_max_count of 0 sets no limit.
  5762. for (size_t served = 0;
  5763. keep_alive_max_count == 0 || served < keep_alive_max_count; served++) {
  5764. auto socket_readable = false;
  5765. if (!has_buffered_request()) {
  5766. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5767. socket_readable = true;
  5768. }
  5769. auto close_connection = served + 1 == keep_alive_max_count;
  5770. auto connection_closed = false;
  5771. ret = callback(socket_readable, close_connection, connection_closed);
  5772. if (!ret || connection_closed) { break; }
  5773. }
  5774. return ret;
  5775. }
  5776. template <typename T>
  5777. inline bool
  5778. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5779. size_t keep_alive_max_count,
  5780. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5781. time_t read_timeout_usec, time_t write_timeout_sec,
  5782. time_t write_timeout_usec, T callback) {
  5783. // One stream per connection: its read buffer can already hold the start of
  5784. // the next, pipelined request.
  5785. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5786. write_timeout_sec, write_timeout_usec);
  5787. return process_server_socket_core(
  5788. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5789. [&]() { return strm.is_readable(); },
  5790. [&](bool socket_readable, bool close_connection,
  5791. bool &connection_closed) {
  5792. if (socket_readable) { strm.set_readable_hint(); }
  5793. return callback(strm, close_connection, connection_closed);
  5794. });
  5795. }
  5796. inline bool process_client_socket(
  5797. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5798. time_t write_timeout_sec, time_t write_timeout_usec,
  5799. time_t max_timeout_msec,
  5800. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5801. std::function<bool(Stream &)> callback) {
  5802. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5803. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5804. start_time);
  5805. return callback(strm);
  5806. }
  5807. inline int shutdown_socket(socket_t sock) noexcept {
  5808. #ifdef _WIN32
  5809. return shutdown(sock, SD_BOTH);
  5810. #else
  5811. return shutdown(sock, SHUT_RDWR);
  5812. #endif
  5813. }
  5814. // Half-closes the write side and drains any in-flight/queued bytes before
  5815. // the final shutdown+close. Closing with unread data in the receive queue
  5816. // (or bytes arriving after the receive side is closed) makes the stack send
  5817. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5818. // response as a failed read even though it was fully written.
  5819. inline void drain_and_close_socket(socket_t sock) noexcept {
  5820. #ifdef _WIN32
  5821. shutdown(sock, SD_SEND);
  5822. #else
  5823. shutdown(sock, SHUT_WR);
  5824. #endif
  5825. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5826. size_t total = 0;
  5827. const auto deadline = std::chrono::steady_clock::now() +
  5828. std::chrono::milliseconds(100); // bound #1
  5829. while (total < size_t(1024u * 1024u)) { // bound #2
  5830. const auto remaining =
  5831. std::chrono::duration_cast<std::chrono::microseconds>(
  5832. deadline - std::chrono::steady_clock::now())
  5833. .count();
  5834. if (remaining <= 0) { break; }
  5835. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5836. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5837. if (n <= 0) { break; }
  5838. total += static_cast<size_t>(n);
  5839. }
  5840. shutdown_socket(sock);
  5841. close_socket(sock);
  5842. }
  5843. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5844. if (s.size() > 1 && s[0] == '\0') {
  5845. auto ret = s;
  5846. ret[0] = '@';
  5847. return ret;
  5848. }
  5849. return s;
  5850. }
  5851. inline std::string
  5852. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5853. if (s.size() > 1 && s[0] == '@') {
  5854. auto ret = s;
  5855. ret[0] = '\0';
  5856. return ret;
  5857. }
  5858. return s;
  5859. }
  5860. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5861. const struct addrinfo *hints,
  5862. struct addrinfo **res, time_t timeout_sec) {
  5863. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5864. if (timeout_sec <= 0) {
  5865. // No timeout specified, use standard getaddrinfo
  5866. return getaddrinfo(node, service, hints, res);
  5867. }
  5868. #ifdef _WIN32
  5869. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5870. OVERLAPPED overlapped = {};
  5871. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5872. if (!event) { return EAI_FAIL; }
  5873. overlapped.hEvent = event;
  5874. PADDRINFOEXW result_addrinfo = nullptr;
  5875. HANDLE cancel_handle = nullptr;
  5876. ADDRINFOEXW hints_ex = {};
  5877. if (hints) {
  5878. hints_ex.ai_flags = hints->ai_flags;
  5879. hints_ex.ai_family = hints->ai_family;
  5880. hints_ex.ai_socktype = hints->ai_socktype;
  5881. hints_ex.ai_protocol = hints->ai_protocol;
  5882. }
  5883. auto wnode = u8string_to_wstring(node);
  5884. auto wservice = u8string_to_wstring(service);
  5885. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5886. hints ? &hints_ex : nullptr, &result_addrinfo,
  5887. nullptr, &overlapped, nullptr, &cancel_handle);
  5888. if (ret == WSA_IO_PENDING) {
  5889. auto wait_result =
  5890. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5891. if (wait_result == WAIT_TIMEOUT) {
  5892. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5893. ::CloseHandle(event);
  5894. return EAI_AGAIN;
  5895. }
  5896. DWORD bytes_returned;
  5897. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5898. &bytes_returned, FALSE)) {
  5899. ::CloseHandle(event);
  5900. return ::WSAGetLastError();
  5901. }
  5902. }
  5903. ::CloseHandle(event);
  5904. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5905. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5906. return 0;
  5907. }
  5908. return ret;
  5909. #elif TARGET_OS_MAC && defined(__clang__)
  5910. if (!node) { return EAI_NONAME; }
  5911. // macOS implementation using CFHost API for asynchronous DNS resolution
  5912. CFStringRef hostname_ref = CFStringCreateWithCString(
  5913. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5914. if (!hostname_ref) { return EAI_MEMORY; }
  5915. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5916. CFRelease(hostname_ref);
  5917. if (!host_ref) { return EAI_MEMORY; }
  5918. // Set up context for callback
  5919. struct CFHostContext {
  5920. bool completed = false;
  5921. bool success = false;
  5922. CFArrayRef addresses = nullptr;
  5923. std::mutex mutex;
  5924. std::condition_variable cv;
  5925. } context;
  5926. CFHostClientContext client_context;
  5927. memset(&client_context, 0, sizeof(client_context));
  5928. client_context.info = &context;
  5929. // Set callback
  5930. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5931. const CFStreamError *error, void *info) {
  5932. auto ctx = static_cast<CFHostContext *>(info);
  5933. std::lock_guard<std::mutex> lock(ctx->mutex);
  5934. if (error && error->error != 0) {
  5935. ctx->success = false;
  5936. } else {
  5937. Boolean hasBeenResolved;
  5938. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5939. if (ctx->addresses && hasBeenResolved) {
  5940. CFRetain(ctx->addresses);
  5941. ctx->success = true;
  5942. } else {
  5943. ctx->success = false;
  5944. }
  5945. }
  5946. ctx->completed = true;
  5947. ctx->cv.notify_one();
  5948. };
  5949. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5950. CFRelease(host_ref);
  5951. return EAI_SYSTEM;
  5952. }
  5953. // Schedule on run loop
  5954. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5955. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5956. // Start resolution
  5957. CFStreamError stream_error;
  5958. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5959. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5960. CFRelease(host_ref);
  5961. return EAI_FAIL;
  5962. }
  5963. // Wait for completion with timeout
  5964. auto timeout_time =
  5965. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5966. bool timed_out = false;
  5967. {
  5968. std::unique_lock<std::mutex> lock(context.mutex);
  5969. while (!context.completed) {
  5970. auto now = std::chrono::steady_clock::now();
  5971. if (now >= timeout_time) {
  5972. timed_out = true;
  5973. break;
  5974. }
  5975. // Run the runloop for a short time
  5976. lock.unlock();
  5977. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5978. lock.lock();
  5979. }
  5980. }
  5981. // Clean up
  5982. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5983. CFHostSetClient(host_ref, nullptr, nullptr);
  5984. if (timed_out || !context.completed) {
  5985. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5986. CFRelease(host_ref);
  5987. return EAI_AGAIN;
  5988. }
  5989. if (!context.success || !context.addresses) {
  5990. CFRelease(host_ref);
  5991. return EAI_NODATA;
  5992. }
  5993. // Convert CFArray to addrinfo
  5994. CFIndex count = CFArrayGetCount(context.addresses);
  5995. if (count == 0) {
  5996. CFRelease(context.addresses);
  5997. CFRelease(host_ref);
  5998. return EAI_NODATA;
  5999. }
  6000. struct addrinfo *result_addrinfo = nullptr;
  6001. struct addrinfo **current = &result_addrinfo;
  6002. for (CFIndex i = 0; i < count; i++) {
  6003. CFDataRef addr_data =
  6004. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  6005. if (!addr_data) continue;
  6006. const struct sockaddr *sockaddr_ptr =
  6007. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  6008. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  6009. // Allocate addrinfo structure
  6010. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  6011. if (!*current) {
  6012. freeaddrinfo(result_addrinfo);
  6013. CFRelease(context.addresses);
  6014. CFRelease(host_ref);
  6015. return EAI_MEMORY;
  6016. }
  6017. memset(*current, 0, sizeof(struct addrinfo));
  6018. // Set up addrinfo fields
  6019. (*current)->ai_family = sockaddr_ptr->sa_family;
  6020. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  6021. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  6022. (*current)->ai_addrlen = sockaddr_len;
  6023. // Copy sockaddr
  6024. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  6025. if (!(*current)->ai_addr) {
  6026. freeaddrinfo(result_addrinfo);
  6027. CFRelease(context.addresses);
  6028. CFRelease(host_ref);
  6029. return EAI_MEMORY;
  6030. }
  6031. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  6032. // Set port if service is specified
  6033. if (service && *service) {
  6034. int port = 0;
  6035. if (parse_port(service, strlen(service), port)) {
  6036. if (sockaddr_ptr->sa_family == AF_INET) {
  6037. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  6038. ->sin_port = htons(static_cast<uint16_t>(port));
  6039. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  6040. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  6041. ->sin6_port = htons(static_cast<uint16_t>(port));
  6042. }
  6043. }
  6044. }
  6045. current = &((*current)->ai_next);
  6046. }
  6047. CFRelease(context.addresses);
  6048. CFRelease(host_ref);
  6049. *res = result_addrinfo;
  6050. return 0;
  6051. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  6052. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  6053. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  6054. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  6055. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  6056. // the resolver worker still references the stack-local gaicb. The cancel
  6057. // path therefore waits (gai_suspend with no timeout) for the worker to
  6058. // actually finish before letting the stack frame go. The trade-off is that
  6059. // a wedged DNS server can hold this thread for the system resolver timeout
  6060. // (~30s by default) past the caller's connection timeout.
  6061. struct gaicb request{};
  6062. struct gaicb *requests[1] = {&request};
  6063. struct sigevent sevp{};
  6064. struct timespec timeout{timeout_sec, 0};
  6065. request.ar_name = node;
  6066. request.ar_service = service;
  6067. request.ar_request = hints;
  6068. sevp.sigev_notify = SIGEV_NONE;
  6069. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  6070. if (rc != 0) { return rc; }
  6071. auto cleanup = scope_exit([&] {
  6072. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  6073. });
  6074. int wait_result = gai_suspend(requests, 1, &timeout);
  6075. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  6076. int gai_result = gai_error(&request);
  6077. if (gai_result == 0) {
  6078. *res = request.ar_result;
  6079. request.ar_result = nullptr;
  6080. return 0;
  6081. }
  6082. return gai_result;
  6083. }
  6084. gai_cancel(&request);
  6085. while (gai_error(&request) == EAI_INPROGRESS) {
  6086. gai_suspend(requests, 1, nullptr);
  6087. }
  6088. return wait_result;
  6089. #else
  6090. // Fallback implementation using thread-based timeout for other Unix systems.
  6091. struct GetAddrInfoState {
  6092. ~GetAddrInfoState() {
  6093. if (info) { freeaddrinfo(info); }
  6094. }
  6095. std::mutex mutex;
  6096. std::condition_variable result_cv;
  6097. bool completed = false;
  6098. int result = EAI_SYSTEM;
  6099. std::string node;
  6100. std::string service;
  6101. struct addrinfo hints;
  6102. struct addrinfo *info = nullptr;
  6103. };
  6104. // Allocate on the heap, so the resolver thread can keep using the data.
  6105. auto state = std::make_shared<GetAddrInfoState>();
  6106. if (node) { state->node = node; }
  6107. state->service = service;
  6108. state->hints = *hints;
  6109. std::thread resolve_thread([state]() {
  6110. auto thread_result =
  6111. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6112. &state->info);
  6113. std::lock_guard<std::mutex> lock(state->mutex);
  6114. state->result = thread_result;
  6115. state->completed = true;
  6116. state->result_cv.notify_one();
  6117. });
  6118. // Wait for completion or timeout
  6119. std::unique_lock<std::mutex> lock(state->mutex);
  6120. auto finished =
  6121. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6122. [&] { return state->completed; });
  6123. if (finished) {
  6124. // Operation completed within timeout
  6125. resolve_thread.join();
  6126. *res = state->info;
  6127. state->info = nullptr; // Pass ownership to caller
  6128. return state->result;
  6129. } else {
  6130. // Timeout occurred
  6131. resolve_thread.detach(); // Let the thread finish in background
  6132. return EAI_AGAIN; // Return timeout error
  6133. }
  6134. #endif
  6135. #else
  6136. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6137. return getaddrinfo(node, service, hints, res);
  6138. #endif
  6139. }
  6140. template <typename BindOrConnect>
  6141. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6142. int address_family, int socket_flags, bool tcp_nodelay,
  6143. bool ipv6_v6only, SocketOptions socket_options,
  6144. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6145. // Get address info
  6146. const char *node = nullptr;
  6147. struct addrinfo hints;
  6148. struct addrinfo *result;
  6149. memset(&hints, 0, sizeof(struct addrinfo));
  6150. hints.ai_socktype = SOCK_STREAM;
  6151. hints.ai_protocol = IPPROTO_IP;
  6152. if (!ip.empty()) {
  6153. node = ip.c_str();
  6154. // Ask getaddrinfo to convert IP in c-string to address
  6155. hints.ai_family = AF_UNSPEC;
  6156. hints.ai_flags = AI_NUMERICHOST;
  6157. } else {
  6158. if (!host.empty()) { node = host.c_str(); }
  6159. hints.ai_family = address_family;
  6160. hints.ai_flags = socket_flags;
  6161. }
  6162. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6163. if (hints.ai_family == AF_UNIX) {
  6164. const auto addrlen = host.length();
  6165. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6166. #ifdef SOCK_CLOEXEC
  6167. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6168. hints.ai_protocol);
  6169. #else
  6170. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6171. #endif
  6172. if (sock != INVALID_SOCKET) {
  6173. sockaddr_un addr{};
  6174. addr.sun_family = AF_UNIX;
  6175. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6176. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6177. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6178. hints.ai_addrlen = static_cast<socklen_t>(
  6179. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6180. #ifndef SOCK_CLOEXEC
  6181. #ifndef _WIN32
  6182. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6183. #endif
  6184. #endif
  6185. if (socket_options) { socket_options(sock); }
  6186. #ifdef _WIN32
  6187. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6188. // remove the option.
  6189. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6190. #endif
  6191. bool dummy;
  6192. if (!bind_or_connect(sock, hints, dummy)) {
  6193. close_socket(sock);
  6194. sock = INVALID_SOCKET;
  6195. }
  6196. }
  6197. return sock;
  6198. }
  6199. #endif
  6200. auto service = std::to_string(port);
  6201. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6202. timeout_sec)) {
  6203. #if defined __linux__ && !defined __ANDROID__
  6204. res_init();
  6205. #endif
  6206. return INVALID_SOCKET;
  6207. }
  6208. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6209. for (auto rp = result; rp; rp = rp->ai_next) {
  6210. // Create a socket
  6211. #ifdef _WIN32
  6212. auto sock =
  6213. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6214. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6215. /**
  6216. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6217. * and above the socket creation fails on older Windows Systems.
  6218. *
  6219. * Let's try to create a socket the old way in this case.
  6220. *
  6221. * Reference:
  6222. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6223. *
  6224. * WSA_FLAG_NO_HANDLE_INHERIT:
  6225. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6226. * SP1, and later
  6227. *
  6228. */
  6229. if (sock == INVALID_SOCKET) {
  6230. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6231. }
  6232. #else
  6233. #ifdef SOCK_CLOEXEC
  6234. auto sock =
  6235. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6236. #else
  6237. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6238. #endif
  6239. #endif
  6240. if (sock == INVALID_SOCKET) { continue; }
  6241. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6242. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6243. close_socket(sock);
  6244. continue;
  6245. }
  6246. #endif
  6247. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6248. if (rp->ai_family == AF_INET6) {
  6249. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6250. }
  6251. if (socket_options) { socket_options(sock); }
  6252. // bind or connect
  6253. auto quit = false;
  6254. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6255. close_socket(sock);
  6256. if (quit) { break; }
  6257. }
  6258. return INVALID_SOCKET;
  6259. }
  6260. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6261. #ifdef _WIN32
  6262. auto flags = nonblocking ? 1UL : 0UL;
  6263. ioctlsocket(sock, FIONBIO, &flags);
  6264. #else
  6265. auto flags = fcntl(sock, F_GETFL, 0);
  6266. fcntl(sock, F_SETFL,
  6267. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6268. #endif
  6269. }
  6270. inline bool is_connection_error() {
  6271. #ifdef _WIN32
  6272. return WSAGetLastError() != WSAEWOULDBLOCK;
  6273. #else
  6274. return errno != EINPROGRESS;
  6275. #endif
  6276. }
  6277. // accept() failed because the process or the network stack is temporarily out
  6278. // of resources. The listening socket is still usable, so back off briefly and
  6279. // try again.
  6280. inline bool is_accept_resource_error() {
  6281. #ifdef _WIN32
  6282. auto err = WSAGetLastError();
  6283. return err == WSAEMFILE || err == WSAENOBUFS;
  6284. #else
  6285. auto err = errno;
  6286. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6287. #endif
  6288. }
  6289. // accept() failed for a reason that says nothing about the listening socket:
  6290. // the pending connection went away before it could be accepted, or the call
  6291. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6292. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6293. // connection that way.
  6294. inline bool is_accept_transient_error() {
  6295. #ifdef _WIN32
  6296. auto err = WSAGetLastError();
  6297. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6298. err == WSAECONNABORTED;
  6299. #else
  6300. auto err = errno;
  6301. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6302. err == ECONNABORTED;
  6303. #endif
  6304. }
  6305. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6306. struct addrinfo hints;
  6307. struct addrinfo *result;
  6308. memset(&hints, 0, sizeof(struct addrinfo));
  6309. hints.ai_family = AF_UNSPEC;
  6310. hints.ai_socktype = SOCK_STREAM;
  6311. hints.ai_protocol = 0;
  6312. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6313. return false;
  6314. }
  6315. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6316. auto ret = false;
  6317. for (auto rp = result; rp; rp = rp->ai_next) {
  6318. const auto &ai = *rp;
  6319. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6320. ret = true;
  6321. break;
  6322. }
  6323. }
  6324. return ret;
  6325. }
  6326. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6327. #define USE_IF2IP
  6328. #endif
  6329. #ifdef USE_IF2IP
  6330. inline std::string if2ip(int address_family, const std::string &ifn) {
  6331. struct ifaddrs *ifap;
  6332. getifaddrs(&ifap);
  6333. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6334. std::string addr_candidate;
  6335. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6336. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6337. (AF_UNSPEC == address_family ||
  6338. ifa->ifa_addr->sa_family == address_family)) {
  6339. if (ifa->ifa_addr->sa_family == AF_INET) {
  6340. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6341. char buf[INET_ADDRSTRLEN];
  6342. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6343. return std::string(buf, INET_ADDRSTRLEN);
  6344. }
  6345. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6346. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6347. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6348. char buf[INET6_ADDRSTRLEN] = {};
  6349. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6350. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6351. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6352. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6353. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6354. } else {
  6355. return std::string(buf, INET6_ADDRSTRLEN);
  6356. }
  6357. }
  6358. }
  6359. }
  6360. }
  6361. }
  6362. return addr_candidate;
  6363. }
  6364. #endif
  6365. inline socket_t create_client_socket(
  6366. const std::string &host, const std::string &ip, int port,
  6367. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6368. SocketOptions socket_options, time_t connection_timeout_sec,
  6369. time_t connection_timeout_usec, time_t read_timeout_sec,
  6370. time_t read_timeout_usec, time_t write_timeout_sec,
  6371. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6372. auto sock = create_socket(
  6373. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6374. std::move(socket_options),
  6375. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6376. if (!intf.empty()) {
  6377. #ifdef USE_IF2IP
  6378. auto ip_from_if = if2ip(address_family, intf);
  6379. if (ip_from_if.empty()) { ip_from_if = intf; }
  6380. if (!bind_ip_address(sock2, ip_from_if)) {
  6381. error = Error::BindIPAddress;
  6382. return false;
  6383. }
  6384. #endif
  6385. }
  6386. set_nonblocking(sock2, true);
  6387. auto ret =
  6388. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6389. if (ret < 0) {
  6390. if (is_connection_error()) {
  6391. error = Error::Connection;
  6392. return false;
  6393. }
  6394. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6395. connection_timeout_usec);
  6396. if (error != Error::Success) {
  6397. if (error == Error::ConnectionTimeout) { quit = true; }
  6398. return false;
  6399. }
  6400. }
  6401. set_nonblocking(sock2, false);
  6402. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6403. read_timeout_usec);
  6404. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6405. write_timeout_usec);
  6406. error = Error::Success;
  6407. return true;
  6408. },
  6409. connection_timeout_sec); // Pass DNS timeout
  6410. if (sock != INVALID_SOCKET) {
  6411. error = Error::Success;
  6412. } else {
  6413. if (error == Error::Success) { error = Error::Connection; }
  6414. }
  6415. return sock;
  6416. }
  6417. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6418. socklen_t addr_len, std::string &ip, int &port) {
  6419. if (addr.ss_family == AF_INET) {
  6420. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6421. } else if (addr.ss_family == AF_INET6) {
  6422. port =
  6423. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6424. } else {
  6425. return false;
  6426. }
  6427. std::array<char, NI_MAXHOST> ipstr{};
  6428. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6429. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6430. 0, NI_NUMERICHOST)) {
  6431. return false;
  6432. }
  6433. ip = ipstr.data();
  6434. return true;
  6435. }
  6436. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6437. struct sockaddr_storage addr;
  6438. socklen_t addr_len = sizeof(addr);
  6439. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6440. &addr_len)) {
  6441. get_ip_and_port(addr, addr_len, ip, port);
  6442. }
  6443. }
  6444. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6445. struct sockaddr_storage addr;
  6446. socklen_t addr_len = sizeof(addr);
  6447. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6448. &addr_len)) {
  6449. #ifndef _WIN32
  6450. if (addr.ss_family == AF_UNIX) {
  6451. #if defined(__linux__)
  6452. struct ucred ucred;
  6453. socklen_t len = sizeof(ucred);
  6454. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6455. port = ucred.pid;
  6456. }
  6457. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6458. pid_t pid;
  6459. socklen_t len = sizeof(pid);
  6460. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6461. port = pid;
  6462. }
  6463. #endif
  6464. return;
  6465. }
  6466. #endif
  6467. get_ip_and_port(addr, addr_len, ip, port);
  6468. }
  6469. }
  6470. inline std::string
  6471. find_content_type(const std::string &path,
  6472. const std::map<std::string, std::string> &user_data,
  6473. const std::string &default_content_type) {
  6474. auto ext = file_extension(path);
  6475. // Extensions are matched regardless of case, as web servers do, with an
  6476. // exact match to a user mapping first
  6477. auto lower_ext = case_ignore::to_lower(ext);
  6478. auto it = user_data.find(ext);
  6479. if (it == user_data.end()) { it = user_data.find(lower_ext); }
  6480. if (it != user_data.end()) { return it->second; }
  6481. static const struct {
  6482. const char *ext;
  6483. const char *type;
  6484. } types[] = {
  6485. {"css", "text/css"},
  6486. {"csv", "text/csv"},
  6487. {"htm", "text/html"},
  6488. {"html", "text/html"},
  6489. {"js", "text/javascript"},
  6490. {"mjs", "text/javascript"},
  6491. {"txt", "text/plain"},
  6492. {"vtt", "text/vtt"},
  6493. {"apng", "image/apng"},
  6494. {"avif", "image/avif"},
  6495. {"bmp", "image/bmp"},
  6496. {"gif", "image/gif"},
  6497. {"png", "image/png"},
  6498. {"svg", "image/svg+xml"},
  6499. {"webp", "image/webp"},
  6500. {"ico", "image/x-icon"},
  6501. {"tif", "image/tiff"},
  6502. {"tiff", "image/tiff"},
  6503. {"jpg", "image/jpeg"},
  6504. {"jpeg", "image/jpeg"},
  6505. {"mp4", "video/mp4"},
  6506. {"mpeg", "video/mpeg"},
  6507. {"webm", "video/webm"},
  6508. {"mp3", "audio/mp3"},
  6509. {"mpga", "audio/mpeg"},
  6510. {"weba", "audio/webm"},
  6511. {"wav", "audio/wave"},
  6512. {"otf", "font/otf"},
  6513. {"ttf", "font/ttf"},
  6514. {"woff", "font/woff"},
  6515. {"woff2", "font/woff2"},
  6516. {"7z", "application/x-7z-compressed"},
  6517. {"atom", "application/atom+xml"},
  6518. {"pdf", "application/pdf"},
  6519. {"json", "application/json"},
  6520. {"rss", "application/rss+xml"},
  6521. {"tar", "application/x-tar"},
  6522. {"xht", "application/xhtml+xml"},
  6523. {"xhtml", "application/xhtml+xml"},
  6524. {"xslt", "application/xslt+xml"},
  6525. {"xml", "application/xml"},
  6526. {"gz", "application/gzip"},
  6527. {"zip", "application/zip"},
  6528. {"wasm", "application/wasm"},
  6529. };
  6530. for (const auto &t : types) {
  6531. if (lower_ext == t.ext) { return t.type; }
  6532. }
  6533. return default_content_type;
  6534. }
  6535. inline std::string
  6536. extract_media_type(const std::string &content_type,
  6537. std::map<std::string, std::string> *params = nullptr) {
  6538. // Extract type/subtype from Content-Type value (RFC 2045)
  6539. // e.g. "application/json; charset=utf-8" -> "application/json"
  6540. auto media_type = content_type;
  6541. auto semicolon_pos = media_type.find(';');
  6542. if (semicolon_pos != std::string::npos) {
  6543. auto param_str = media_type.substr(semicolon_pos + 1);
  6544. media_type = media_type.substr(0, semicolon_pos);
  6545. if (params) {
  6546. // Parse parameters: key=value pairs separated by ';'
  6547. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6548. [&](const char *b, const char *e) {
  6549. std::string key;
  6550. std::string val;
  6551. divide_param_pair(b, e, key, val);
  6552. // Parameter names are case-insensitive (RFC 9110
  6553. // §5.6.6)
  6554. if (!key.empty()) {
  6555. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6556. unquote_param(val));
  6557. }
  6558. });
  6559. }
  6560. }
  6561. // Trim whitespace from media type
  6562. return trim_copy(media_type);
  6563. }
  6564. inline bool can_compress_content_type(const std::string &content_type) {
  6565. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6566. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6567. static const char *const compressible[] = {
  6568. "image/svg+xml",
  6569. "application/javascript",
  6570. "application/x-javascript",
  6571. "application/json",
  6572. "application/ld+json",
  6573. "application/xml",
  6574. "application/xhtml+xml",
  6575. "application/rss+xml",
  6576. "application/atom+xml",
  6577. "application/xslt+xml",
  6578. "application/protobuf",
  6579. };
  6580. for (auto type : compressible) {
  6581. if (mime_type == type) { return true; }
  6582. }
  6583. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6584. }
  6585. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6586. double &quality) {
  6587. quality = 1.0;
  6588. token.clear();
  6589. // Split on first ';': left = token name, right = parameters
  6590. const char *params_b = nullptr;
  6591. std::size_t params_len = 0;
  6592. divide(
  6593. b, static_cast<std::size_t>(e - b), ';',
  6594. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6595. auto r = trim(lb, lb + llen, 0, llen);
  6596. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6597. params_b = rb;
  6598. params_len = rlen;
  6599. });
  6600. if (token.empty()) { return false; }
  6601. if (params_len == 0) { return true; }
  6602. // Scan parameters for q= (stops on first match)
  6603. bool invalid = false;
  6604. split_find(params_b, params_b + params_len, ';',
  6605. (std::numeric_limits<size_t>::max)(),
  6606. [&](const char *pb, const char *pe) -> bool {
  6607. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6608. auto len = static_cast<size_t>(pe - pb);
  6609. if (len < 2) { return false; }
  6610. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6611. return false;
  6612. }
  6613. // Trim the value portion
  6614. auto r = trim(pb, pe, 2, len);
  6615. if (r.first >= r.second) {
  6616. invalid = true;
  6617. return true;
  6618. }
  6619. double v = 0.0;
  6620. auto res = from_chars(pb + r.first, pb + r.second, v);
  6621. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6622. v < 0.0 || v > 1.0) {
  6623. invalid = true;
  6624. return true;
  6625. }
  6626. quality = v;
  6627. return true;
  6628. });
  6629. return !invalid;
  6630. }
  6631. inline EncodingType encoding_type(const Request &req,
  6632. const std::string &content_type) {
  6633. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6634. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6635. if (s.empty()) { return EncodingType::None; }
  6636. // Single-pass: iterate tokens and track the best supported encoding.
  6637. // Server preference breaks ties (br > gzip > zstd).
  6638. EncodingType best = EncodingType::None;
  6639. double best_q = 0.0; // q=0 means "not acceptable"
  6640. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6641. auto priority = [](EncodingType t) -> int {
  6642. switch (t) {
  6643. case EncodingType::Brotli: return 0;
  6644. case EncodingType::Gzip: return 1;
  6645. case EncodingType::Zstd: return 2;
  6646. default: return 3;
  6647. }
  6648. };
  6649. std::string name;
  6650. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6651. double quality = 1.0;
  6652. if (!parse_quality(b, e, name, quality)) { return; }
  6653. if (quality <= 0.0) { return; }
  6654. EncodingType type = EncodingType::None;
  6655. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6656. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6657. #endif
  6658. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6659. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6660. type = EncodingType::Gzip;
  6661. }
  6662. #endif
  6663. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6664. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6665. type = EncodingType::Zstd;
  6666. }
  6667. #endif
  6668. if (type == EncodingType::None) { return; }
  6669. // Higher q-value wins; for equal q, server preference breaks ties
  6670. if (quality > best_q ||
  6671. (quality == best_q && priority(type) < priority(best))) {
  6672. best_q = quality;
  6673. best = type;
  6674. }
  6675. });
  6676. return best;
  6677. }
  6678. // `content_type` is taken separately because a file-backed response has not
  6679. // been given one yet when its coding has to be decided.
  6680. inline EncodingType encoding_type(const Request &req, const Response &res,
  6681. const std::string &content_type) {
  6682. // The response already names a content coding of its own: a handler serving
  6683. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6684. // point whose headers name the coding its files are stored in. Applying one
  6685. // on top of that would double-encode the body and append a second
  6686. // `Content-Encoding` field line.
  6687. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6688. return encoding_type(req, content_type);
  6689. }
  6690. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6691. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6692. }
  6693. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6694. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6695. if (type == EncodingType::Gzip) {
  6696. return detail::make_unique<gzip_compressor>();
  6697. }
  6698. #endif
  6699. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6700. if (type == EncodingType::Brotli) {
  6701. return detail::make_unique<brotli_compressor>();
  6702. }
  6703. #endif
  6704. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6705. if (type == EncodingType::Zstd) {
  6706. return detail::make_unique<zstd_compressor>();
  6707. }
  6708. #endif
  6709. (void)type;
  6710. return nullptr;
  6711. }
  6712. inline const char *encoding_name(EncodingType type) {
  6713. switch (type) {
  6714. case EncodingType::Gzip: return "gzip";
  6715. case EncodingType::Brotli: return "br";
  6716. case EncodingType::Zstd: return "zstd";
  6717. default: return "";
  6718. }
  6719. }
  6720. inline bool nocompressor::compress(const char *data, size_t data_length,
  6721. bool /*last*/, Callback callback) {
  6722. if (!data_length) { return true; }
  6723. return callback(data, data_length);
  6724. }
  6725. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6726. inline gzip_compressor::gzip_compressor() {
  6727. std::memset(&strm_, 0, sizeof(strm_));
  6728. strm_.zalloc = Z_NULL;
  6729. strm_.zfree = Z_NULL;
  6730. strm_.opaque = Z_NULL;
  6731. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6732. Z_DEFAULT_STRATEGY) == Z_OK;
  6733. }
  6734. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6735. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6736. bool last, Callback callback) {
  6737. assert(is_valid_);
  6738. do {
  6739. constexpr size_t max_avail_in =
  6740. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6741. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6742. (std::min)(data_length, max_avail_in));
  6743. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6744. data_length -= strm_.avail_in;
  6745. data += strm_.avail_in;
  6746. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6747. auto ret = Z_OK;
  6748. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6749. do {
  6750. strm_.avail_out = static_cast<uInt>(buff.size());
  6751. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6752. ret = deflate(&strm_, flush);
  6753. if (ret == Z_STREAM_ERROR) { return false; }
  6754. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6755. return false;
  6756. }
  6757. } while (strm_.avail_out == 0);
  6758. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6759. (flush == Z_NO_FLUSH && ret == Z_OK));
  6760. assert(strm_.avail_in == 0);
  6761. } while (data_length > 0);
  6762. return true;
  6763. }
  6764. inline gzip_decompressor::gzip_decompressor() {
  6765. std::memset(&strm_, 0, sizeof(strm_));
  6766. strm_.zalloc = Z_NULL;
  6767. strm_.zfree = Z_NULL;
  6768. strm_.opaque = Z_NULL;
  6769. // 15 is the value of wbits, which should be at the maximum possible value
  6770. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6771. // that the stream type should be automatically detected either gzip or
  6772. // deflate.
  6773. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6774. }
  6775. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6776. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6777. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6778. Callback callback) {
  6779. assert(is_valid_);
  6780. auto ret = Z_OK;
  6781. do {
  6782. constexpr size_t max_avail_in =
  6783. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6784. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6785. (std::min)(data_length, max_avail_in));
  6786. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6787. data_length -= strm_.avail_in;
  6788. data += strm_.avail_in;
  6789. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6790. while (strm_.avail_in > 0 && ret == Z_OK) {
  6791. strm_.avail_out = static_cast<uInt>(buff.size());
  6792. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6793. ret = inflate(&strm_, Z_NO_FLUSH);
  6794. assert(ret != Z_STREAM_ERROR);
  6795. switch (ret) {
  6796. case Z_NEED_DICT:
  6797. case Z_DATA_ERROR:
  6798. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6799. }
  6800. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6801. return false;
  6802. }
  6803. }
  6804. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6805. } while (data_length > 0);
  6806. return true;
  6807. }
  6808. #endif
  6809. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6810. inline brotli_compressor::brotli_compressor() {
  6811. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6812. }
  6813. inline brotli_compressor::~brotli_compressor() {
  6814. BrotliEncoderDestroyInstance(state_);
  6815. }
  6816. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6817. bool last, Callback callback) {
  6818. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6819. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6820. auto available_in = data_length;
  6821. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6822. for (;;) {
  6823. if (last) {
  6824. if (BrotliEncoderIsFinished(state_)) { break; }
  6825. } else {
  6826. if (!available_in) { break; }
  6827. }
  6828. auto available_out = buff.size();
  6829. auto next_out = buff.data();
  6830. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6831. &available_out, &next_out, nullptr)) {
  6832. return false;
  6833. }
  6834. auto output_bytes = buff.size() - available_out;
  6835. if (output_bytes) {
  6836. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6837. }
  6838. }
  6839. return true;
  6840. }
  6841. inline brotli_decompressor::brotli_decompressor() {
  6842. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6843. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6844. : BROTLI_DECODER_RESULT_ERROR;
  6845. }
  6846. inline brotli_decompressor::~brotli_decompressor() {
  6847. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6848. }
  6849. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6850. inline bool brotli_decompressor::decompress(const char *data,
  6851. size_t data_length,
  6852. Callback callback) {
  6853. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6854. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6855. return 0;
  6856. }
  6857. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6858. size_t avail_in = data_length;
  6859. size_t total_out;
  6860. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6861. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6862. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6863. char *next_out = buff.data();
  6864. size_t avail_out = buff.size();
  6865. decoder_r = BrotliDecoderDecompressStream(
  6866. decoder_s, &avail_in, &next_in, &avail_out,
  6867. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6868. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6869. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6870. }
  6871. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6872. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6873. }
  6874. #endif
  6875. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6876. inline zstd_compressor::zstd_compressor() {
  6877. ctx_ = ZSTD_createCCtx();
  6878. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6879. }
  6880. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6881. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6882. bool last, Callback callback) {
  6883. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6884. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6885. ZSTD_inBuffer input = {data, data_length, 0};
  6886. bool finished;
  6887. do {
  6888. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6889. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6890. if (ZSTD_isError(remaining)) { return false; }
  6891. if (!callback(buff.data(), output.pos)) { return false; }
  6892. finished = last ? (remaining == 0) : (input.pos == input.size);
  6893. } while (!finished);
  6894. return true;
  6895. }
  6896. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6897. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6898. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6899. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6900. Callback callback) {
  6901. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6902. ZSTD_inBuffer input = {data, data_length, 0};
  6903. while (input.pos < input.size) {
  6904. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6905. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6906. if (ZSTD_isError(remaining)) { return false; }
  6907. if (!callback(buff.data(), output.pos)) { return false; }
  6908. }
  6909. return true;
  6910. }
  6911. #endif
  6912. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6913. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6914. // unknown coding, and its payload would be handed back still compressed.
  6915. inline bool is_zlib_encoding(const std::string &encoding) {
  6916. return case_ignore::equal(encoding, "gzip") ||
  6917. case_ignore::equal(encoding, "deflate");
  6918. }
  6919. inline bool is_brotli_encoding(const std::string &encoding) {
  6920. return case_ignore::equal(encoding, "br");
  6921. }
  6922. inline bool is_zstd_encoding(const std::string &encoding) {
  6923. return case_ignore::equal(encoding, "zstd");
  6924. }
  6925. // Returns true if the content coding is one cpp-httplib is able to decompress
  6926. // when the corresponding support is compiled in.
  6927. inline bool is_known_content_encoding(const std::string &encoding) {
  6928. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6929. is_zstd_encoding(encoding);
  6930. }
  6931. inline std::unique_ptr<decompressor>
  6932. create_decompressor(const std::string &encoding) {
  6933. std::unique_ptr<decompressor> decompressor;
  6934. if (is_zlib_encoding(encoding)) {
  6935. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6936. decompressor = detail::make_unique<gzip_decompressor>();
  6937. #endif
  6938. } else if (is_brotli_encoding(encoding)) {
  6939. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6940. decompressor = detail::make_unique<brotli_decompressor>();
  6941. #endif
  6942. } else if (is_zstd_encoding(encoding)) {
  6943. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6944. decompressor = detail::make_unique<zstd_decompressor>();
  6945. #endif
  6946. }
  6947. return decompressor;
  6948. }
  6949. // Returns the best available compressor and its Content-Encoding name.
  6950. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6951. inline std::pair<std::unique_ptr<compressor>, const char *>
  6952. create_compressor() {
  6953. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6954. return {detail::make_unique<brotli_compressor>(), "br"};
  6955. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6956. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6957. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6958. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6959. #else
  6960. return {nullptr, nullptr};
  6961. #endif
  6962. }
  6963. inline bool is_prohibited_header_name(const std::string &name) {
  6964. // Field names are case-insensitive (RFC 9110 §5.1)
  6965. return case_ignore::equal(name, "REMOTE_ADDR") ||
  6966. case_ignore::equal(name, "REMOTE_PORT") ||
  6967. case_ignore::equal(name, "LOCAL_ADDR") ||
  6968. case_ignore::equal(name, "LOCAL_PORT");
  6969. }
  6970. inline bool has_header(const Headers &headers, const std::string &key) {
  6971. if (is_prohibited_header_name(key)) { return false; }
  6972. return headers.find(key) != headers.end();
  6973. }
  6974. inline const char *get_header_value(const Headers &headers,
  6975. const std::string &key, const char *def,
  6976. size_t id) {
  6977. if (is_prohibited_header_name(key)) {
  6978. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6979. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6980. throw std::invalid_argument(msg);
  6981. #else
  6982. return "";
  6983. #endif
  6984. }
  6985. auto rng = headers.equal_range(key);
  6986. auto it = bounded_next(rng.first, id, rng.second);
  6987. if (it != rng.second) { return it->second.c_str(); }
  6988. return def;
  6989. }
  6990. inline size_t get_header_value_count(const Headers &headers,
  6991. const std::string &key) {
  6992. return headers.count(key);
  6993. }
  6994. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6995. // list may be sent as several field lines, and the combined field value is
  6996. // those values joined by commas in the order they were received. Callers that
  6997. // parse such a list must work on the combined value; reading only the first
  6998. // occurrence silently drops whatever the later field lines carry.
  6999. inline std::string get_combined_header_value(const Headers &headers,
  7000. const std::string &key) {
  7001. std::string combined;
  7002. auto rng = headers.equal_range(key);
  7003. for (auto it = rng.first; it != rng.second; ++it) {
  7004. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  7005. // elements, so an empty field line must not contribute a bare comma to the
  7006. // combined value.
  7007. if (it->second.empty()) { continue; }
  7008. if (!combined.empty()) { combined += ", "; }
  7009. combined += it->second;
  7010. }
  7011. return combined;
  7012. }
  7013. inline bool has_header_token(const Headers &headers, const std::string &key,
  7014. const std::string &token) {
  7015. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  7016. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  7017. // several lines. Match complete tokens rather than searching the raw value,
  7018. // so that a value such as "notupgrade" is not read as the token "upgrade".
  7019. auto rng = headers.equal_range(key);
  7020. for (auto it = rng.first; it != rng.second; ++it) {
  7021. const auto &value = it->second;
  7022. if (split_find(value.data(), value.data() + value.size(), ',',
  7023. [&](const char *b, const char *e) {
  7024. return case_ignore::equal(std::string(b, e), token);
  7025. })) {
  7026. return true;
  7027. }
  7028. }
  7029. return false;
  7030. }
  7031. template <typename Map>
  7032. inline typename Map::mapped_type
  7033. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  7034. auto rng = m.equal_range(key);
  7035. auto it = bounded_next(rng.first, id, rng.second);
  7036. if (it != rng.second) { return it->second; }
  7037. return typename Map::mapped_type();
  7038. }
  7039. inline void set_header(Headers &headers, const std::string &key,
  7040. const std::string &val) {
  7041. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  7042. }
  7043. inline bool read_headers(Stream &strm, Headers &headers) {
  7044. const auto bufsiz = 2048;
  7045. char buf[bufsiz];
  7046. stream_line_reader line_reader(strm, buf, bufsiz);
  7047. size_t header_count = 0;
  7048. for (;;) {
  7049. if (!line_reader.getline()) { return false; }
  7050. // Check if the line ends with CRLF.
  7051. auto line_terminator_len = 2;
  7052. if (line_reader.end_with_crlf()) {
  7053. // Blank line indicates end of headers.
  7054. if (line_reader.size() == 2) { break; }
  7055. } else {
  7056. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7057. // Blank line indicates end of headers.
  7058. if (line_reader.size() == 1) { break; }
  7059. line_terminator_len = 1;
  7060. #else
  7061. continue; // Skip invalid line.
  7062. #endif
  7063. }
  7064. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7065. // Check header count limit
  7066. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7067. // Exclude line terminator
  7068. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7069. if (!parse_header(line_reader.ptr(), end,
  7070. [&](const std::string &key, const std::string &val) {
  7071. headers.emplace(key, val);
  7072. })) {
  7073. return false;
  7074. }
  7075. header_count++;
  7076. }
  7077. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7078. // headers that have different values to prevent request smuggling.
  7079. auto cl_range = headers.equal_range("Content-Length");
  7080. if (cl_range.first != cl_range.second) {
  7081. const auto &first_val = cl_range.first->second;
  7082. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7083. if (it->second != first_val) { return false; }
  7084. }
  7085. }
  7086. return true;
  7087. }
  7088. // Parsed by hand: std::regex_match recurses once per character of the reason
  7089. // phrase, which a server can make as long as a whole line.
  7090. inline bool parse_status_line(const char *line, std::string &version,
  7091. int &status, std::string &reason) {
  7092. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7093. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7094. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7095. !is_ascii_digit(line[11])) {
  7096. return false;
  7097. }
  7098. auto p = line + 12;
  7099. auto reason_begin = p;
  7100. if (*p == ' ') {
  7101. reason_begin = ++p;
  7102. p += std::strcspn(p, "\r\n");
  7103. }
  7104. auto reason_end = p;
  7105. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7106. if (*p == '\r') { p++; }
  7107. #else
  7108. if (*p++ != '\r') { return false; }
  7109. #endif
  7110. if (*p++ != '\n' || *p != '\0') { return false; }
  7111. version.assign(line, 8);
  7112. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7113. reason.assign(reason_begin, reason_end);
  7114. return true;
  7115. }
  7116. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7117. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7118. struct WebSocketUpgradeResponse {
  7119. Error error = Error::Success;
  7120. int status = -1;
  7121. Headers headers;
  7122. std::string selected_subprotocol;
  7123. };
  7124. // Reads a response's status line and headers, leaving any body unread. An
  7125. // unparsable status line is no stream error; it just leaves `status` as is.
  7126. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7127. const auto bufsiz = 2048;
  7128. char buf[bufsiz];
  7129. stream_line_reader line_reader(strm, buf, bufsiz);
  7130. if (!line_reader.getline()) { return false; }
  7131. std::string version;
  7132. std::string reason;
  7133. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7134. return true;
  7135. }
  7136. return read_headers(strm, headers);
  7137. }
  7138. inline bool
  7139. read_websocket_upgrade_response(Stream &strm,
  7140. const std::string &expected_accept,
  7141. const std::string &offered_subprotocols,
  7142. WebSocketUpgradeResponse &upgrade) {
  7143. // The headers of a rejection are kept so the caller can see why the server
  7144. // refused the upgrade.
  7145. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7146. upgrade.error = Error::Read;
  7147. return false;
  7148. }
  7149. const auto &headers = upgrade.headers;
  7150. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7151. upgrade.error = Error::WebSocketHandshake;
  7152. return false;
  7153. }
  7154. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7155. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7156. upgrade.error = Error::WebSocketHandshake;
  7157. return false;
  7158. }
  7159. // Verify Connection: Upgrade
  7160. if (!has_header_token(headers, "Connection", "upgrade")) {
  7161. upgrade.error = Error::WebSocketHandshake;
  7162. return false;
  7163. }
  7164. // Verify Sec-WebSocket-Accept header value
  7165. auto it = headers.find("Sec-WebSocket-Accept");
  7166. if (it == headers.end() || it->second != expected_accept) {
  7167. upgrade.error = Error::WebSocketHandshake;
  7168. return false;
  7169. }
  7170. // Extract negotiated subprotocol
  7171. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7172. if (proto_it != headers.end()) {
  7173. upgrade.selected_subprotocol = proto_it->second;
  7174. }
  7175. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7176. if (!upgrade.selected_subprotocol.empty()) {
  7177. auto was_offered = false;
  7178. split(offered_subprotocols.data(),
  7179. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7180. [&](const char *b, const char *e) {
  7181. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7182. was_offered = true;
  7183. }
  7184. });
  7185. if (!was_offered) {
  7186. upgrade.error = Error::WebSocketHandshake;
  7187. return false;
  7188. }
  7189. }
  7190. return true;
  7191. }
  7192. enum class ReadContentResult {
  7193. Success, // Successfully read the content
  7194. PayloadTooLarge, // The content exceeds the specified payload limit
  7195. Error // An error occurred while reading the content
  7196. };
  7197. inline ReadContentResult read_content_with_length(
  7198. Stream &strm, size_t len, DownloadProgress progress,
  7199. ContentReceiverWithProgress out,
  7200. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7201. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7202. detail::BodyReader br;
  7203. br.stream = &strm;
  7204. br.has_content_length = true;
  7205. br.content_length = len;
  7206. br.payload_max_length = payload_max_length;
  7207. br.chunked = false;
  7208. br.bytes_read = 0;
  7209. br.last_error = Error::Success;
  7210. size_t r = 0;
  7211. while (r < len) {
  7212. auto read_len = static_cast<size_t>(len - r);
  7213. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7214. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7215. if (n <= 0) {
  7216. // Check if it was a payload size error
  7217. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7218. return ReadContentResult::PayloadTooLarge;
  7219. }
  7220. return ReadContentResult::Error;
  7221. }
  7222. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7223. return ReadContentResult::Error;
  7224. }
  7225. r += static_cast<size_t>(n);
  7226. if (progress) {
  7227. if (!progress(r, len)) { return ReadContentResult::Error; }
  7228. }
  7229. }
  7230. return ReadContentResult::Success;
  7231. }
  7232. inline ReadContentResult
  7233. read_content_without_length(Stream &strm, size_t payload_max_length,
  7234. ContentReceiverWithProgress out) {
  7235. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7236. size_t r = 0;
  7237. for (;;) {
  7238. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7239. if (n == 0) { return ReadContentResult::Success; }
  7240. if (n < 0) { return ReadContentResult::Error; }
  7241. // Check if adding this data would exceed the payload limit
  7242. if (payload_max_length > 0 &&
  7243. (r > payload_max_length ||
  7244. payload_max_length - r < static_cast<size_t>(n))) {
  7245. return ReadContentResult::PayloadTooLarge;
  7246. }
  7247. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7248. return ReadContentResult::Error;
  7249. }
  7250. r += static_cast<size_t>(n);
  7251. }
  7252. return ReadContentResult::Success;
  7253. }
  7254. template <typename T>
  7255. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7256. size_t payload_max_length,
  7257. ContentReceiverWithProgress out) {
  7258. detail::ChunkedDecoder dec(strm);
  7259. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7260. size_t total_len = 0;
  7261. for (;;) {
  7262. size_t chunk_offset = 0;
  7263. size_t chunk_total = 0;
  7264. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7265. if (n < 0) { return ReadContentResult::Error; }
  7266. if (n == 0) {
  7267. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7268. return ReadContentResult::Error;
  7269. }
  7270. return ReadContentResult::Success;
  7271. }
  7272. if (payload_max_length > 0 &&
  7273. (total_len > payload_max_length ||
  7274. payload_max_length - total_len < static_cast<size_t>(n))) {
  7275. return ReadContentResult::PayloadTooLarge;
  7276. }
  7277. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7278. return ReadContentResult::Error;
  7279. }
  7280. total_len += static_cast<size_t>(n);
  7281. }
  7282. }
  7283. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7284. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7285. // is the final transfer coding. A single field value may list several
  7286. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7287. // several Transfer-Encoding lines, which combine into one comma-separated
  7288. // list in the order the lines were received. Headers preserves that order,
  7289. // so the final coding is the last token of the last line. Match it
  7290. // case-insensitively rather than comparing the whole value against
  7291. // "chunked".
  7292. //
  7293. // Security: reading a chunked message as unframed leaves its body in the
  7294. // socket, where a keep-alive connection parses it as a smuggled request.
  7295. // Server::process_request() answers 400 and closes when the final coding is
  7296. // not chunked, so a request whose framing cannot be determined never
  7297. // reaches the "no body" path.
  7298. auto rng = headers.equal_range("Transfer-Encoding");
  7299. if (rng.first == rng.second) { return false; }
  7300. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7301. // combined list ending in nothing rather than inheriting the line before it.
  7302. std::string last_coding;
  7303. for (auto it = rng.first; it != rng.second; ++it) {
  7304. const auto &value = it->second;
  7305. last_coding.clear();
  7306. split(value.data(), value.data() + value.size(), ',',
  7307. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7308. }
  7309. return case_ignore::equal(last_coding, "chunked");
  7310. }
  7311. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7312. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7313. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7314. return msg.has_header("Transfer-Encoding") &&
  7315. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7316. }
  7317. inline bool has_conflicting_content_length(const Headers &headers) {
  7318. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7319. // Content-Length is framed ambiguously. The body readers here delimit it by
  7320. // the transfer coding and drop Content-Length, while an intermediary may do
  7321. // the reverse, so the two disagree on where the body ends and a reused
  7322. // connection is desynchronised (request/response smuggling). Content-Length:
  7323. // 0 is tolerated for compatibility with existing peers.
  7324. return has_header(headers, "Transfer-Encoding") &&
  7325. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7326. }
  7327. template <typename T, typename U>
  7328. bool prepare_content_receiver(T &x, int &status,
  7329. ContentReceiverWithProgress receiver,
  7330. bool decompress, size_t payload_max_length,
  7331. bool &exceed_payload_max_length, U callback) {
  7332. if (decompress) {
  7333. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7334. std::unique_ptr<decompressor> decompressor;
  7335. if (!encoding.empty()) {
  7336. // A coding we know about but were not built with is an error. An
  7337. // unrecognized coding (including "identity") is left alone and the
  7338. // payload is passed through as-is, since some servers misuse the header,
  7339. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7340. decompressor = detail::create_decompressor(encoding);
  7341. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7342. status = StatusCode::UnsupportedMediaType_415;
  7343. return false;
  7344. }
  7345. }
  7346. if (decompressor) {
  7347. if (decompressor->is_valid()) {
  7348. size_t decompressed_size = 0;
  7349. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7350. size_t off, size_t len) {
  7351. return decompressor->decompress(
  7352. buf, n, [&](const char *buf2, size_t n2) {
  7353. // Guard against zip-bomb: check
  7354. // decompressed size against limit.
  7355. if (payload_max_length > 0 &&
  7356. (decompressed_size >= payload_max_length ||
  7357. n2 > payload_max_length - decompressed_size)) {
  7358. exceed_payload_max_length = true;
  7359. return false;
  7360. }
  7361. decompressed_size += n2;
  7362. return receiver(buf2, n2, off, len);
  7363. });
  7364. };
  7365. return callback(std::move(out));
  7366. } else {
  7367. status = StatusCode::InternalServerError_500;
  7368. return false;
  7369. }
  7370. }
  7371. }
  7372. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7373. size_t len) {
  7374. return receiver(buf, n, off, len);
  7375. };
  7376. return callback(std::move(out));
  7377. }
  7378. template <typename T>
  7379. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7380. DownloadProgress progress,
  7381. ContentReceiverWithProgress receiver, bool decompress) {
  7382. bool exceed_payload_max_length = false;
  7383. return prepare_content_receiver(
  7384. x, status, std::move(receiver), decompress, payload_max_length,
  7385. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7386. auto ret = true;
  7387. // Note: exceed_payload_max_length may also be set by the decompressor
  7388. // wrapper in prepare_content_receiver when the decompressed payload
  7389. // size exceeds the limit.
  7390. if (is_chunked_transfer_encoding(x.headers)) {
  7391. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7392. if (result == ReadContentResult::Success) {
  7393. ret = true;
  7394. } else if (result == ReadContentResult::PayloadTooLarge) {
  7395. exceed_payload_max_length = true;
  7396. ret = false;
  7397. } else {
  7398. ret = false;
  7399. }
  7400. } else if (!has_header(x.headers, "Content-Length")) {
  7401. auto result =
  7402. read_content_without_length(strm, payload_max_length, out);
  7403. if (result == ReadContentResult::Success) {
  7404. ret = true;
  7405. } else if (result == ReadContentResult::PayloadTooLarge) {
  7406. exceed_payload_max_length = true;
  7407. ret = false;
  7408. } else {
  7409. ret = false;
  7410. }
  7411. } else {
  7412. auto is_invalid_value = false;
  7413. auto len = get_header_value_u64(x.headers, "Content-Length",
  7414. (std::numeric_limits<size_t>::max)(),
  7415. 0, is_invalid_value);
  7416. if (is_invalid_value) {
  7417. ret = false;
  7418. } else if (len > 0) {
  7419. auto result = read_content_with_length(
  7420. strm, len, std::move(progress), out, payload_max_length);
  7421. ret = (result == ReadContentResult::Success);
  7422. if (result == ReadContentResult::PayloadTooLarge) {
  7423. exceed_payload_max_length = true;
  7424. }
  7425. }
  7426. }
  7427. if (!ret) {
  7428. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7429. : StatusCode::BadRequest_400;
  7430. }
  7431. return ret;
  7432. });
  7433. }
  7434. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7435. const std::string &path) {
  7436. // Neither the method nor the request target may carry CR/LF, SP or other
  7437. // control octets; otherwise a value smuggled into either splits the request
  7438. // line and injects headers or a whole request.
  7439. if (!fields::is_token(method)) { return -1; }
  7440. if (!fields::is_request_target(path)) { return -1; }
  7441. std::string s = method;
  7442. s += ' ';
  7443. s += path;
  7444. s += " HTTP/1.1\r\n";
  7445. return strm.write(s.data(), s.size());
  7446. }
  7447. inline ssize_t write_response_line(Stream &strm, int status) {
  7448. std::string s = "HTTP/1.1 ";
  7449. s += std::to_string(status);
  7450. s += ' ';
  7451. s += httplib::status_message(status);
  7452. s += "\r\n";
  7453. return strm.write(s.data(), s.size());
  7454. }
  7455. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7456. ssize_t write_len = 0;
  7457. for (const auto &x : headers) {
  7458. // Skip fields with invalid names or values to prevent response splitting
  7459. // via CR/LF injection, matching set_header(). The client validates request
  7460. // headers up front in check_and_write_headers, but the server passes
  7461. // res.headers straight to this writer, and res.headers is a public field
  7462. // an application can populate directly with request-derived values.
  7463. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7464. std::string s;
  7465. s = x.first;
  7466. s += ": ";
  7467. s += x.second;
  7468. s += "\r\n";
  7469. auto len = strm.write(s.data(), s.size());
  7470. if (len < 0) { return len; }
  7471. write_len += len;
  7472. }
  7473. auto len = strm.write("\r\n");
  7474. if (len < 0) { return len; }
  7475. write_len += len;
  7476. return write_len;
  7477. }
  7478. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7479. size_t offset = 0;
  7480. while (offset < l) {
  7481. auto length = strm.write(d + offset, l - offset);
  7482. if (length < 0) { return false; }
  7483. offset += static_cast<size_t>(length);
  7484. }
  7485. return true;
  7486. }
  7487. template <typename T>
  7488. inline bool write_content_with_progress(Stream &strm,
  7489. const ContentProvider &content_provider,
  7490. size_t offset, size_t length,
  7491. T is_shutting_down,
  7492. const UploadProgress &upload_progress,
  7493. Error &error) {
  7494. size_t end_offset = offset + length;
  7495. size_t start_offset = offset;
  7496. auto ok = true;
  7497. auto finished = false;
  7498. DataSink data_sink;
  7499. data_sink.write = [&](const char *d, size_t l) -> bool {
  7500. if (ok) {
  7501. // Bytes past `length` would follow the framed body, where the peer reads
  7502. // them as the next message. Write only what fits and fail the rest.
  7503. if (l > end_offset - offset) {
  7504. l = end_offset - offset;
  7505. ok = false;
  7506. }
  7507. if (write_data(strm, d, l)) {
  7508. offset += l;
  7509. if (upload_progress && length > 0) {
  7510. size_t current_written = offset - start_offset;
  7511. if (!upload_progress(current_written, length)) {
  7512. ok = false;
  7513. return false;
  7514. }
  7515. }
  7516. } else {
  7517. ok = false;
  7518. }
  7519. }
  7520. return ok;
  7521. };
  7522. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7523. // The body is framed by `length`, so a provider that reports itself done
  7524. // early has truncated it. Record that and let the short-body check below
  7525. // fail the write, rather than calling the provider again forever.
  7526. data_sink.done = [&]() { finished = true; };
  7527. while (offset < end_offset && !finished && !is_shutting_down()) {
  7528. auto last_offset = offset;
  7529. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7530. error = Error::Write;
  7531. return false;
  7532. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7533. error = Error::Canceled;
  7534. return false;
  7535. } else if (!ok) {
  7536. error = Error::Write;
  7537. return false;
  7538. }
  7539. // A provider that reports success without writing anything and without
  7540. // reporting itself done gets handed the same offset and length again on
  7541. // the next pass, so it would spin here for as long as the peer stays
  7542. // connected. Treat making no progress as a short body, like done() early.
  7543. if (!finished && offset == last_offset) {
  7544. error = Error::Write;
  7545. return false;
  7546. }
  7547. }
  7548. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7549. error = Error::Write;
  7550. return false;
  7551. }
  7552. error = Error::Success;
  7553. return true;
  7554. }
  7555. template <typename T>
  7556. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7557. size_t offset, size_t length, T is_shutting_down,
  7558. Error &error) {
  7559. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7560. is_shutting_down, nullptr, error);
  7561. }
  7562. template <typename T>
  7563. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7564. size_t offset, size_t length,
  7565. const T &is_shutting_down) {
  7566. auto error = Error::Success;
  7567. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7568. error);
  7569. }
  7570. template <typename T>
  7571. inline bool
  7572. write_content_without_length(Stream &strm,
  7573. const ContentProvider &content_provider,
  7574. const T &is_shutting_down) {
  7575. size_t offset = 0;
  7576. auto data_available = true;
  7577. auto ok = true;
  7578. DataSink data_sink;
  7579. data_sink.write = [&](const char *d, size_t l) -> bool {
  7580. if (ok) {
  7581. offset += l;
  7582. if (!write_data(strm, d, l)) { ok = false; }
  7583. }
  7584. return ok;
  7585. };
  7586. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7587. data_sink.done = [&](void) { data_available = false; };
  7588. while (data_available && !is_shutting_down()) {
  7589. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7590. return false;
  7591. } else if (!content_provider(offset, 0, data_sink)) {
  7592. return false;
  7593. } else if (!ok) {
  7594. return false;
  7595. }
  7596. }
  7597. return !data_available; // true only if done() was called, false if shutting
  7598. // down
  7599. }
  7600. // Runs a known-length content provider to completion and compresses what it
  7601. // writes into `out`, chunk by chunk, without holding the identity form.
  7602. inline bool compress_content_provider(const ContentProvider &content_provider,
  7603. size_t length, compressor &cmp,
  7604. std::string &out) {
  7605. size_t offset = 0;
  7606. auto ok = true;
  7607. auto finished = false;
  7608. DataSink data_sink;
  7609. auto append = [&](const char *data, size_t data_len) {
  7610. out.append(data, data_len);
  7611. return true;
  7612. };
  7613. data_sink.write = [&](const char *d, size_t l) -> bool {
  7614. if (!ok) { return false; }
  7615. offset += l;
  7616. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7617. return ok;
  7618. };
  7619. // The body is framed by `length`, so a provider that reports itself done
  7620. // early has truncated it; the short-body check below turns that into a
  7621. // failure rather than calling the provider again forever.
  7622. data_sink.done = [&]() { finished = true; };
  7623. while (offset < length && !finished) {
  7624. auto prev_offset = offset;
  7625. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7626. return false;
  7627. }
  7628. // No Stream to block on here, so a provider that keeps returning true
  7629. // without writing would spin. Treat a pass that made no progress as a
  7630. // failure.
  7631. if (offset == prev_offset) { return false; }
  7632. }
  7633. if (offset != length) { return false; }
  7634. return cmp.compress(nullptr, 0, true, append);
  7635. }
  7636. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7637. // and the file flag, so recording them has to come after; keeping all of it
  7638. // here means a third file-serving path cannot get that order wrong.
  7639. inline void set_file_content_provider(Response &res,
  7640. const std::shared_ptr<mmap> &m,
  7641. const std::string &content_type,
  7642. EncodingType encoding) {
  7643. // One read and one write move up to this much of the file at a time.
  7644. auto buf = std::make_shared<std::vector<char>>(
  7645. (std::min)(m->size(), size_t(256 * 1024)));
  7646. res.set_content_provider(
  7647. m->size(), content_type,
  7648. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7649. // Never read past the file, which ends the response early if it has
  7650. // shrunk since it was opened.
  7651. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7652. if (n == 0) { return false; }
  7653. sink.write(buf->data(), n);
  7654. return true;
  7655. });
  7656. res.is_file_content_provider_ = true;
  7657. res.content_coding_ = encoding;
  7658. }
  7659. template <typename T, typename U>
  7660. inline bool
  7661. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7662. const T &is_shutting_down, U &compressor, Error &error) {
  7663. size_t offset = 0;
  7664. auto data_available = true;
  7665. auto ok = true;
  7666. DataSink data_sink;
  7667. data_sink.write = [&](const char *d, size_t l) -> bool {
  7668. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7669. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7670. // zero-length chunk is the terminator, so it must not be emitted here.
  7671. if (ok && l > 0) {
  7672. offset += l;
  7673. std::string payload;
  7674. if (compressor.compress(d, l, false,
  7675. [&](const char *data, size_t data_len) {
  7676. payload.append(data, data_len);
  7677. return true;
  7678. })) {
  7679. if (!payload.empty()) {
  7680. // Emit chunked response header and footer for each chunk
  7681. auto chunk =
  7682. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7683. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7684. }
  7685. } else {
  7686. ok = false;
  7687. }
  7688. }
  7689. return ok;
  7690. };
  7691. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7692. auto done_with_trailer = [&](const Headers *trailer) {
  7693. if (!ok) { return; }
  7694. data_available = false;
  7695. std::string payload;
  7696. if (!compressor.compress(nullptr, 0, true,
  7697. [&](const char *data, size_t data_len) {
  7698. payload.append(data, data_len);
  7699. return true;
  7700. })) {
  7701. ok = false;
  7702. return;
  7703. }
  7704. if (!payload.empty()) {
  7705. // Emit chunked response header and footer for each chunk
  7706. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7707. if (!write_data(strm, chunk.data(), chunk.size())) {
  7708. ok = false;
  7709. return;
  7710. }
  7711. }
  7712. constexpr const char done_marker[] = "0\r\n";
  7713. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7714. // Trailer
  7715. if (trailer) {
  7716. for (const auto &kv : *trailer) {
  7717. // Skip fields with invalid names or values to prevent response
  7718. // splitting via CR/LF injection, matching set_header().
  7719. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7720. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7721. if (!write_data(strm, field_line.data(), field_line.size())) {
  7722. ok = false;
  7723. }
  7724. }
  7725. }
  7726. constexpr const char crlf[] = "\r\n";
  7727. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7728. };
  7729. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7730. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7731. done_with_trailer(&trailer);
  7732. };
  7733. while (data_available && !is_shutting_down()) {
  7734. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7735. error = Error::Write;
  7736. return false;
  7737. } else if (!content_provider(offset, 0, data_sink)) {
  7738. error = Error::Canceled;
  7739. return false;
  7740. } else if (!ok) {
  7741. error = Error::Write;
  7742. return false;
  7743. }
  7744. }
  7745. if (data_available) { // exited due to is_shutting_down(), not done()
  7746. error = Error::Write;
  7747. return false;
  7748. }
  7749. error = Error::Success;
  7750. return true;
  7751. }
  7752. template <typename T, typename U>
  7753. inline bool write_content_chunked(Stream &strm,
  7754. const ContentProvider &content_provider,
  7755. const T &is_shutting_down, U &compressor) {
  7756. auto error = Error::Success;
  7757. return write_content_chunked(strm, content_provider, is_shutting_down,
  7758. compressor, error);
  7759. }
  7760. template <typename T>
  7761. inline bool redirect(T &cli, Request &req, Response &res,
  7762. const std::string &path, const std::string &location,
  7763. Error &error) {
  7764. Request new_req = req;
  7765. new_req.path = path;
  7766. new_req.redirect_count_ -= 1;
  7767. if (res.status == StatusCode::SeeOther_303 &&
  7768. (req.method != "GET" && req.method != "HEAD")) {
  7769. new_req.method = "GET";
  7770. new_req.body.clear();
  7771. new_req.headers.clear();
  7772. new_req.content_length_ = 0;
  7773. new_req.content_provider_ = nullptr;
  7774. new_req.is_chunked_content_provider_ = false;
  7775. }
  7776. Response new_res;
  7777. auto ret = cli.send(new_req, new_res, error);
  7778. if (ret) {
  7779. req = std::move(new_req);
  7780. res = std::move(new_res);
  7781. if (res.location.empty()) { res.location = location; }
  7782. }
  7783. return ret;
  7784. }
  7785. inline std::string params_to_query_str(const Params &params) {
  7786. std::string query;
  7787. for (auto it = params.begin(); it != params.end(); ++it) {
  7788. if (it != params.begin()) { query += '&'; }
  7789. query += encode_query_component(it->first);
  7790. query += '=';
  7791. query += encode_query_component(it->second);
  7792. }
  7793. return query;
  7794. }
  7795. // Splits one "key=value" span of a query string at its first '='. A span with
  7796. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7797. // "?flag" keeps its name.
  7798. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7799. std::string &val) {
  7800. divide(b, static_cast<std::size_t>(e - b), '=',
  7801. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7802. std::size_t rhs_size) {
  7803. key.assign(lhs_data, lhs_size);
  7804. val.assign(rhs_data, rhs_size);
  7805. });
  7806. }
  7807. inline void parse_query_text(const char *data, std::size_t size,
  7808. Params &params) {
  7809. std::set<std::string> cache;
  7810. split(data, data + size, '&', [&](const char *b, const char *e) {
  7811. std::string kv(b, e);
  7812. if (cache.find(kv) != cache.end()) { return; }
  7813. cache.insert(std::move(kv));
  7814. std::string key;
  7815. std::string val;
  7816. divide_query_pair(b, e, key, val);
  7817. if (!key.empty()) {
  7818. params.emplace(decode_query_component(key), decode_query_component(val));
  7819. }
  7820. });
  7821. }
  7822. inline void parse_query_text(const std::string &s, Params &params) {
  7823. parse_query_text(s.data(), s.size(), params);
  7824. }
  7825. // Normalize a query string by decoding and re-encoding each key/value pair
  7826. // while preserving the original parameter order. This avoids double-encoding
  7827. // and ensures consistent encoding. It works on the raw string rather than
  7828. // parsing into Params and re-serializing, because that round trip cannot
  7829. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7830. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7831. // duplicated pairs.
  7832. inline std::string normalize_query_string(const std::string &query) {
  7833. std::string result;
  7834. split(query.data(), query.data() + query.size(), '&',
  7835. [&](const char *b, const char *e) {
  7836. std::string key;
  7837. std::string val;
  7838. divide_query_pair(b, e, key, val);
  7839. if (!key.empty()) {
  7840. auto dec_key = decode_query_component(key);
  7841. auto dec_val = decode_query_component(val);
  7842. if (!result.empty()) { result += '&'; }
  7843. result += encode_query_component(dec_key);
  7844. if (!val.empty() || std::find(b, e, '=') != e) {
  7845. result += '=';
  7846. result += encode_query_component(dec_val);
  7847. }
  7848. }
  7849. });
  7850. return result;
  7851. }
  7852. // The query of a client's path: what follows '?', up to the fragment.
  7853. inline std::string query_of(const std::string &path) {
  7854. auto fragment_pos = path.find('#');
  7855. auto query_pos = path.find('?');
  7856. return query_pos < fragment_pos
  7857. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7858. : std::string();
  7859. }
  7860. // Build the request target that goes on the wire from a caller-supplied path.
  7861. // Shared by the buffered send path and the streaming API so that both put the
  7862. // same bytes in the request line for the same input.
  7863. inline std::string encode_request_target(const std::string &uri,
  7864. bool path_encode) {
  7865. // The fragment stays with the client (RFC 9110 §7.1).
  7866. auto target = uri.substr(0, uri.find('#'));
  7867. // `substr(0, npos)` yields the whole string, which is what the no-query
  7868. // case needs.
  7869. auto query_pos = target.find('?');
  7870. auto path_part = target.substr(0, query_pos);
  7871. std::string query_part;
  7872. if (query_pos != std::string::npos) {
  7873. query_part = target.substr(query_pos + 1);
  7874. }
  7875. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7876. if (!query_part.empty()) {
  7877. // When path encoding is disabled the caller has supplied an already-encoded
  7878. // target and expects the exact bytes to be sent on the wire, so skip
  7879. // normalization for the query too. Normalizing would decode-then-re-encode
  7880. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7881. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7882. if (path_encode) {
  7883. auto normalized = normalize_query_string(query_part);
  7884. if (!normalized.empty()) {
  7885. result += '?';
  7886. result += normalized;
  7887. }
  7888. } else {
  7889. result += '?';
  7890. result += query_part;
  7891. }
  7892. }
  7893. return result;
  7894. }
  7895. inline bool parse_multipart_boundary(const std::string &content_type,
  7896. std::string &boundary) {
  7897. std::map<std::string, std::string> params;
  7898. extract_media_type(content_type, &params);
  7899. auto it = params.find("boundary");
  7900. if (it == params.end()) { return false; }
  7901. boundary = it->second;
  7902. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7903. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7904. // bytes costs a nearly full comparison at nearly every position: the
  7905. // boundary's length multiplies the worst-case cost of scanning a body.
  7906. return !boundary.empty() && boundary.size() <= 70;
  7907. }
  7908. inline void parse_disposition_params(const std::string &s, Params &params) {
  7909. std::set<std::string> cache;
  7910. split_unquoted(
  7911. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7912. std::string kv(b, e);
  7913. if (cache.find(kv) != cache.end()) { return; }
  7914. cache.insert(kv);
  7915. std::string key;
  7916. std::string val;
  7917. divide_param_pair(b, e, key, val);
  7918. if (!key.empty()) {
  7919. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7920. }
  7921. });
  7922. }
  7923. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7924. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7925. #else
  7926. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7927. #endif
  7928. auto is_valid = [](const std::string &str) {
  7929. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7930. };
  7931. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7932. const auto pos = static_cast<size_t>(6);
  7933. const auto len = static_cast<size_t>(s.size() - 6);
  7934. auto all_valid_ranges = true;
  7935. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7936. if (!all_valid_ranges) { return; }
  7937. const auto it = std::find(b, e, '-');
  7938. if (it == e) {
  7939. all_valid_ranges = false;
  7940. return;
  7941. }
  7942. const auto lhs = std::string(b, it);
  7943. const auto rhs = std::string(it + 1, e);
  7944. if (!is_valid(lhs) || !is_valid(rhs)) {
  7945. all_valid_ranges = false;
  7946. return;
  7947. }
  7948. ssize_t first = -1;
  7949. if (!lhs.empty()) {
  7950. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7951. // would turn the range into a suffix range.
  7952. auto res =
  7953. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7954. if (res.ec != std::errc{}) {
  7955. all_valid_ranges = false;
  7956. return;
  7957. }
  7958. }
  7959. ssize_t last = -1;
  7960. if (!rhs.empty()) {
  7961. // An overflowing last-byte-pos is past any content length, so keeping
  7962. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7963. ssize_t v;
  7964. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7965. if (res.ec == std::errc{}) { last = v; }
  7966. }
  7967. if ((first == -1 && last == -1) ||
  7968. (first != -1 && last != -1 && first > last)) {
  7969. all_valid_ranges = false;
  7970. return;
  7971. }
  7972. ranges.emplace_back(first, last);
  7973. });
  7974. return all_valid_ranges && !ranges.empty();
  7975. }
  7976. return false;
  7977. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7978. }
  7979. #else
  7980. } catch (...) { return false; }
  7981. #endif
  7982. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7983. inline std::string remove_quoted_strings(const std::string &s) {
  7984. std::string out;
  7985. auto in_quotes = false;
  7986. for (size_t i = 0; i < s.size(); i++) {
  7987. if (s[i] == '"') {
  7988. in_quotes = !in_quotes;
  7989. } else if (!in_quotes) {
  7990. out += s[i];
  7991. } else if (s[i] == '\\') {
  7992. i++;
  7993. }
  7994. }
  7995. return out;
  7996. }
  7997. inline bool parse_accept_header(const std::string &s,
  7998. std::vector<std::string> &content_types) {
  7999. // Parameter values are not used here, so a quoted-string is dropped rather
  8000. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8001. if (s.find('"') != std::string::npos) {
  8002. return parse_accept_header(remove_quoted_strings(s), content_types);
  8003. }
  8004. content_types.clear();
  8005. // Empty string is considered valid (no preference)
  8006. if (s.empty()) { return true; }
  8007. struct AcceptEntry {
  8008. std::string media_type;
  8009. double quality;
  8010. int order;
  8011. };
  8012. std::vector<AcceptEntry> entries;
  8013. int order = 0;
  8014. bool has_invalid_entry = false;
  8015. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8016. // has to parse and ignore empty list elements, so a leading, trailing or
  8017. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8018. // split() skips them, and the header length limit bounds how many a sender
  8019. // can send, so ignoring all of them cannot be used as a denial-of-service
  8020. // vector.
  8021. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8022. std::string entry(b, e);
  8023. entry = trim_copy(entry);
  8024. AcceptEntry accept_entry;
  8025. accept_entry.order = order++;
  8026. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8027. accept_entry.media_type, accept_entry.quality)) {
  8028. has_invalid_entry = true;
  8029. return;
  8030. }
  8031. // Remove additional parameters from media type
  8032. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8033. // Basic validation of media type format
  8034. if (accept_entry.media_type.empty()) {
  8035. has_invalid_entry = true;
  8036. return;
  8037. }
  8038. // Check for basic media type format (should contain '/' or be '*')
  8039. if (accept_entry.media_type != "*" &&
  8040. accept_entry.media_type.find('/') == std::string::npos) {
  8041. has_invalid_entry = true;
  8042. return;
  8043. }
  8044. entries.push_back(std::move(accept_entry));
  8045. });
  8046. // Return false if any invalid entry was found
  8047. if (has_invalid_entry) { return false; }
  8048. // Sort by quality (descending), then by original order (ascending)
  8049. std::sort(entries.begin(), entries.end(),
  8050. [](const AcceptEntry &a, const AcceptEntry &b) {
  8051. if (a.quality != b.quality) {
  8052. return a.quality > b.quality; // Higher quality first
  8053. }
  8054. return a.order < b.order; // Earlier order first for same quality
  8055. });
  8056. // Extract sorted media types
  8057. content_types.reserve(entries.size());
  8058. for (auto &entry : entries) {
  8059. content_types.push_back(std::move(entry.media_type));
  8060. }
  8061. return true;
  8062. }
  8063. class FormDataParser {
  8064. public:
  8065. FormDataParser() = default;
  8066. void set_boundary(std::string &&boundary) {
  8067. boundary_ = std::move(boundary);
  8068. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8069. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8070. }
  8071. bool is_valid() const { return is_valid_; }
  8072. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8073. const ContentReceiver &content_callback) {
  8074. // Once the close delimiter has been seen the rest of the body is epilogue
  8075. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8076. // spread across reads is not copied in only to be erased right away.
  8077. if (state_ == 5) { return true; }
  8078. buf_append(buf, n);
  8079. while (buf_size() > 0) {
  8080. switch (state_) {
  8081. case 0: { // Initial boundary
  8082. auto pos = buf_find(dash_boundary_crlf_);
  8083. if (pos == buf_size()) {
  8084. // Not found yet: keep only a possible partial boundary at the tail so
  8085. // that a body which never contains the boundary cannot grow the
  8086. // buffer (and get rescanned from the start) without bound.
  8087. auto keep = dash_boundary_crlf_.size() - 1;
  8088. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8089. return true;
  8090. }
  8091. buf_erase(pos + dash_boundary_crlf_.size());
  8092. state_ = 1;
  8093. break;
  8094. }
  8095. case 1: { // New entry
  8096. clear_file_info();
  8097. header_searched_ = 0;
  8098. state_ = 2;
  8099. break;
  8100. }
  8101. case 2: { // Headers
  8102. // Resume where the last call stopped looking, so that a line arriving
  8103. // a few bytes at a time is not searched from its start each time.
  8104. auto pos = buf_find(crlf_, header_searched_);
  8105. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8106. while (pos < buf_size()) {
  8107. // Empty line
  8108. if (pos == 0) {
  8109. if (!header_callback(file_)) {
  8110. is_valid_ = false;
  8111. return false;
  8112. }
  8113. buf_erase(crlf_.size());
  8114. state_ = 3;
  8115. break;
  8116. }
  8117. // Check header count limit
  8118. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8119. is_valid_ = false;
  8120. return false;
  8121. }
  8122. header_count_++;
  8123. const auto header = buf_head(pos);
  8124. if (!parse_header(header.data(), header.data() + header.size(),
  8125. [&](const std::string &, const std::string &) {})) {
  8126. is_valid_ = false;
  8127. return false;
  8128. }
  8129. // Parse and emplace space trimmed headers into a map
  8130. if (!parse_header(
  8131. header.data(), header.data() + header.size(),
  8132. [&](const std::string &key, const std::string &val) {
  8133. file_.headers.emplace(key, val);
  8134. })) {
  8135. is_valid_ = false;
  8136. return false;
  8137. }
  8138. constexpr const char header_content_type[] = "Content-Type:";
  8139. if (start_with_case_ignore(header, header_content_type)) {
  8140. file_.content_type =
  8141. trim_copy(header.substr(str_len(header_content_type)));
  8142. } else {
  8143. std::string disposition_params;
  8144. if (parse_content_disposition(header, disposition_params)) {
  8145. Params params;
  8146. parse_disposition_params(disposition_params, params);
  8147. auto it = params.find("name");
  8148. if (it != params.end()) {
  8149. file_.name = it->second;
  8150. } else {
  8151. is_valid_ = false;
  8152. return false;
  8153. }
  8154. it = params.find("filename");
  8155. if (it != params.end()) { file_.filename = it->second; }
  8156. it = params.find("filename*");
  8157. if (it != params.end()) {
  8158. // RFC 5987: only UTF-8 encoding is allowed
  8159. const auto &val = it->second;
  8160. constexpr const char utf8_prefix[] = "UTF-8''";
  8161. constexpr size_t prefix_len = str_len(utf8_prefix);
  8162. if (val.size() > prefix_len &&
  8163. start_with_case_ignore(val, utf8_prefix)) {
  8164. file_.filename = decode_path_component(
  8165. val.substr(prefix_len)); // override...
  8166. } else {
  8167. is_valid_ = false;
  8168. return false;
  8169. }
  8170. }
  8171. }
  8172. }
  8173. buf_erase(pos + crlf_.size());
  8174. pos = buf_find(crlf_);
  8175. }
  8176. if (state_ != 3) {
  8177. // The CR of the CRLF may be the last byte so far.
  8178. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8179. return true;
  8180. }
  8181. break;
  8182. }
  8183. case 3: { // Body
  8184. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8185. auto pos = buf_find(crlf_dash_boundary_);
  8186. if (pos < buf_size()) {
  8187. if (!content_callback(buf_data(), pos)) {
  8188. is_valid_ = false;
  8189. return false;
  8190. }
  8191. buf_erase(pos + crlf_dash_boundary_.size());
  8192. state_ = 4;
  8193. } else {
  8194. auto len = buf_size() - crlf_dash_boundary_.size();
  8195. if (len > 0) {
  8196. if (!content_callback(buf_data(), len)) {
  8197. is_valid_ = false;
  8198. return false;
  8199. }
  8200. buf_erase(len);
  8201. }
  8202. return true;
  8203. }
  8204. break;
  8205. }
  8206. case 4: { // Boundary
  8207. if (crlf_.size() > buf_size()) { return true; }
  8208. if (buf_start_with(crlf_)) {
  8209. buf_erase(crlf_.size());
  8210. state_ = 1;
  8211. } else if (buf_start_with(dash_)) {
  8212. buf_erase(dash_.size());
  8213. is_valid_ = true;
  8214. state_ = 5;
  8215. } else {
  8216. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8217. // accepted after a boundary; RFC 2046 allows transport-padding in
  8218. // between, but this parser has never supported it. Either way the
  8219. // body is already destined to be rejected, so fail now instead of
  8220. // buffering the rest of it. Both are two bytes, so the check above
  8221. // already guarantees enough buffered data to decide.
  8222. is_valid_ = false;
  8223. return false;
  8224. }
  8225. break;
  8226. }
  8227. case 5: { // Epilogue
  8228. buf_erase(buf_size());
  8229. break;
  8230. }
  8231. }
  8232. }
  8233. return true;
  8234. }
  8235. private:
  8236. void clear_file_info() {
  8237. file_.name.clear();
  8238. file_.filename.clear();
  8239. file_.content_type.clear();
  8240. file_.headers.clear();
  8241. header_count_ = 0;
  8242. }
  8243. bool start_with_case_ignore(const std::string &a, const char *b,
  8244. size_t offset = 0) const {
  8245. const auto b_len = strlen(b);
  8246. if (a.size() < offset + b_len) { return false; }
  8247. for (size_t i = 0; i < b_len; i++) {
  8248. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8249. return false;
  8250. }
  8251. }
  8252. return true;
  8253. }
  8254. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8255. // Returns true if header matches, with the params portion in `params_out`.
  8256. bool parse_content_disposition(const std::string &header,
  8257. std::string &params_out) const {
  8258. constexpr const char prefix[] = "Content-Disposition:";
  8259. constexpr size_t prefix_len = str_len(prefix);
  8260. if (!start_with_case_ignore(header, prefix)) { return false; }
  8261. // Skip whitespace after "Content-Disposition:"
  8262. auto pos = prefix_len;
  8263. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8264. pos++;
  8265. }
  8266. // Match "form-data;" (case-insensitive)
  8267. constexpr const char form_data[] = "form-data;";
  8268. constexpr size_t form_data_len = str_len(form_data);
  8269. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8270. pos += form_data_len;
  8271. // Skip whitespace after "form-data;"
  8272. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8273. pos++;
  8274. }
  8275. params_out = header.substr(pos);
  8276. return true;
  8277. }
  8278. const std::string dash_ = "--";
  8279. const std::string crlf_ = "\r\n";
  8280. std::string boundary_;
  8281. std::string dash_boundary_crlf_;
  8282. std::string crlf_dash_boundary_;
  8283. size_t state_ = 0;
  8284. bool is_valid_ = false;
  8285. FormData file_;
  8286. size_t header_count_ = 0;
  8287. size_t header_searched_ = 0;
  8288. // Buffer
  8289. bool start_with(const std::string &a, size_t spos, size_t epos,
  8290. const std::string &b) const {
  8291. if (epos - spos < b.size()) { return false; }
  8292. for (size_t i = 0; i < b.size(); i++) {
  8293. if (a[i + spos] != b[i]) { return false; }
  8294. }
  8295. return true;
  8296. }
  8297. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8298. const char *buf_data() const { return &buf_[buf_spos_]; }
  8299. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8300. bool buf_start_with(const std::string &s) const {
  8301. return start_with(buf_, buf_spos_, buf_epos_, s);
  8302. }
  8303. size_t buf_find(const std::string &s, size_t from = 0) const {
  8304. auto c = s.front();
  8305. size_t off = buf_spos_ + from;
  8306. while (off < buf_epos_) {
  8307. auto pos = off;
  8308. while (true) {
  8309. if (pos == buf_epos_) { return buf_size(); }
  8310. if (buf_[pos] == c) { break; }
  8311. pos++;
  8312. }
  8313. auto remaining_size = buf_epos_ - pos;
  8314. if (s.size() > remaining_size) { return buf_size(); }
  8315. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8316. off = pos + 1;
  8317. }
  8318. return buf_size();
  8319. }
  8320. void buf_append(const char *data, size_t n) {
  8321. auto remaining_size = buf_size();
  8322. if (remaining_size > 0 && buf_spos_ > 0) {
  8323. for (size_t i = 0; i < remaining_size; i++) {
  8324. buf_[i] = buf_[buf_spos_ + i];
  8325. }
  8326. }
  8327. buf_spos_ = 0;
  8328. buf_epos_ = remaining_size;
  8329. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8330. for (size_t i = 0; i < n; i++) {
  8331. buf_[buf_epos_ + i] = data[i];
  8332. }
  8333. buf_epos_ += n;
  8334. }
  8335. void buf_erase(size_t size) { buf_spos_ += size; }
  8336. std::string buf_;
  8337. size_t buf_spos_ = 0;
  8338. size_t buf_epos_ = 0;
  8339. };
  8340. inline std::string random_string(size_t length) {
  8341. constexpr const char data[] =
  8342. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8343. std::string result(length, '\0');
  8344. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8345. for (auto &c : result) {
  8346. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8347. }
  8348. return result;
  8349. }
  8350. inline std::string make_multipart_data_boundary() {
  8351. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8352. }
  8353. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8354. auto valid = true;
  8355. for (size_t i = 0; i < boundary.size(); i++) {
  8356. auto c = boundary[i];
  8357. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8358. valid = false;
  8359. break;
  8360. }
  8361. }
  8362. return valid;
  8363. }
  8364. // Escape a multipart field name/filename following the WHATWG HTML standard
  8365. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8366. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8367. // With quoted = false, only CR and LF are escaped; this is for header values
  8368. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8369. inline std::string escape_multipart_field(const std::string &s,
  8370. bool quoted = true) {
  8371. std::string result;
  8372. result.reserve(s.size());
  8373. for (auto c : s) {
  8374. switch (c) {
  8375. case '"':
  8376. if (quoted) {
  8377. result += "%22";
  8378. } else {
  8379. result += c;
  8380. }
  8381. break;
  8382. case '\\':
  8383. // A lone backslash would escape the character after it (RFC 9110
  8384. // 5.6.4).
  8385. if (quoted) { result += '\\'; }
  8386. result += c;
  8387. break;
  8388. case '\r': result += "%0D"; break;
  8389. case '\n': result += "%0A"; break;
  8390. default: result += c; break;
  8391. }
  8392. }
  8393. return result;
  8394. }
  8395. template <typename T>
  8396. inline std::string
  8397. serialize_multipart_formdata_item_begin(const T &item,
  8398. const std::string &boundary) {
  8399. std::string body = "--" + boundary + "\r\n";
  8400. body += "Content-Disposition: form-data; name=\"" +
  8401. escape_multipart_field(item.name) + "\"";
  8402. if (!item.filename.empty()) {
  8403. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8404. }
  8405. body += "\r\n";
  8406. if (!item.content_type.empty()) {
  8407. body +=
  8408. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8409. "\r\n";
  8410. }
  8411. body += "\r\n";
  8412. return body;
  8413. }
  8414. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8415. inline std::string
  8416. serialize_multipart_formdata_finish(const std::string &boundary) {
  8417. return "--" + boundary + "--\r\n";
  8418. }
  8419. inline std::string
  8420. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8421. return "multipart/form-data; boundary=" + boundary;
  8422. }
  8423. inline std::string
  8424. serialize_multipart_formdata(const UploadFormDataItems &items,
  8425. const std::string &boundary, bool finish = true) {
  8426. std::string body;
  8427. for (const auto &item : items) {
  8428. body += serialize_multipart_formdata_item_begin(item, boundary);
  8429. body += item.content + serialize_multipart_formdata_item_end();
  8430. }
  8431. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8432. return body;
  8433. }
  8434. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8435. const std::string &boundary) {
  8436. size_t total = 0;
  8437. for (const auto &item : items) {
  8438. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8439. total += item.content.size();
  8440. total += serialize_multipart_formdata_item_end().size();
  8441. }
  8442. total += serialize_multipart_formdata_finish(boundary).size();
  8443. return total;
  8444. }
  8445. struct MultipartSegment {
  8446. const char *data;
  8447. size_t size;
  8448. };
  8449. // NOTE: items must outlive the returned ContentProvider
  8450. // (safe for synchronous use inside Post/Put/Patch)
  8451. inline ContentProvider
  8452. make_multipart_content_provider(const UploadFormDataItems &items,
  8453. const std::string &boundary) {
  8454. // Own the per-item header strings and the finish string
  8455. std::vector<std::string> owned;
  8456. owned.reserve(items.size() + 1);
  8457. for (const auto &item : items)
  8458. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8459. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8460. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8461. std::vector<MultipartSegment> segs;
  8462. segs.reserve(items.size() * 3 + 1);
  8463. static const char crlf[] = "\r\n";
  8464. for (size_t i = 0; i < items.size(); i++) {
  8465. segs.push_back({owned[i].data(), owned[i].size()});
  8466. segs.push_back({items[i].content.data(), items[i].content.size()});
  8467. segs.push_back({crlf, 2});
  8468. }
  8469. segs.push_back({owned.back().data(), owned.back().size()});
  8470. struct MultipartState {
  8471. std::vector<std::string> owned;
  8472. std::vector<MultipartSegment> segs;
  8473. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8474. };
  8475. auto state = std::make_shared<MultipartState>();
  8476. state->owned = std::move(owned);
  8477. // `segs` holds raw pointers into owned strings; std::string move preserves
  8478. // the data pointer, so these pointers remain valid after the move above.
  8479. state->segs = std::move(segs);
  8480. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8481. // Buffer multiple small segments into fewer, larger writes to avoid
  8482. // excessive TCP packets when there are many form data items (#2410)
  8483. auto &buf = state->buf;
  8484. auto buf_size = buf.size();
  8485. size_t buf_len = 0;
  8486. size_t remaining = length;
  8487. // Find the first segment containing 'offset'
  8488. size_t pos = 0;
  8489. size_t seg_idx = 0;
  8490. for (; seg_idx < state->segs.size(); seg_idx++) {
  8491. const auto &seg = state->segs[seg_idx];
  8492. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8493. pos += seg.size;
  8494. }
  8495. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8496. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8497. const auto &seg = state->segs[seg_idx];
  8498. size_t available = seg.size - seg_offset;
  8499. size_t to_copy = (std::min)(available, remaining);
  8500. const char *src = seg.data + seg_offset;
  8501. seg_offset = 0; // only the first segment has a non-zero offset
  8502. while (to_copy > 0) {
  8503. size_t space = buf_size - buf_len;
  8504. size_t chunk = (std::min)(to_copy, space);
  8505. std::memcpy(buf.data() + buf_len, src, chunk);
  8506. buf_len += chunk;
  8507. src += chunk;
  8508. to_copy -= chunk;
  8509. remaining -= chunk;
  8510. if (buf_len == buf_size) {
  8511. if (!sink.write(buf.data(), buf_len)) { return false; }
  8512. buf_len = 0;
  8513. }
  8514. }
  8515. }
  8516. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8517. return true;
  8518. };
  8519. }
  8520. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8521. if (ranges.size() <= 1) return;
  8522. // Sort ranges by start position
  8523. std::sort(ranges.begin(), ranges.end(),
  8524. [](const Range &a, const Range &b) { return a.first < b.first; });
  8525. Ranges coalesced;
  8526. coalesced.reserve(ranges.size());
  8527. for (auto &r : ranges) {
  8528. auto first_pos = r.first;
  8529. auto last_pos = r.second;
  8530. // Handle special cases like in range_error
  8531. if (first_pos == -1 && last_pos == -1) {
  8532. first_pos = 0;
  8533. last_pos = static_cast<ssize_t>(content_length);
  8534. }
  8535. if (first_pos == -1) {
  8536. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8537. last_pos = static_cast<ssize_t>(content_length) - 1;
  8538. }
  8539. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8540. last_pos = static_cast<ssize_t>(content_length) - 1;
  8541. }
  8542. // Skip invalid ranges
  8543. if (!(0 <= first_pos && first_pos <= last_pos &&
  8544. last_pos < static_cast<ssize_t>(content_length))) {
  8545. continue;
  8546. }
  8547. // Coalesce with previous range if overlapping or adjacent (but not
  8548. // identical)
  8549. if (!coalesced.empty()) {
  8550. auto &prev = coalesced.back();
  8551. // Check if current range overlaps or is adjacent to previous range
  8552. // but don't coalesce identical ranges (allow duplicates)
  8553. if (first_pos <= prev.second + 1 &&
  8554. !(first_pos == prev.first && last_pos == prev.second)) {
  8555. // Extend the previous range
  8556. prev.second = (std::max)(prev.second, last_pos);
  8557. continue;
  8558. }
  8559. }
  8560. // Add new range
  8561. coalesced.emplace_back(first_pos, last_pos);
  8562. }
  8563. ranges = std::move(coalesced);
  8564. }
  8565. inline bool range_error(Request &req, Response &res) {
  8566. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8567. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8568. req.ranges.clear();
  8569. if (res.status == StatusCode::PartialContent_206) {
  8570. res.status = StatusCode::OK_200;
  8571. }
  8572. return false;
  8573. }
  8574. ssize_t content_len = static_cast<ssize_t>(
  8575. res.content_length_ ? res.content_length_ : res.body.size());
  8576. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8577. size_t overwrapping_count = 0;
  8578. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8579. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8580. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8581. // Too many ranges
  8582. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8583. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8584. return true;
  8585. }
  8586. for (auto &r : req.ranges) {
  8587. auto &first_pos = r.first;
  8588. auto &last_pos = r.second;
  8589. if (first_pos == -1 && last_pos == -1) {
  8590. first_pos = 0;
  8591. last_pos = content_len;
  8592. }
  8593. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8594. // selects the entire representation.
  8595. if (first_pos == -1) {
  8596. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8597. last_pos = content_len - 1;
  8598. }
  8599. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8600. // A client can limit the number of bytes requested without knowing the
  8601. // size of the selected representation. If the last-pos value is absent,
  8602. // or if the value is greater than or equal to the current length of the
  8603. // representation data, the byte range is interpreted as the remainder of
  8604. // the representation (i.e., the server replaces the value of last-pos
  8605. // with a value that is one less than the current length of the selected
  8606. // representation).
  8607. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8608. if (last_pos == -1 || last_pos >= content_len) {
  8609. last_pos = content_len - 1;
  8610. }
  8611. // Range must be within content length
  8612. if (!(0 <= first_pos && first_pos <= last_pos &&
  8613. last_pos <= content_len - 1)) {
  8614. return true;
  8615. }
  8616. // Request must not have more than two overlapping ranges
  8617. for (const auto &processed_range : processed_ranges) {
  8618. if (!(last_pos < processed_range.first ||
  8619. first_pos > processed_range.second)) {
  8620. overwrapping_count++;
  8621. if (overwrapping_count > 2) { return true; }
  8622. break; // Only count once per range
  8623. }
  8624. }
  8625. processed_ranges.emplace_back(first_pos, last_pos);
  8626. }
  8627. // After validation, coalesce overlapping ranges as per RFC 9110
  8628. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8629. }
  8630. return false;
  8631. }
  8632. inline std::pair<size_t, size_t>
  8633. get_range_offset_and_length(Range r, size_t content_length) {
  8634. assert(r.first != -1 && r.second != -1);
  8635. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8636. assert(r.first <= r.second &&
  8637. r.second < static_cast<ssize_t>(content_length));
  8638. (void)(content_length);
  8639. return std::make_pair(static_cast<size_t>(r.first),
  8640. static_cast<size_t>(r.second - r.first) + 1);
  8641. }
  8642. inline std::string make_content_range_header_field(
  8643. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8644. auto st = offset_and_length.first;
  8645. auto ed = st + offset_and_length.second - 1;
  8646. std::string field = "bytes ";
  8647. field += std::to_string(st);
  8648. field += '-';
  8649. field += std::to_string(ed);
  8650. field += '/';
  8651. field += std::to_string(content_length);
  8652. return field;
  8653. }
  8654. template <typename SToken, typename CToken, typename Content>
  8655. bool process_multipart_ranges_data(const Request &req,
  8656. const std::string &boundary,
  8657. const std::string &content_type,
  8658. size_t content_length, SToken stoken,
  8659. CToken ctoken, Content content) {
  8660. for (size_t i = 0; i < req.ranges.size(); i++) {
  8661. ctoken("--");
  8662. stoken(boundary);
  8663. ctoken("\r\n");
  8664. if (!content_type.empty()) {
  8665. ctoken("Content-Type: ");
  8666. stoken(content_type);
  8667. ctoken("\r\n");
  8668. }
  8669. auto offset_and_length =
  8670. get_range_offset_and_length(req.ranges[i], content_length);
  8671. ctoken("Content-Range: ");
  8672. stoken(make_content_range_header_field(offset_and_length, content_length));
  8673. ctoken("\r\n");
  8674. ctoken("\r\n");
  8675. if (!content(offset_and_length.first, offset_and_length.second)) {
  8676. return false;
  8677. }
  8678. ctoken("\r\n");
  8679. }
  8680. ctoken("--");
  8681. stoken(boundary);
  8682. ctoken("--");
  8683. return true;
  8684. }
  8685. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8686. const std::string &boundary,
  8687. const std::string &content_type,
  8688. size_t content_length,
  8689. std::string &data) {
  8690. process_multipart_ranges_data(
  8691. req, boundary, content_type, content_length,
  8692. [&](const std::string &token) { data += token; },
  8693. [&](const std::string &token) { data += token; },
  8694. [&](size_t offset, size_t length) {
  8695. assert(offset + length <= content_length);
  8696. data += res.body.substr(offset, length);
  8697. return true;
  8698. });
  8699. }
  8700. inline size_t get_multipart_ranges_data_length(const Request &req,
  8701. const std::string &boundary,
  8702. const std::string &content_type,
  8703. size_t content_length) {
  8704. size_t data_length = 0;
  8705. process_multipart_ranges_data(
  8706. req, boundary, content_type, content_length,
  8707. [&](const std::string &token) { data_length += token.size(); },
  8708. [&](const std::string &token) { data_length += token.size(); },
  8709. [&](size_t /*offset*/, size_t length) {
  8710. data_length += length;
  8711. return true;
  8712. });
  8713. return data_length;
  8714. }
  8715. template <typename T>
  8716. inline bool
  8717. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8718. const std::string &boundary,
  8719. const std::string &content_type,
  8720. size_t content_length, const T &is_shutting_down) {
  8721. return process_multipart_ranges_data(
  8722. req, boundary, content_type, content_length,
  8723. [&](const std::string &token) { strm.write(token); },
  8724. [&](const std::string &token) { strm.write(token); },
  8725. [&](size_t offset, size_t length) {
  8726. return write_content(strm, res.content_provider_, offset, length,
  8727. is_shutting_down);
  8728. });
  8729. }
  8730. inline bool has_framed_body(const Request &req) {
  8731. return is_chunked_transfer_encoding(req.headers) ||
  8732. req.get_header_value_u64("Content-Length") > 0;
  8733. }
  8734. inline bool is_connection_persistent(const Request &req) {
  8735. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8736. if (req.version == "HTTP/1.0" &&
  8737. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8738. return false;
  8739. }
  8740. return true;
  8741. }
  8742. inline bool expect_content(const Request &req) {
  8743. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8744. req.method == "DELETE") {
  8745. return true;
  8746. }
  8747. return has_framed_body(req);
  8748. }
  8749. #ifdef _WIN32
  8750. class WSInit {
  8751. public:
  8752. WSInit() {
  8753. WSADATA wsaData;
  8754. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8755. }
  8756. ~WSInit() {
  8757. if (is_valid_) WSACleanup();
  8758. }
  8759. bool is_valid_ = false;
  8760. };
  8761. static WSInit wsinit_;
  8762. #endif
  8763. inline std::string unescape_quoted_pairs(const std::string &s) {
  8764. std::string out;
  8765. out.reserve(s.size());
  8766. for (size_t i = 0; i < s.size(); i++) {
  8767. if (s[i] == '\\' && i + 1 < s.size()) {
  8768. out += s[++i];
  8769. } else {
  8770. out += s[i];
  8771. }
  8772. }
  8773. return out;
  8774. }
  8775. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8776. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8777. // quoted-pair, so the recipient recovers the original value.
  8778. inline std::string escape_quoted_pairs(const std::string &s) {
  8779. std::string out;
  8780. out.reserve(s.size());
  8781. for (auto c : s) {
  8782. if (c == '\\' || c == '"') { out += '\\'; }
  8783. out += c;
  8784. }
  8785. return out;
  8786. }
  8787. // RFC 9110 Section 11.6.1 defines a challenge list as
  8788. // WWW-Authenticate = #challenge
  8789. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8790. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8791. // so a server may offer several schemes, each with its own comma-separated
  8792. // auth-param list, in either order and either as separate field lines or
  8793. // packed into one. Splitting on every comma would break apart a challenge's
  8794. // own param list; splitting only on the first space would miss a Digest
  8795. // challenge that isn't first. Split on commas that aren't inside a
  8796. // quoted-string instead (split_unquoted), then track which scheme each
  8797. // resulting segment belongs to: a segment whose text before "=" contains
  8798. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8799. // leading token.
  8800. inline bool parse_www_authenticate(const Response &res,
  8801. std::map<std::string, std::string> &auth,
  8802. bool is_proxy) {
  8803. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8804. auto combined = get_combined_header_value(res.headers, auth_key);
  8805. if (combined.empty()) { return false; }
  8806. auto found_digest = false;
  8807. auto in_digest_challenge = false;
  8808. split_unquoted(
  8809. combined.data(), combined.data() + combined.size(), ',',
  8810. [&](const char *b, const char *e) {
  8811. std::string segment(b, e);
  8812. auto eq_pos = segment.find('=');
  8813. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8814. // for the first segment of a challenge, "<scheme> <key>") must be
  8815. // trimmed before its boundaries are inspected.
  8816. auto key_part = trim_copy(
  8817. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8818. auto space_pos = key_part.find_last_of(" \t");
  8819. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8820. // "<scheme>[ <key>]" starts a new challenge.
  8821. auto scheme_end =
  8822. space_pos == std::string::npos ? key_part.size() : space_pos;
  8823. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8824. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8825. // from one challenge is never paired with another's algorithm.
  8826. in_digest_challenge =
  8827. !found_digest &&
  8828. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8829. if (in_digest_challenge) { found_digest = true; }
  8830. if (space_pos == std::string::npos) {
  8831. // Bare scheme (or a token68), no auth-param on this segment.
  8832. return;
  8833. }
  8834. key_part = key_part.substr(space_pos + 1);
  8835. }
  8836. if (!in_digest_challenge) { return; }
  8837. auto val = trim_copy(segment.substr(eq_pos + 1));
  8838. auto unquoted = trim_double_quotes_copy(val);
  8839. if (unquoted.size() != val.size()) {
  8840. unquoted = unescape_quoted_pairs(unquoted);
  8841. }
  8842. auth[std::move(key_part)] = std::move(unquoted);
  8843. });
  8844. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8845. // make_digest_authentication_header() dereferences both unconditionally, so
  8846. // a challenge missing either can't produce a usable Authorization header.
  8847. // Treat it the same as no Digest challenge at all.
  8848. return found_digest && auth.find("realm") != auth.end() &&
  8849. auth.find("nonce") != auth.end();
  8850. }
  8851. class ContentProviderAdapter {
  8852. public:
  8853. explicit ContentProviderAdapter(
  8854. ContentProviderWithoutLength &&content_provider)
  8855. : content_provider_(std::move(content_provider)) {}
  8856. bool operator()(size_t offset, size_t, DataSink &sink) {
  8857. return content_provider_(offset, sink);
  8858. }
  8859. private:
  8860. ContentProviderWithoutLength content_provider_;
  8861. };
  8862. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8863. namespace fields {
  8864. inline bool is_token_char(char c) {
  8865. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8866. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8867. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8868. }
  8869. inline bool is_token(const std::string &s) {
  8870. if (s.empty()) { return false; }
  8871. for (auto c : s) {
  8872. if (!is_token_char(c)) { return false; }
  8873. }
  8874. return true;
  8875. }
  8876. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8877. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8878. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8879. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8880. inline bool is_field_content(const std::string &s) {
  8881. if (s.empty()) { return true; }
  8882. if (s.size() == 1) {
  8883. return is_field_vchar(s[0]);
  8884. } else if (s.size() == 2) {
  8885. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8886. } else {
  8887. size_t i = 0;
  8888. if (!is_field_vchar(s[i])) { return false; }
  8889. i++;
  8890. while (i < s.size() - 1) {
  8891. auto c = s[i++];
  8892. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8893. } else {
  8894. return false;
  8895. }
  8896. }
  8897. return is_field_vchar(s[i]);
  8898. }
  8899. }
  8900. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8901. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8902. return is_field_name(name) && is_field_value(value);
  8903. }
  8904. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8905. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8906. inline bool is_request_target(const std::string &s) {
  8907. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8908. }
  8909. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8910. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8911. inline bool is_host(const std::string &s) {
  8912. return std::all_of(s.begin(), s.end(), [](char c) {
  8913. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8914. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8915. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8916. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8917. });
  8918. }
  8919. } // namespace fields
  8920. // Built in memory first, like ClientImpl::write_request, so a rejected header
  8921. // never leaves a partial request on the wire.
  8922. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  8923. BufferStream bstrm;
  8924. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8925. error = Error::Write;
  8926. return false;
  8927. }
  8928. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8929. return false;
  8930. }
  8931. const auto &data = bstrm.get_buffer();
  8932. if (!write_data(strm, data.data(), data.size())) {
  8933. error = Error::Write;
  8934. return false;
  8935. }
  8936. return true;
  8937. }
  8938. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8939. WebSocketUpgradeResponse &upgrade) {
  8940. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8941. std::string key_bytes(16, '\0');
  8942. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8943. key_bytes.size());
  8944. auto client_key = base64_encode(key_bytes);
  8945. req.headers.erase("Upgrade");
  8946. req.headers.erase("Connection");
  8947. req.headers.erase("Sec-WebSocket-Key");
  8948. req.headers.erase("Sec-WebSocket-Version");
  8949. req.headers.emplace("Upgrade", "websocket");
  8950. req.headers.emplace("Connection", "Upgrade");
  8951. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8952. req.headers.emplace("Sec-WebSocket-Version", "13");
  8953. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  8954. // Verify 101 response and Sec-WebSocket-Accept header
  8955. auto expected_accept = websocket_accept_key(client_key);
  8956. auto offered_subprotocols =
  8957. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8958. return read_websocket_upgrade_response(strm, expected_accept,
  8959. offered_subprotocols, upgrade);
  8960. }
  8961. inline bool is_ip_address(const std::string &host) {
  8962. struct in_addr addr4;
  8963. struct in6_addr addr6;
  8964. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8965. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8966. }
  8967. // Resolve where a client should connect for `host`, honoring a user-supplied
  8968. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8969. // supplying the Host header and SNI; only the connection target changes.
  8970. //
  8971. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8972. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8973. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8974. // absent or empty mapping leaves `host` as the connection target; without the
  8975. // empty check the value would reach getaddrinfo as a null node and silently
  8976. // resolve to loopback.
  8977. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8978. const std::string &host, std::string &connect_host,
  8979. std::string &ip) {
  8980. connect_host = host;
  8981. ip.clear();
  8982. auto it = addr_map.find(host);
  8983. if (it == addr_map.end() || it->second.empty()) { return; }
  8984. if (is_ip_address(it->second)) {
  8985. ip = it->second;
  8986. } else {
  8987. connect_host = it->second;
  8988. }
  8989. }
  8990. } // namespace detail
  8991. /*
  8992. * Group 2: detail namespace - SSL common utilities
  8993. */
  8994. #ifdef CPPHTTPLIB_SSL_ENABLED
  8995. namespace detail {
  8996. class SSLSocketStream final : public Stream {
  8997. public:
  8998. SSLSocketStream(
  8999. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9000. time_t read_timeout_usec, time_t write_timeout_sec,
  9001. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9002. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9003. (std::chrono::steady_clock::time_point::min)());
  9004. ~SSLSocketStream() override;
  9005. bool is_readable() const override;
  9006. bool wait_readable() const override;
  9007. bool wait_writable() const override;
  9008. bool is_peer_alive() const override;
  9009. ssize_t read(char *ptr, size_t size) override;
  9010. ssize_t write(const char *ptr, size_t size) override;
  9011. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9012. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9013. socket_t socket() const override;
  9014. time_t duration() const override;
  9015. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9016. void set_max_timeout(time_t msec) override;
  9017. void set_read_interrupt(std::function<bool()> interrupted) override;
  9018. // See SocketStream::set_readable_hint().
  9019. void set_readable_hint() { readable_hint_ = true; }
  9020. // The error from the last read() or write() that failed in the TLS layer,
  9021. // with code Success if none did
  9022. const tls::TlsError &tls_error() const { return tls_error_; }
  9023. private:
  9024. bool ensure_readable();
  9025. socket_t sock_;
  9026. tls::session_t session_;
  9027. time_t read_timeout_sec_;
  9028. time_t read_timeout_usec_;
  9029. time_t write_timeout_sec_;
  9030. time_t write_timeout_usec_;
  9031. time_t max_timeout_msec_;
  9032. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9033. std::function<bool()> read_interrupted_;
  9034. bool readable_hint_ = false;
  9035. tls::TlsError tls_error_;
  9036. };
  9037. // A TLS stream for WebSocket connections, where the receive path and the
  9038. // send path (application send() plus the heartbeat ping thread) run on
  9039. // different threads. A single TLS session must never be entered
  9040. // concurrently, so every call into the session is serialized by one mutex.
  9041. //
  9042. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9043. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9044. // call under the lock, then waits for readiness with select() outside the
  9045. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9046. // blocked waiting for data never stalls a concurrent sender.
  9047. //
  9048. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9049. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9050. class WebSocketSSLStream final : public Stream {
  9051. public:
  9052. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9053. time_t read_timeout_sec, time_t read_timeout_usec,
  9054. time_t write_timeout_sec, time_t write_timeout_usec);
  9055. ~WebSocketSSLStream() override;
  9056. bool is_readable() const override;
  9057. bool wait_readable() const override;
  9058. bool wait_writable() const override;
  9059. ssize_t read(char *ptr, size_t size) override;
  9060. ssize_t write(const char *ptr, size_t size) override;
  9061. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9062. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9063. socket_t socket() const override;
  9064. time_t duration() const override;
  9065. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9066. private:
  9067. mutable std::mutex session_mutex_;
  9068. socket_t sock_;
  9069. tls::session_t session_;
  9070. // WebSocket::close() shortens the read timeout from the closing thread
  9071. // while the receive thread is inside wait_readable(), so these two are read
  9072. // and written concurrently. The write timeouts are never mutated.
  9073. std::atomic<time_t> read_timeout_sec_;
  9074. std::atomic<time_t> read_timeout_usec_;
  9075. time_t write_timeout_sec_;
  9076. time_t write_timeout_usec_;
  9077. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9078. };
  9079. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9080. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9081. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9082. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9083. unsigned int hash_length = 0;
  9084. unsigned char hash[EVP_MAX_MD_SIZE];
  9085. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9086. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9087. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9088. std::stringstream ss;
  9089. for (auto i = 0u; i < hash_length; ++i) {
  9090. ss << std::hex << std::setw(2) << std::setfill('0')
  9091. << static_cast<unsigned int>(hash[i]);
  9092. }
  9093. return ss.str();
  9094. }
  9095. inline std::string MD5(const std::string &s) {
  9096. return message_digest(s, EVP_md5());
  9097. }
  9098. inline std::string SHA_256(const std::string &s) {
  9099. return message_digest(s, EVP_sha256());
  9100. }
  9101. inline std::string SHA_512(const std::string &s) {
  9102. return message_digest(s, EVP_sha512());
  9103. }
  9104. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9105. namespace {
  9106. template <size_t N>
  9107. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9108. std::stringstream ss;
  9109. for (size_t i = 0; i < N; ++i) {
  9110. ss << std::hex << std::setw(2) << std::setfill('0')
  9111. << static_cast<unsigned int>(hash[i]);
  9112. }
  9113. return ss.str();
  9114. }
  9115. } // namespace
  9116. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9117. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9118. // initialized once. PSA state is process-global; do not free it.
  9119. inline bool ensure_mbedtls_psa_crypto() {
  9120. static std::once_flag once;
  9121. static bool ok = false;
  9122. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9123. return ok;
  9124. }
  9125. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9126. unsigned char *out, size_t out_size) {
  9127. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9128. size_t olen = 0;
  9129. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9130. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9131. olen == out_size;
  9132. }
  9133. #endif
  9134. inline std::string MD5(const std::string &s) {
  9135. unsigned char hash[16];
  9136. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9137. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9138. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9139. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9140. hash);
  9141. #else
  9142. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9143. hash);
  9144. #endif
  9145. return hash_to_hex(hash);
  9146. }
  9147. inline std::string SHA_256(const std::string &s) {
  9148. unsigned char hash[32];
  9149. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9150. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9151. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9152. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9153. hash, 0);
  9154. #else
  9155. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9156. s.size(), hash, 0);
  9157. #endif
  9158. return hash_to_hex(hash);
  9159. }
  9160. inline std::string SHA_512(const std::string &s) {
  9161. unsigned char hash[64];
  9162. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9163. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9164. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9165. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9166. hash, 0);
  9167. #else
  9168. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9169. s.size(), hash, 0);
  9170. #endif
  9171. return hash_to_hex(hash);
  9172. }
  9173. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9174. namespace {
  9175. template <size_t N>
  9176. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9177. std::stringstream ss;
  9178. for (size_t i = 0; i < N; ++i) {
  9179. ss << std::hex << std::setw(2) << std::setfill('0')
  9180. << static_cast<unsigned int>(hash[i]);
  9181. }
  9182. return ss.str();
  9183. }
  9184. } // namespace
  9185. inline std::string MD5(const std::string &s) {
  9186. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9187. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9188. static_cast<word32>(s.size()), hash);
  9189. return hash_to_hex(hash);
  9190. }
  9191. inline std::string SHA_256(const std::string &s) {
  9192. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9193. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9194. static_cast<word32>(s.size()), hash);
  9195. return hash_to_hex(hash);
  9196. }
  9197. inline std::string SHA_512(const std::string &s) {
  9198. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9199. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9200. static_cast<word32>(s.size()), hash);
  9201. return hash_to_hex(hash);
  9202. }
  9203. #endif
  9204. template <typename T>
  9205. inline bool process_server_socket_ssl(
  9206. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9207. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9208. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9209. time_t write_timeout_usec, T callback) {
  9210. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9211. // of a pipelined request, which keep_alive() cannot see on the socket.
  9212. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9213. write_timeout_sec, write_timeout_usec);
  9214. return process_server_socket_core(
  9215. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9216. [&]() { return strm.is_readable(); },
  9217. [&](bool socket_readable, bool close_connection,
  9218. bool &connection_closed) {
  9219. if (socket_readable) { strm.set_readable_hint(); }
  9220. return callback(strm, close_connection, connection_closed);
  9221. });
  9222. }
  9223. template <typename T>
  9224. inline bool process_client_socket_ssl(
  9225. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9226. time_t read_timeout_usec, time_t write_timeout_sec,
  9227. time_t write_timeout_usec, time_t max_timeout_msec,
  9228. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9229. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9230. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9231. start_time);
  9232. return callback(strm);
  9233. }
  9234. // `uri` is req's request-target in origin form, as curl sends it, also when
  9235. // the request line carries the absolute form for a proxy.
  9236. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9237. const Request &req, const std::string &uri,
  9238. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9239. const std::string &cnonce, const std::string &username,
  9240. const std::string &password, bool is_proxy = false) {
  9241. std::string nc;
  9242. {
  9243. std::stringstream ss;
  9244. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9245. nc = ss.str();
  9246. }
  9247. std::string qop;
  9248. if (auth.find("qop") != auth.end()) {
  9249. qop = auth.at("qop");
  9250. if (qop.find("auth-int") != std::string::npos) {
  9251. qop = "auth-int";
  9252. } else if (qop.find("auth") != std::string::npos) {
  9253. qop = "auth";
  9254. } else {
  9255. qop.clear();
  9256. }
  9257. }
  9258. std::string algo = "MD5";
  9259. if (auth.find("algorithm") != auth.end()) {
  9260. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9261. // not a token would otherwise be emitted verbatim and could carry commas
  9262. // or quotes that inject further auth-params into the header below.
  9263. const auto &a = auth.at("algorithm");
  9264. if (fields::is_token(a)) { algo = a; }
  9265. }
  9266. std::string response;
  9267. {
  9268. auto H = algo == "SHA-256" ? detail::SHA_256
  9269. : algo == "SHA-512" ? detail::SHA_512
  9270. : detail::MD5;
  9271. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9272. auto A2 = req.method + ":" + uri;
  9273. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9274. if (qop.empty()) {
  9275. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9276. } else {
  9277. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9278. ":" + qop + ":" + H(A2));
  9279. }
  9280. }
  9281. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9282. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9283. // close the string early. realm, nonce and opaque come straight from the
  9284. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9285. // without this a crafted challenge injects extra auth-params into the header.
  9286. auto field =
  9287. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9288. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9289. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9290. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9291. "\", algorithm=" + algo +
  9292. (qop.empty() ? ", response=\""
  9293. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9294. "\", response=\"") +
  9295. response + "\"" +
  9296. (opaque.empty()
  9297. ? ""
  9298. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9299. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9300. return std::make_pair(key, field);
  9301. }
  9302. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9303. // backend accepts the same names.
  9304. inline bool match_hostname(const std::string &pattern,
  9305. const std::string &hostname) {
  9306. // A trailing dot on the host is ignored
  9307. auto host = hostname;
  9308. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9309. // Exact match (case-insensitive)
  9310. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9311. // Split both pattern and hostname into components by '.', keeping any empty
  9312. // one, which no name may have
  9313. auto labels = [](const std::string &s) {
  9314. std::vector<std::string> v;
  9315. size_t b = 0;
  9316. while (true) {
  9317. auto e = s.find('.', b);
  9318. v.push_back(s.substr(b, e - b));
  9319. if (e == std::string::npos) { return v; }
  9320. b = e + 1;
  9321. }
  9322. };
  9323. auto pattern_components = labels(pattern);
  9324. auto host_components = labels(host);
  9325. auto has_empty_label = [](const std::vector<std::string> &v) {
  9326. return std::any_of(v.begin(), v.end(),
  9327. [](const std::string &l) { return l.empty(); });
  9328. };
  9329. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9330. return false;
  9331. }
  9332. // Component count must match
  9333. if (host_components.size() != pattern_components.size()) { return false; }
  9334. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9335. // and an IDNA label may not have one
  9336. const auto &leftmost = pattern_components.front();
  9337. if (leftmost.find('*') != std::string::npos &&
  9338. (pattern_components.size() < 3 ||
  9339. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9340. return false;
  9341. }
  9342. // Compare each component with wildcard support
  9343. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9344. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9345. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9346. auto itr = pattern_components.begin();
  9347. for (const auto &h : host_components) {
  9348. auto &p = *itr;
  9349. auto is_leftmost = itr == pattern_components.begin();
  9350. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9351. bool partial_match = false;
  9352. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9353. const auto prefix_length = p.size() - 1;
  9354. if (prefix_length == 0) {
  9355. partial_match = true;
  9356. } else if (h.size() >= prefix_length) {
  9357. partial_match =
  9358. std::equal(p.begin(),
  9359. p.begin() + static_cast<std::string::difference_type>(
  9360. prefix_length),
  9361. h.begin(), [](const char ca, const char cb) {
  9362. return detail::case_ignore::to_lower(ca) ==
  9363. detail::case_ignore::to_lower(cb);
  9364. });
  9365. }
  9366. }
  9367. if (!partial_match) { return false; }
  9368. }
  9369. ++itr;
  9370. }
  9371. return true;
  9372. }
  9373. #ifdef _WIN32
  9374. // Verify certificate using Windows CertGetCertificateChain API.
  9375. // This provides real-time certificate validation with Windows Update
  9376. // integration, independent of the TLS backend.
  9377. inline bool verify_cert_with_windows_schannel(
  9378. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9379. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9380. if (der_cert.empty()) { return false; }
  9381. out_error = 0;
  9382. // Create Windows certificate context from DER data
  9383. auto cert_context = CertCreateCertificateContext(
  9384. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9385. static_cast<DWORD>(der_cert.size()));
  9386. if (!cert_context) {
  9387. out_error = GetLastError();
  9388. return false;
  9389. }
  9390. auto cert_guard =
  9391. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9392. // Give CryptoAPI the certificates the server sent. Without them it follows
  9393. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9394. std::vector<tls::cert_t> peer_certs;
  9395. tls::get_peer_certs(session, peer_certs);
  9396. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9397. auto store_guard = scope_exit([&] {
  9398. for (auto cert : peer_certs) {
  9399. tls::free_cert(cert);
  9400. }
  9401. if (store) { CertCloseStore(store, 0); }
  9402. });
  9403. for (auto cert : peer_certs) {
  9404. std::vector<unsigned char> der;
  9405. if (store && tls::get_cert_der(cert, der)) {
  9406. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9407. static_cast<DWORD>(der.size()),
  9408. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9409. }
  9410. }
  9411. // Setup chain parameters
  9412. CERT_CHAIN_PARA chain_para = {};
  9413. chain_para.cbSize = sizeof(chain_para);
  9414. // Require the server authentication usage along the chain, which also
  9415. // rejects roots that Windows trusts only for other purposes.
  9416. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9417. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9418. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9419. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9420. // Build certificate chain with revocation checking
  9421. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9422. auto chain_result = CertGetCertificateChain(
  9423. nullptr, cert_context, nullptr, store, &chain_para,
  9424. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9425. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9426. nullptr, &chain_context);
  9427. if (!chain_result || !chain_context) {
  9428. out_error = GetLastError();
  9429. return false;
  9430. }
  9431. auto chain_guard =
  9432. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9433. // Verify SSL policy
  9434. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9435. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9436. #ifdef AUTHTYPE_SERVER
  9437. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9438. #endif
  9439. std::wstring whost;
  9440. if (verify_hostname) {
  9441. whost = u8string_to_wstring(hostname.c_str());
  9442. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9443. }
  9444. CERT_CHAIN_POLICY_PARA policy_para = {};
  9445. policy_para.cbSize = sizeof(policy_para);
  9446. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9447. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9448. #else
  9449. policy_para.dwFlags = 0;
  9450. #endif
  9451. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9452. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9453. policy_status.cbSize = sizeof(policy_status);
  9454. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9455. &policy_para, &policy_status)) {
  9456. out_error = GetLastError();
  9457. return false;
  9458. }
  9459. if (policy_status.dwError != 0) {
  9460. out_error = policy_status.dwError;
  9461. return false;
  9462. }
  9463. return true;
  9464. }
  9465. #endif // _WIN32
  9466. // Loads CA file/dir configuration and applies the system CA policy to a
  9467. // client TLS context. PEM data and native stores are applied to the context
  9468. // directly at set time; has_custom_store reflects them for the Auto policy
  9469. // decision.
  9470. inline bool load_client_ca_config(tls::ctx_t ctx,
  9471. const std::string &ca_cert_file_path,
  9472. const std::string &ca_cert_dir_path,
  9473. bool has_custom_store, SystemCAMode mode,
  9474. uint64_t &backend_error) {
  9475. auto ret = true;
  9476. if (!ca_cert_file_path.empty()) {
  9477. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9478. backend_error = tls::get_error();
  9479. ret = false;
  9480. }
  9481. } else if (!ca_cert_dir_path.empty()) {
  9482. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9483. backend_error = tls::get_error();
  9484. ret = false;
  9485. }
  9486. }
  9487. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9488. !ca_cert_dir_path.empty() || has_custom_store;
  9489. if (mode == SystemCAMode::Enabled ||
  9490. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9491. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9492. }
  9493. return ret;
  9494. }
  9495. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9496. // loaded into another context.
  9497. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9498. std::string pem;
  9499. std::vector<tls::cert_t> certs;
  9500. tls::get_ca_certs(ctx, certs);
  9501. for (auto cert : certs) {
  9502. std::vector<unsigned char> der;
  9503. if (tls::get_cert_der(cert, der)) {
  9504. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9505. pem += "-----BEGIN CERTIFICATE-----\n";
  9506. for (size_t i = 0; i < b64.size(); i += 64) {
  9507. pem += b64.substr(i, 64);
  9508. pem += '\n';
  9509. }
  9510. pem += "-----END CERTIFICATE-----\n";
  9511. }
  9512. tls::free_cert(cert);
  9513. }
  9514. return pem;
  9515. }
  9516. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9517. // copied to buf, or pem itself when len is 0.
  9518. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9519. if (!pem || len == 0) { return pem; }
  9520. buf.assign(pem, len);
  9521. return buf.c_str();
  9522. }
  9523. // The parts of session setup that only SSLClient needs, plus the handful
  9524. // WebSocketClient also exposes; everything else takes the defaults, which is
  9525. // what keeps the two clients on one implementation.
  9526. struct ClientTlsSessionOptions {
  9527. // Both SSLClient and WebSocketClient expose this independently of
  9528. // certificate verification.
  9529. bool server_hostname_verification = true;
  9530. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9531. // When non-null, guards session creation against concurrent use of the
  9532. // context. A WebSocketClient is not safe to use from several threads to
  9533. // begin with, so it passes nothing.
  9534. std::mutex *ctx_mutex = nullptr;
  9535. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9536. // The caller decides whether Schannel has anything to say about this
  9537. // connection; see SSLClient::initialize_ssl().
  9538. bool windows_cert_verification = false;
  9539. // A server certificate verifier works on the backend's chain verification,
  9540. // so the backend keeps deciding and Schannel only adds its own check.
  9541. bool server_certificate_verifier_set = false;
  9542. #endif
  9543. };
  9544. // Filled in on failure for callers that report error details.
  9545. struct ClientTlsSessionError {
  9546. Error error = Error::Success;
  9547. int ssl_error = 0;
  9548. uint64_t backend_error = 0;
  9549. };
  9550. // Establishes a client TLS session on an already connected socket. On failure
  9551. // the session is left for the caller to free: SSLClient frees it right away,
  9552. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9553. inline bool setup_client_tls_session(
  9554. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9555. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9556. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9557. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9558. using namespace tls;
  9559. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9560. if (out_error) {
  9561. out_error->error = error;
  9562. out_error->ssl_error = ssl_error;
  9563. out_error->backend_error = backend_error;
  9564. }
  9565. return false;
  9566. };
  9567. if (!ctx) {
  9568. session = nullptr;
  9569. return fail(Error::SSLConnection, 0, 0);
  9570. }
  9571. // With Windows verification on and no server certificate verifier set,
  9572. // Schannel is the only chain verifier. The backend's trust store is a
  9573. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9574. // demand, so the backend's verdict is not used.
  9575. auto windows_verifies_chain = false;
  9576. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9577. windows_verifies_chain = options.windows_cert_verification &&
  9578. !options.server_certificate_verifier_set;
  9579. #endif
  9580. {
  9581. std::unique_lock<std::mutex> guard;
  9582. if (options.ctx_mutex) {
  9583. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9584. }
  9585. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9586. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9587. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9588. // all verification post-handshake. Unless Schannel verifies the chain
  9589. // instead, chain verification happens during the handshake even for IP
  9590. // hosts; the certificate identity is verified post-handshake via
  9591. // verify_hostname().
  9592. set_verify_client(ctx, server_certificate_verification &&
  9593. !windows_verifies_chain);
  9594. #endif
  9595. session = create_session(ctx, sock);
  9596. }
  9597. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9598. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9599. // their identity is checked post-handshake below instead. On Mbed TLS and
  9600. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9601. // options.server_hostname_verification is threaded through here.
  9602. if (!is_ip_address(host)) {
  9603. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9604. return fail(Error::SSLConnection, 0, get_error());
  9605. }
  9606. }
  9607. TlsError tls_err;
  9608. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9609. &tls_err)) {
  9610. auto error = Error::SSLConnection;
  9611. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9612. error = Error::SSLServerVerification;
  9613. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9614. error = Error::SSLServerHostnameVerification;
  9615. }
  9616. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9617. }
  9618. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9619. if (options.session_verifier) {
  9620. verification_status = options.session_verifier(session);
  9621. }
  9622. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9623. return fail(Error::SSLServerVerification, 0, get_error());
  9624. }
  9625. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9626. server_certificate_verification) {
  9627. if (!windows_verifies_chain) {
  9628. auto verify_result = get_verify_result(session);
  9629. if (verify_result != 0) {
  9630. return fail(Error::SSLServerVerification, 0,
  9631. static_cast<uint64_t>(verify_result));
  9632. }
  9633. }
  9634. auto server_cert = get_peer_cert(session);
  9635. if (!server_cert) {
  9636. return fail(Error::SSLServerVerification, 0, get_error());
  9637. }
  9638. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9639. // Identity check against the peer certificate, post-handshake for all
  9640. // backends. For IP hosts this is the only identity verification, since no
  9641. // hostname is bound during the handshake.
  9642. if (options.server_hostname_verification) {
  9643. if (!verify_hostname(server_cert, host.c_str())) {
  9644. return fail(Error::SSLServerHostnameVerification, 0,
  9645. hostname_mismatch_code());
  9646. }
  9647. }
  9648. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9649. // Windows Schannel verification, which lets Windows fetch missing roots
  9650. // and intermediates on demand. It must not be skipped: unless a server
  9651. // certificate verifier is set, it is the only chain check.
  9652. if (options.windows_cert_verification) {
  9653. std::vector<unsigned char> der;
  9654. uint64_t wincrypt_error = 0;
  9655. if (!get_cert_der(server_cert, der) ||
  9656. !verify_cert_with_windows_schannel(
  9657. der, host, options.server_hostname_verification, wincrypt_error,
  9658. session)) {
  9659. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9660. }
  9661. }
  9662. #endif
  9663. }
  9664. return true;
  9665. }
  9666. } // namespace detail
  9667. #endif // CPPHTTPLIB_SSL_ENABLED
  9668. /*
  9669. * Group 3: httplib namespace - Non-SSL public API implementations
  9670. */
  9671. inline void default_socket_options(socket_t sock) {
  9672. set_socket_opt(sock, SOL_SOCKET,
  9673. #ifdef SO_REUSEPORT
  9674. SO_REUSEPORT,
  9675. #else
  9676. SO_REUSEADDR,
  9677. #endif
  9678. 1);
  9679. }
  9680. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9681. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9682. sizeof(optval));
  9683. }
  9684. inline std::string get_bearer_token_auth(const Request &req) {
  9685. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9686. // than the prefix carries no token.
  9687. constexpr const char bearer_prefix[] = "Bearer ";
  9688. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9689. auto value = req.get_header_value("Authorization");
  9690. if (value.size() >= bearer_prefix_len &&
  9691. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9692. bearer_prefix)) {
  9693. return value.substr(bearer_prefix_len);
  9694. }
  9695. return "";
  9696. }
  9697. inline const char *status_message(int status) {
  9698. switch (status) {
  9699. case StatusCode::Continue_100: return "Continue";
  9700. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9701. case StatusCode::Processing_102: return "Processing";
  9702. case StatusCode::EarlyHints_103: return "Early Hints";
  9703. case StatusCode::OK_200: return "OK";
  9704. case StatusCode::Created_201: return "Created";
  9705. case StatusCode::Accepted_202: return "Accepted";
  9706. case StatusCode::NonAuthoritativeInformation_203:
  9707. return "Non-Authoritative Information";
  9708. case StatusCode::NoContent_204: return "No Content";
  9709. case StatusCode::ResetContent_205: return "Reset Content";
  9710. case StatusCode::PartialContent_206: return "Partial Content";
  9711. case StatusCode::MultiStatus_207: return "Multi-Status";
  9712. case StatusCode::AlreadyReported_208: return "Already Reported";
  9713. case StatusCode::IMUsed_226: return "IM Used";
  9714. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9715. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9716. case StatusCode::Found_302: return "Found";
  9717. case StatusCode::SeeOther_303: return "See Other";
  9718. case StatusCode::NotModified_304: return "Not Modified";
  9719. case StatusCode::UseProxy_305: return "Use Proxy";
  9720. case StatusCode::unused_306: return "unused";
  9721. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9722. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9723. case StatusCode::BadRequest_400: return "Bad Request";
  9724. case StatusCode::Unauthorized_401: return "Unauthorized";
  9725. case StatusCode::PaymentRequired_402: return "Payment Required";
  9726. case StatusCode::Forbidden_403: return "Forbidden";
  9727. case StatusCode::NotFound_404: return "Not Found";
  9728. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9729. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9730. case StatusCode::ProxyAuthenticationRequired_407:
  9731. return "Proxy Authentication Required";
  9732. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9733. case StatusCode::Conflict_409: return "Conflict";
  9734. case StatusCode::Gone_410: return "Gone";
  9735. case StatusCode::LengthRequired_411: return "Length Required";
  9736. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9737. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9738. case StatusCode::UriTooLong_414: return "URI Too Long";
  9739. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9740. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9741. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9742. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9743. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9744. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9745. case StatusCode::Locked_423: return "Locked";
  9746. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9747. case StatusCode::TooEarly_425: return "Too Early";
  9748. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9749. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9750. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9751. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9752. return "Request Header Fields Too Large";
  9753. case StatusCode::UnavailableForLegalReasons_451:
  9754. return "Unavailable For Legal Reasons";
  9755. case StatusCode::NotImplemented_501: return "Not Implemented";
  9756. case StatusCode::BadGateway_502: return "Bad Gateway";
  9757. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9758. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9759. case StatusCode::HttpVersionNotSupported_505:
  9760. return "HTTP Version Not Supported";
  9761. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9762. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9763. case StatusCode::LoopDetected_508: return "Loop Detected";
  9764. case StatusCode::NotExtended_510: return "Not Extended";
  9765. case StatusCode::NetworkAuthenticationRequired_511:
  9766. return "Network Authentication Required";
  9767. default:
  9768. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9769. }
  9770. }
  9771. inline std::string to_string(const Error error) {
  9772. switch (error) {
  9773. case Error::Success: return "Success (no error)";
  9774. case Error::Unknown: return "Unknown";
  9775. case Error::Connection: return "Could not establish connection";
  9776. case Error::BindIPAddress: return "Failed to bind IP address";
  9777. case Error::Read: return "Failed to read connection";
  9778. case Error::Write: return "Failed to write connection";
  9779. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9780. case Error::Canceled: return "Connection handling canceled";
  9781. case Error::SSLConnection: return "SSL connection failed";
  9782. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9783. case Error::SSLServerVerification: return "SSL server verification failed";
  9784. case Error::SSLServerHostnameVerification:
  9785. return "SSL server hostname verification failed";
  9786. case Error::UnsupportedMultipartBoundaryChars:
  9787. return "Unsupported HTTP multipart boundary characters";
  9788. case Error::Compression: return "Compression failed";
  9789. case Error::ConnectionTimeout: return "Connection timed out";
  9790. case Error::ProxyConnection: return "Proxy connection failed";
  9791. case Error::ConnectionClosed: return "Connection closed by server";
  9792. case Error::Timeout: return "Read timeout";
  9793. case Error::ResourceExhaustion: return "Resource exhaustion";
  9794. case Error::TooManyFormDataFiles: return "Too many form data files";
  9795. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9796. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9797. case Error::ExceedMaxSocketDescriptorCount:
  9798. return "Exceeded maximum socket descriptor count";
  9799. case Error::InvalidRequestLine: return "Invalid request line";
  9800. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9801. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9802. case Error::InvalidHeaders: return "Invalid headers";
  9803. case Error::MultipartParsing: return "Multipart parsing failed";
  9804. case Error::OpenFile: return "Failed to open file";
  9805. case Error::Listen: return "Failed to listen on socket";
  9806. case Error::GetSockName: return "Failed to get socket name";
  9807. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9808. case Error::HTTPParsing: return "HTTP parsing failed";
  9809. case Error::InvalidRangeHeader: return "Invalid Range header";
  9810. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9811. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9812. case Error::UserCallbackException: return "User callback threw an exception";
  9813. default: break;
  9814. }
  9815. return "Invalid";
  9816. }
  9817. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9818. os << to_string(obj);
  9819. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9820. return os;
  9821. }
  9822. inline std::string hosted_at(const std::string &hostname) {
  9823. std::vector<std::string> addrs;
  9824. hosted_at(hostname, addrs);
  9825. if (addrs.empty()) { return std::string(); }
  9826. return addrs[0];
  9827. }
  9828. inline void hosted_at(const std::string &hostname,
  9829. std::vector<std::string> &addrs) {
  9830. struct addrinfo hints;
  9831. struct addrinfo *result;
  9832. memset(&hints, 0, sizeof(struct addrinfo));
  9833. hints.ai_family = AF_UNSPEC;
  9834. hints.ai_socktype = SOCK_STREAM;
  9835. hints.ai_protocol = 0;
  9836. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9837. &result, 0)) {
  9838. #if defined __linux__ && !defined __ANDROID__
  9839. res_init();
  9840. #endif
  9841. return;
  9842. }
  9843. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9844. for (auto rp = result; rp; rp = rp->ai_next) {
  9845. const auto &addr =
  9846. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9847. std::string ip;
  9848. auto dummy = -1;
  9849. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9850. dummy)) {
  9851. addrs.emplace_back(std::move(ip));
  9852. }
  9853. }
  9854. }
  9855. inline std::string encode_uri_component(const std::string &value) {
  9856. std::ostringstream escaped;
  9857. escaped.fill('0');
  9858. escaped << std::hex;
  9859. for (auto c : value) {
  9860. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9861. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9862. escaped << c;
  9863. } else {
  9864. escaped << std::uppercase;
  9865. escaped << '%' << std::setw(2)
  9866. << static_cast<int>(static_cast<unsigned char>(c));
  9867. escaped << std::nouppercase;
  9868. }
  9869. }
  9870. return escaped.str();
  9871. }
  9872. inline std::string encode_uri(const std::string &value) {
  9873. std::ostringstream escaped;
  9874. escaped.fill('0');
  9875. escaped << std::hex;
  9876. for (auto c : value) {
  9877. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9878. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9879. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9880. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9881. escaped << c;
  9882. } else {
  9883. escaped << std::uppercase;
  9884. escaped << '%' << std::setw(2)
  9885. << static_cast<int>(static_cast<unsigned char>(c));
  9886. escaped << std::nouppercase;
  9887. }
  9888. }
  9889. return escaped.str();
  9890. }
  9891. inline std::string decode_uri_component(const std::string &value) {
  9892. std::string result;
  9893. for (size_t i = 0; i < value.size(); i++) {
  9894. if (value[i] == '%' && i + 2 < value.size()) {
  9895. auto val = 0;
  9896. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9897. result += static_cast<char>(val);
  9898. i += 2;
  9899. } else {
  9900. result += value[i];
  9901. }
  9902. } else {
  9903. result += value[i];
  9904. }
  9905. }
  9906. return result;
  9907. }
  9908. inline std::string decode_uri(const std::string &value) {
  9909. std::string result;
  9910. for (size_t i = 0; i < value.size(); i++) {
  9911. if (value[i] == '%' && i + 2 < value.size()) {
  9912. auto val = 0;
  9913. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9914. auto c = static_cast<char>(val);
  9915. // Keep escapes of the reserved characters that encode_uri leaves
  9916. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9917. // delimiter is not promoted into a real one (as with JS decodeURI).
  9918. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9919. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9920. c == '#') {
  9921. result += value[i];
  9922. result += value[i + 1];
  9923. result += value[i + 2];
  9924. } else {
  9925. result += c;
  9926. }
  9927. i += 2;
  9928. } else {
  9929. result += value[i];
  9930. }
  9931. } else {
  9932. result += value[i];
  9933. }
  9934. }
  9935. return result;
  9936. }
  9937. inline std::string encode_path_component(const std::string &component) {
  9938. std::string result;
  9939. result.reserve(component.size() * 3);
  9940. for (size_t i = 0; i < component.size(); i++) {
  9941. auto c = static_cast<unsigned char>(component[i]);
  9942. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9943. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9944. c == '_' || c == '~') {
  9945. result += static_cast<char>(c);
  9946. }
  9947. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9948. // "," / ";" / "="
  9949. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9950. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9951. c == '=') {
  9952. result += static_cast<char>(c);
  9953. }
  9954. // Colon is allowed in path segments except first segment
  9955. else if (c == ':') {
  9956. result += static_cast<char>(c);
  9957. }
  9958. // @ is allowed in path
  9959. else if (c == '@') {
  9960. result += static_cast<char>(c);
  9961. } else {
  9962. result += '%';
  9963. char hex[3];
  9964. snprintf(hex, sizeof(hex), "%02X", c);
  9965. result.append(hex, 2);
  9966. }
  9967. }
  9968. return result;
  9969. }
  9970. inline std::string decode_path_component(const std::string &component) {
  9971. std::string result;
  9972. result.reserve(component.size());
  9973. for (size_t i = 0; i < component.size(); i++) {
  9974. if (component[i] == '%' && i + 1 < component.size()) {
  9975. if (component[i + 1] == 'u') {
  9976. // Unicode %uXXXX encoding
  9977. auto val = 0;
  9978. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9979. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9980. char buff[4];
  9981. size_t len = 0;
  9982. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9983. (len = detail::to_utf8(val, buff)) > 0) {
  9984. result.append(buff, len);
  9985. i += 5; // 'u0000'
  9986. } else {
  9987. // Not 4 hex digits, or a surrogate, which is no character: the
  9988. // escape is kept as it is rather than joining its neighbours
  9989. result += component[i];
  9990. }
  9991. } else {
  9992. // Standard %XX encoding
  9993. auto val = 0;
  9994. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9995. // 2 digits hex codes
  9996. result += static_cast<char>(val);
  9997. i += 2; // 'XX'
  9998. } else {
  9999. result += component[i];
  10000. }
  10001. }
  10002. } else {
  10003. result += component[i];
  10004. }
  10005. }
  10006. return result;
  10007. }
  10008. inline std::string encode_query_component(const std::string &component,
  10009. bool space_as_plus) {
  10010. std::string result;
  10011. result.reserve(component.size() * 3);
  10012. for (size_t i = 0; i < component.size(); i++) {
  10013. auto c = static_cast<unsigned char>(component[i]);
  10014. // Unreserved characters per RFC 3986
  10015. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10016. c == '_' || c == '~') {
  10017. result += static_cast<char>(c);
  10018. }
  10019. // Space handling
  10020. else if (c == ' ') {
  10021. if (space_as_plus) {
  10022. result += '+';
  10023. } else {
  10024. result += "%20";
  10025. }
  10026. }
  10027. // Plus sign handling
  10028. else if (c == '+') {
  10029. if (space_as_plus) {
  10030. result += "%2B";
  10031. } else {
  10032. result += static_cast<char>(c);
  10033. }
  10034. }
  10035. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10036. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10037. c == '*' || c == ',' || c == ';') {
  10038. result += static_cast<char>(c);
  10039. }
  10040. // Colon and @ are allowed in query
  10041. else if (c == ':' || c == '@') {
  10042. result += static_cast<char>(c);
  10043. }
  10044. // Forward slash is allowed in query values
  10045. else if (c == '/') {
  10046. result += static_cast<char>(c);
  10047. }
  10048. // Question mark is allowed in query values (after first ?)
  10049. else if (c == '?') {
  10050. result += static_cast<char>(c);
  10051. } else {
  10052. result += '%';
  10053. char hex[3];
  10054. snprintf(hex, sizeof(hex), "%02X", c);
  10055. result.append(hex, 2);
  10056. }
  10057. }
  10058. return result;
  10059. }
  10060. inline std::string decode_query_component(const std::string &component,
  10061. bool plus_as_space) {
  10062. std::string result;
  10063. result.reserve(component.size());
  10064. for (size_t i = 0; i < component.size(); i++) {
  10065. if (component[i] == '%' && i + 2 < component.size()) {
  10066. auto val = 0;
  10067. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10068. result += static_cast<char>(val);
  10069. i += 2;
  10070. } else {
  10071. result += component[i];
  10072. }
  10073. } else if (component[i] == '+' && plus_as_space) {
  10074. result += ' '; // + becomes space in form-urlencoded
  10075. } else {
  10076. result += component[i];
  10077. }
  10078. }
  10079. return result;
  10080. }
  10081. inline std::string sanitize_filename(const std::string &filename) {
  10082. // Extract basename: find the last path separator (/ or \)
  10083. auto pos = filename.find_last_of("/\\");
  10084. auto result =
  10085. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10086. // Strip null bytes
  10087. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10088. // Trim whitespace
  10089. {
  10090. auto start = result.find_first_not_of(" \t");
  10091. auto end = result.find_last_not_of(" \t");
  10092. result = (start == std::string::npos)
  10093. ? ""
  10094. : result.substr(start, end - start + 1);
  10095. }
  10096. // Reject . and ..
  10097. if (result == "." || result == "..") { return ""; }
  10098. return result;
  10099. }
  10100. inline std::string append_query_params(const std::string &path,
  10101. const Params &params) {
  10102. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10103. auto fragment_pos = path.find('#');
  10104. auto path_with_query = path.substr(0, fragment_pos);
  10105. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10106. path_with_query += detail::params_to_query_str(params);
  10107. if (fragment_pos != std::string::npos) {
  10108. path_with_query.append(path, fragment_pos, std::string::npos);
  10109. }
  10110. return path_with_query;
  10111. }
  10112. // Header utilities
  10113. inline std::pair<std::string, std::string>
  10114. make_range_header(const Ranges &ranges) {
  10115. std::string field = "bytes=";
  10116. auto i = 0;
  10117. for (const auto &r : ranges) {
  10118. if (i != 0) { field += ", "; }
  10119. if (r.first != -1) { field += std::to_string(r.first); }
  10120. field += '-';
  10121. if (r.second != -1) { field += std::to_string(r.second); }
  10122. i++;
  10123. }
  10124. return std::make_pair("Range", std::move(field));
  10125. }
  10126. inline std::pair<std::string, std::string>
  10127. make_basic_authentication_header(const std::string &username,
  10128. const std::string &password, bool is_proxy) {
  10129. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10130. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10131. return std::make_pair(key, std::move(field));
  10132. }
  10133. inline std::pair<std::string, std::string>
  10134. make_bearer_token_authentication_header(const std::string &token,
  10135. bool is_proxy = false) {
  10136. auto field = "Bearer " + token;
  10137. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10138. return std::make_pair(key, std::move(field));
  10139. }
  10140. namespace detail {
  10141. // Basic auth when a username or password is set, otherwise a bearer token,
  10142. // unless the request already carries the header.
  10143. inline void add_authorization_header(Request &req, const std::string &username,
  10144. const std::string &password,
  10145. const std::string &token, bool is_proxy) {
  10146. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10147. return;
  10148. }
  10149. if (!username.empty() || !password.empty()) {
  10150. req.headers.insert(
  10151. make_basic_authentication_header(username, password, is_proxy));
  10152. } else if (!token.empty()) {
  10153. req.headers.insert(
  10154. make_bearer_token_authentication_header(token, is_proxy));
  10155. }
  10156. }
  10157. } // namespace detail
  10158. // Request implementation
  10159. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10160. size_t id) const {
  10161. return detail::get_header_value_u64(headers, key, def, id);
  10162. }
  10163. inline bool Request::has_header(const std::string &key) const {
  10164. return detail::has_header(headers, key);
  10165. }
  10166. inline std::string Request::get_header_value(const std::string &key,
  10167. const char *def, size_t id) const {
  10168. return detail::get_header_value(headers, key, def, id);
  10169. }
  10170. inline size_t Request::get_header_value_count(const std::string &key) const {
  10171. return detail::get_header_value_count(headers, key);
  10172. }
  10173. inline void Request::set_header(const std::string &key,
  10174. const std::string &val) {
  10175. detail::set_header(headers, key, val);
  10176. }
  10177. inline bool Request::has_trailer(const std::string &key) const {
  10178. return trailers.find(key) != trailers.end();
  10179. }
  10180. inline std::string Request::get_trailer_value(const std::string &key,
  10181. size_t id) const {
  10182. return detail::get_multimap_value(trailers, key, id);
  10183. }
  10184. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10185. return trailers.count(key);
  10186. }
  10187. inline bool Request::has_param(const std::string &key) const {
  10188. return params.find(key) != params.end();
  10189. }
  10190. inline std::string Request::get_param_value(const std::string &key,
  10191. size_t id) const {
  10192. return detail::get_multimap_value(params, key, id);
  10193. }
  10194. inline std::vector<std::string>
  10195. Request::get_param_values(const std::string &key) const {
  10196. auto rng = params.equal_range(key);
  10197. std::vector<std::string> values;
  10198. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10199. for (auto it = rng.first; it != rng.second; ++it) {
  10200. values.push_back(it->second);
  10201. }
  10202. return values;
  10203. }
  10204. inline size_t Request::get_param_value_count(const std::string &key) const {
  10205. return params.count(key);
  10206. }
  10207. inline bool Request::is_multipart_form_data() const {
  10208. const auto &content_type = get_header_value("Content-Type");
  10209. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10210. "multipart/form-data");
  10211. }
  10212. // Multipart FormData implementation
  10213. inline std::string MultipartFormData::get_field(const std::string &key,
  10214. size_t id) const {
  10215. auto rng = fields.equal_range(key);
  10216. auto it = detail::bounded_next(rng.first, id, rng.second);
  10217. if (it != rng.second) { return it->second.content; }
  10218. return std::string();
  10219. }
  10220. inline std::vector<std::string>
  10221. MultipartFormData::get_fields(const std::string &key) const {
  10222. std::vector<std::string> values;
  10223. auto rng = fields.equal_range(key);
  10224. for (auto it = rng.first; it != rng.second; it++) {
  10225. values.push_back(it->second.content);
  10226. }
  10227. return values;
  10228. }
  10229. inline bool MultipartFormData::has_field(const std::string &key) const {
  10230. return fields.find(key) != fields.end();
  10231. }
  10232. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10233. return fields.count(key);
  10234. }
  10235. inline FormData MultipartFormData::get_file(const std::string &key,
  10236. size_t id) const {
  10237. return detail::get_multimap_value(files, key, id);
  10238. }
  10239. inline std::vector<FormData>
  10240. MultipartFormData::get_files(const std::string &key) const {
  10241. std::vector<FormData> values;
  10242. auto rng = files.equal_range(key);
  10243. for (auto it = rng.first; it != rng.second; it++) {
  10244. values.push_back(it->second);
  10245. }
  10246. return values;
  10247. }
  10248. inline bool MultipartFormData::has_file(const std::string &key) const {
  10249. return files.find(key) != files.end();
  10250. }
  10251. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10252. return files.count(key);
  10253. }
  10254. // Multipart FormData writer implementation
  10255. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10256. return detail::is_multipart_boundary_chars_valid(boundary);
  10257. }
  10258. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10259. : boundary_(detail::make_multipart_data_boundary()) {}
  10260. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10261. : boundary_(std::move(boundary)) {}
  10262. inline const std::string &MultipartFormDataWriter::boundary() const {
  10263. return boundary_;
  10264. }
  10265. inline std::string MultipartFormDataWriter::content_type() const {
  10266. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10267. }
  10268. inline std::string
  10269. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10270. return detail::serialize_multipart_formdata(items, boundary_);
  10271. }
  10272. inline size_t MultipartFormDataWriter::content_length(
  10273. const UploadFormDataItems &items) const {
  10274. return detail::get_multipart_content_length(items, boundary_);
  10275. }
  10276. inline std::string
  10277. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10278. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10279. }
  10280. inline std::string MultipartFormDataWriter::item_end() {
  10281. return detail::serialize_multipart_formdata_item_end();
  10282. }
  10283. inline std::string MultipartFormDataWriter::finish() const {
  10284. return detail::serialize_multipart_formdata_finish(boundary_);
  10285. }
  10286. // Response implementation
  10287. namespace detail {
  10288. // A response has one content source: `body`, a content provider, or a file.
  10289. // Each content setter calls this so that the one called last wins.
  10290. inline void clear_content_provider(Response &res) {
  10291. auto releaser = std::move(res.content_provider_resource_releaser_);
  10292. auto success = res.content_provider_success_;
  10293. res.content_length_ = 0;
  10294. res.content_provider_ = nullptr;
  10295. res.content_provider_resource_releaser_ = nullptr;
  10296. res.is_chunked_content_provider_ = false;
  10297. res.is_file_content_provider_ = false;
  10298. res.content_provider_success_ = false;
  10299. res.content_coding_ = EncodingType::None;
  10300. res.file_content_path_.clear();
  10301. res.file_content_content_type_.clear();
  10302. if (releaser) { releaser(success); }
  10303. }
  10304. inline void clear_content(Response &res) {
  10305. res.body.clear();
  10306. clear_content_provider(res);
  10307. }
  10308. // The Content-Type of the old content goes with it.
  10309. inline void set_content_type(Response &res, const std::string &content_type) {
  10310. res.headers.erase("Content-Type");
  10311. res.set_header("Content-Type", content_type);
  10312. }
  10313. // `body` is public, so it can be assigned directly after a provider or a file
  10314. // was set. It came last, so it wins.
  10315. inline void prefer_assigned_body(Response &res) {
  10316. if (!res.body.empty() &&
  10317. (res.content_provider_ || !res.file_content_path_.empty())) {
  10318. clear_content_provider(res);
  10319. }
  10320. }
  10321. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10322. inline bool body_allowed_for_status(int status) {
  10323. return status >= 200 && status != StatusCode::NoContent_204 &&
  10324. status != StatusCode::NotModified_304;
  10325. }
  10326. // Only a 206 response is served as a partial representation. range_error()
  10327. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10328. // status would start from an unchecked offset.
  10329. inline bool is_partial_content(const Request &req, const Response &res) {
  10330. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10331. }
  10332. // Sets the Content-Length or Transfer-Encoding framing the body that
  10333. // Server::write_response_core() writes, or closes the connection after a body
  10334. // that has neither. Only the library sets them: one from a handler would go
  10335. // out next to it, or describe some other body.
  10336. inline void set_framing_headers(const Request &req, Response &res,
  10337. const std::string &boundary,
  10338. const std::string &content_type) {
  10339. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10340. auto head_length = req.method == "HEAD"
  10341. ? res.get_header_value("Content-Length")
  10342. : std::string();
  10343. res.headers.erase("Content-Length");
  10344. res.headers.erase("Transfer-Encoding");
  10345. if (!body_allowed_for_status(res.status)) { return; }
  10346. if (res.content_provider_) {
  10347. if (res.content_length_ == 0) {
  10348. if (res.is_chunked_content_provider_) {
  10349. res.set_header("Transfer-Encoding", "chunked");
  10350. } else if (req.method != "HEAD") {
  10351. // RFC 9112 6.3: a body with neither ends where the connection does.
  10352. res.headers.erase("Keep-Alive");
  10353. if (!has_header_token(res.headers, "Connection", "close")) {
  10354. res.set_header("Connection", "close");
  10355. }
  10356. }
  10357. return;
  10358. }
  10359. // The part Server::write_content_with_provider() writes.
  10360. auto length = res.content_length_;
  10361. if (is_partial_content(req, res)) {
  10362. length = req.ranges.size() == 1
  10363. ? get_range_offset_and_length(req.ranges[0], length).second
  10364. : get_multipart_ranges_data_length(req, boundary,
  10365. content_type, length);
  10366. }
  10367. res.set_header("Content-Length", std::to_string(length));
  10368. } else if (!res.body.empty()) {
  10369. res.set_header("Content-Length", std::to_string(res.body.size()));
  10370. } else {
  10371. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10372. }
  10373. }
  10374. } // namespace detail
  10375. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10376. size_t id) const {
  10377. return detail::get_header_value_u64(headers, key, def, id);
  10378. }
  10379. inline bool Response::has_header(const std::string &key) const {
  10380. return headers.find(key) != headers.end();
  10381. }
  10382. inline std::string Response::get_header_value(const std::string &key,
  10383. const char *def,
  10384. size_t id) const {
  10385. return detail::get_header_value(headers, key, def, id);
  10386. }
  10387. inline size_t Response::get_header_value_count(const std::string &key) const {
  10388. return detail::get_header_value_count(headers, key);
  10389. }
  10390. inline void Response::set_header(const std::string &key,
  10391. const std::string &val) {
  10392. detail::set_header(headers, key, val);
  10393. }
  10394. inline bool Response::has_trailer(const std::string &key) const {
  10395. return trailers.find(key) != trailers.end();
  10396. }
  10397. inline std::string Response::get_trailer_value(const std::string &key,
  10398. size_t id) const {
  10399. return detail::get_multimap_value(trailers, key, id);
  10400. }
  10401. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10402. return trailers.count(key);
  10403. }
  10404. inline void Response::set_redirect(const std::string &url, int stat) {
  10405. if (detail::fields::is_field_value(url)) {
  10406. set_header("Location", url);
  10407. if (300 <= stat && stat < 400) {
  10408. this->status = stat;
  10409. } else {
  10410. this->status = StatusCode::Found_302;
  10411. }
  10412. }
  10413. }
  10414. inline void Response::set_content(const char *s, size_t n,
  10415. const std::string &content_type) {
  10416. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10417. detail::clear_content_provider(*this);
  10418. detail::set_content_type(*this, content_type);
  10419. }
  10420. inline void Response::set_content(const std::string &s,
  10421. const std::string &content_type) {
  10422. set_content(s.data(), s.size(), content_type);
  10423. }
  10424. inline void Response::set_content(std::string &&s,
  10425. const std::string &content_type) {
  10426. body = std::move(s);
  10427. detail::clear_content_provider(*this);
  10428. detail::set_content_type(*this, content_type);
  10429. }
  10430. inline void Response::set_content_provider(
  10431. size_t in_length, const std::string &content_type, ContentProvider provider,
  10432. ContentProviderResourceReleaser resource_releaser) {
  10433. detail::clear_content(*this);
  10434. detail::set_content_type(*this, content_type);
  10435. content_length_ = in_length;
  10436. if (in_length > 0) { content_provider_ = std::move(provider); }
  10437. content_provider_resource_releaser_ = std::move(resource_releaser);
  10438. }
  10439. inline void Response::set_content_provider(
  10440. const std::string &content_type, ContentProviderWithoutLength provider,
  10441. ContentProviderResourceReleaser resource_releaser) {
  10442. detail::clear_content(*this);
  10443. detail::set_content_type(*this, content_type);
  10444. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10445. content_provider_resource_releaser_ = std::move(resource_releaser);
  10446. }
  10447. inline void Response::set_chunked_content_provider(
  10448. const std::string &content_type, ContentProviderWithoutLength provider,
  10449. ContentProviderResourceReleaser resource_releaser) {
  10450. set_content_provider(content_type, std::move(provider),
  10451. std::move(resource_releaser));
  10452. is_chunked_content_provider_ = true;
  10453. }
  10454. inline void Response::set_file_content(const std::string &path,
  10455. const std::string &content_type) {
  10456. detail::clear_content(*this);
  10457. headers.erase("Content-Type");
  10458. file_content_path_ = path;
  10459. file_content_content_type_ = content_type;
  10460. }
  10461. inline void Response::set_file_content(const std::string &path) {
  10462. set_file_content(path, std::string());
  10463. }
  10464. // Result implementation
  10465. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10466. size_t def,
  10467. size_t id) const {
  10468. return detail::get_header_value_u64(request_headers_, key, def, id);
  10469. }
  10470. inline bool Result::has_request_header(const std::string &key) const {
  10471. return request_headers_.find(key) != request_headers_.end();
  10472. }
  10473. inline std::string Result::get_request_header_value(const std::string &key,
  10474. const char *def,
  10475. size_t id) const {
  10476. return detail::get_header_value(request_headers_, key, def, id);
  10477. }
  10478. inline size_t
  10479. Result::get_request_header_value_count(const std::string &key) const {
  10480. return request_headers_.count(key);
  10481. }
  10482. // Stream implementation
  10483. inline ssize_t Stream::write(const char *ptr) {
  10484. return write(ptr, strlen(ptr));
  10485. }
  10486. inline ssize_t Stream::write(const std::string &s) {
  10487. return write(s.data(), s.size());
  10488. }
  10489. // BodyReader implementation
  10490. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10491. if (!stream) {
  10492. last_error = Error::Connection;
  10493. return -1;
  10494. }
  10495. if (eof) { return 0; }
  10496. if (!chunked) {
  10497. // Content-Length based reading
  10498. if (has_content_length && bytes_read >= content_length) {
  10499. eof = true;
  10500. return 0;
  10501. }
  10502. auto to_read = len;
  10503. if (has_content_length) {
  10504. auto remaining = content_length - bytes_read;
  10505. to_read = (std::min)(len, remaining);
  10506. }
  10507. auto n = stream->read(buf, to_read);
  10508. // Without Content-Length the body ends when the connection closes
  10509. // (RFC 9112 §6.3); with one, an EOF here came too early
  10510. if (n < 0 || (n == 0 && has_content_length)) {
  10511. last_error = stream->get_error();
  10512. if (last_error == Error::Success) { last_error = Error::Read; }
  10513. }
  10514. if (n <= 0) {
  10515. eof = true;
  10516. return n;
  10517. }
  10518. bytes_read += static_cast<size_t>(n);
  10519. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10520. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10521. last_error = Error::ExceedMaxPayloadSize;
  10522. eof = true;
  10523. return -1;
  10524. }
  10525. return n;
  10526. }
  10527. // Chunked transfer encoding: delegate to shared decoder instance.
  10528. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10529. size_t chunk_offset = 0;
  10530. size_t chunk_total = 0;
  10531. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10532. if (n < 0) {
  10533. last_error = stream->get_error();
  10534. if (last_error == Error::Success) { last_error = Error::Read; }
  10535. eof = true;
  10536. return n;
  10537. }
  10538. if (n == 0) {
  10539. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10540. eof = true;
  10541. return 0;
  10542. }
  10543. bytes_read += static_cast<size_t>(n);
  10544. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10545. last_error = Error::ExceedMaxPayloadSize;
  10546. eof = true;
  10547. return -1;
  10548. }
  10549. return n;
  10550. }
  10551. // ThreadPool implementation
  10552. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10553. time_t idle_timeout_sec)
  10554. : base_thread_count_(n), max_queued_requests_(mqr),
  10555. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10556. shutdown_(false) {
  10557. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10558. if (max_n != 0 && max_n < n) {
  10559. std::string msg = "max_threads must be >= base_threads";
  10560. throw std::invalid_argument(msg);
  10561. }
  10562. #endif
  10563. max_thread_count_ = max_n == 0 ? n : max_n;
  10564. threads_.reserve(base_thread_count_);
  10565. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10566. try {
  10567. #endif
  10568. for (size_t i = 0; i < base_thread_count_; i++) {
  10569. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10570. }
  10571. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10572. } catch (...) {
  10573. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10574. // signal the workers we already spawned to exit and join them so the
  10575. // vector destructor does not see joinable threads (which would call
  10576. // std::terminate). Then rethrow so the caller learns of the failure.
  10577. {
  10578. std::unique_lock<std::mutex> lock(mutex_);
  10579. shutdown_ = true;
  10580. }
  10581. cond_.notify_all();
  10582. for (auto &t : threads_) {
  10583. if (t.joinable()) { t.join(); }
  10584. }
  10585. throw;
  10586. }
  10587. #endif
  10588. }
  10589. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10590. {
  10591. std::unique_lock<std::mutex> lock(mutex_);
  10592. if (shutdown_) { return false; }
  10593. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10594. return false;
  10595. }
  10596. jobs_.push_back(std::move(fn));
  10597. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10598. if (jobs_.size() > idle_thread_count_ &&
  10599. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10600. cleanup_finished_threads();
  10601. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10602. }
  10603. }
  10604. cond_.notify_one();
  10605. return true;
  10606. }
  10607. inline void ThreadPool::shutdown() {
  10608. {
  10609. std::unique_lock<std::mutex> lock(mutex_);
  10610. shutdown_ = true;
  10611. }
  10612. cond_.notify_all();
  10613. for (auto &t : threads_) {
  10614. if (t.joinable()) { t.join(); }
  10615. }
  10616. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10617. // with worker threads that call move_to_finished() concurrently.
  10618. std::list<std::thread> remaining_dynamic;
  10619. {
  10620. std::unique_lock<std::mutex> lock(mutex_);
  10621. remaining_dynamic = std::move(dynamic_threads_);
  10622. }
  10623. for (auto &t : remaining_dynamic) {
  10624. if (t.joinable()) { t.join(); }
  10625. }
  10626. std::unique_lock<std::mutex> lock(mutex_);
  10627. cleanup_finished_threads();
  10628. }
  10629. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10630. // Must be called with mutex_ held
  10631. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10632. if (it->get_id() == id) {
  10633. finished_threads_.push_back(std::move(*it));
  10634. dynamic_threads_.erase(it);
  10635. return;
  10636. }
  10637. }
  10638. }
  10639. inline void ThreadPool::cleanup_finished_threads() {
  10640. // Must be called with mutex_ held
  10641. for (auto &t : finished_threads_) {
  10642. if (t.joinable()) { t.join(); }
  10643. }
  10644. finished_threads_.clear();
  10645. }
  10646. inline void ThreadPool::worker(bool is_dynamic) {
  10647. for (;;) {
  10648. std::function<void()> fn;
  10649. {
  10650. std::unique_lock<std::mutex> lock(mutex_);
  10651. idle_thread_count_++;
  10652. if (is_dynamic) {
  10653. auto has_work =
  10654. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10655. [&] { return !jobs_.empty() || shutdown_; });
  10656. if (!has_work) {
  10657. // Timed out with no work - exit this dynamic thread
  10658. idle_thread_count_--;
  10659. move_to_finished(std::this_thread::get_id());
  10660. break;
  10661. }
  10662. } else {
  10663. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10664. }
  10665. idle_thread_count_--;
  10666. if (shutdown_ && jobs_.empty()) { break; }
  10667. fn = std::move(jobs_.front());
  10668. jobs_.pop_front();
  10669. }
  10670. assert(true == static_cast<bool>(fn));
  10671. fn();
  10672. }
  10673. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10674. !defined(LIBRESSL_VERSION_NUMBER)
  10675. OPENSSL_thread_stop();
  10676. #endif
  10677. }
  10678. /*
  10679. * Group 1 (continued): detail namespace - Stream implementations
  10680. */
  10681. namespace detail {
  10682. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10683. time_t timeout_sec, time_t timeout_usec,
  10684. time_t &actual_timeout_sec,
  10685. time_t &actual_timeout_usec) {
  10686. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10687. auto actual_timeout_msec =
  10688. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10689. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10690. actual_timeout_sec = actual_timeout_msec / 1000;
  10691. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10692. }
  10693. // Socket stream implementation
  10694. inline SocketStream::SocketStream(
  10695. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10696. time_t write_timeout_sec, time_t write_timeout_usec,
  10697. time_t max_timeout_msec,
  10698. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10699. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10700. read_timeout_usec_(read_timeout_usec),
  10701. write_timeout_sec_(write_timeout_sec),
  10702. write_timeout_usec_(write_timeout_usec),
  10703. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10704. read_buff_(read_buff_size_, 0) {}
  10705. inline SocketStream::~SocketStream() = default;
  10706. inline bool SocketStream::is_readable() const {
  10707. return read_buff_off_ < read_buff_content_size_;
  10708. }
  10709. inline bool SocketStream::wait_readable() const {
  10710. if (max_timeout_msec_ <= 0) {
  10711. return select_read_interruptible(sock_, read_timeout_sec_,
  10712. read_timeout_usec_, read_interrupted_) > 0;
  10713. }
  10714. time_t read_timeout_sec;
  10715. time_t read_timeout_usec;
  10716. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10717. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10718. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10719. read_interrupted_) > 0;
  10720. }
  10721. inline bool SocketStream::wait_writable() const {
  10722. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10723. }
  10724. inline bool SocketStream::ensure_readable() {
  10725. if (readable_hint_) {
  10726. readable_hint_ = false;
  10727. return true;
  10728. }
  10729. return wait_readable();
  10730. }
  10731. inline const char *SocketStream::buffered_data(size_t &size) const {
  10732. size = read_buff_content_size_ - read_buff_off_;
  10733. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10734. }
  10735. inline void SocketStream::consume_buffered(size_t size) {
  10736. assert(size <= read_buff_content_size_ - read_buff_off_);
  10737. read_buff_off_ += size;
  10738. }
  10739. inline bool SocketStream::is_peer_alive() const {
  10740. return detail::is_socket_alive(sock_);
  10741. }
  10742. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10743. #ifdef _WIN32
  10744. size =
  10745. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10746. #else
  10747. size = (std::min)(size,
  10748. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10749. #endif
  10750. if (read_buff_off_ < read_buff_content_size_) {
  10751. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10752. if (size <= remaining_size) {
  10753. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10754. read_buff_off_ += size;
  10755. return static_cast<ssize_t>(size);
  10756. } else {
  10757. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10758. read_buff_off_ += remaining_size;
  10759. return static_cast<ssize_t>(remaining_size);
  10760. }
  10761. }
  10762. if (!ensure_readable()) {
  10763. error_ = Error::Timeout;
  10764. return -1;
  10765. }
  10766. read_buff_off_ = 0;
  10767. read_buff_content_size_ = 0;
  10768. if (size < read_buff_size_) {
  10769. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10770. CPPHTTPLIB_RECV_FLAGS);
  10771. if (n <= 0) {
  10772. if (n == 0) {
  10773. error_ = Error::ConnectionClosed;
  10774. } else {
  10775. error_ = Error::Read;
  10776. }
  10777. return n;
  10778. } else if (n <= static_cast<ssize_t>(size)) {
  10779. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10780. return n;
  10781. } else {
  10782. memcpy(ptr, read_buff_.data(), size);
  10783. read_buff_off_ = size;
  10784. read_buff_content_size_ = static_cast<size_t>(n);
  10785. return static_cast<ssize_t>(size);
  10786. }
  10787. } else {
  10788. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10789. if (n <= 0) {
  10790. if (n == 0) {
  10791. error_ = Error::ConnectionClosed;
  10792. } else {
  10793. error_ = Error::Read;
  10794. }
  10795. }
  10796. return n;
  10797. }
  10798. }
  10799. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10800. if (!wait_writable()) { return -1; }
  10801. #if defined(_WIN32) && !defined(_WIN64)
  10802. size =
  10803. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10804. #endif
  10805. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10806. }
  10807. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10808. int &port) const {
  10809. return detail::get_remote_ip_and_port(sock_, ip, port);
  10810. }
  10811. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10812. int &port) const {
  10813. return detail::get_local_ip_and_port(sock_, ip, port);
  10814. }
  10815. inline socket_t SocketStream::socket() const { return sock_; }
  10816. inline time_t SocketStream::duration() const {
  10817. return static_cast<time_t>(
  10818. std::chrono::duration_cast<std::chrono::milliseconds>(
  10819. std::chrono::steady_clock::now() - start_time_)
  10820. .count());
  10821. }
  10822. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10823. read_timeout_sec_ = sec;
  10824. read_timeout_usec_ = usec;
  10825. }
  10826. inline void SocketStream::set_max_timeout(time_t msec) {
  10827. max_timeout_msec_ = msec;
  10828. start_time_ = std::chrono::steady_clock::now();
  10829. }
  10830. inline void
  10831. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  10832. read_interrupted_ = std::move(interrupted);
  10833. }
  10834. // Buffer stream implementation
  10835. inline bool BufferStream::is_readable() const { return true; }
  10836. inline bool BufferStream::wait_readable() const { return true; }
  10837. inline bool BufferStream::wait_writable() const { return true; }
  10838. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10839. #if defined(_MSC_VER) && _MSC_VER < 1910
  10840. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10841. #else
  10842. auto len_read = buffer.copy(ptr, size, position);
  10843. #endif
  10844. position += static_cast<size_t>(len_read);
  10845. return static_cast<ssize_t>(len_read);
  10846. }
  10847. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10848. buffer.append(ptr, size);
  10849. return static_cast<ssize_t>(size);
  10850. }
  10851. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10852. int & /*port*/) const {}
  10853. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10854. int & /*port*/) const {}
  10855. inline socket_t BufferStream::socket() const { return 0; }
  10856. inline time_t BufferStream::duration() const { return 0; }
  10857. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10858. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10859. : MatcherBase(pattern) {
  10860. constexpr const char marker[] = "/:";
  10861. // One past the last ending position of a path param substring
  10862. std::size_t last_param_end = 0;
  10863. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10864. // Needed to ensure that parameter names are unique during matcher
  10865. // construction
  10866. // If exceptions are disabled, only last duplicate path
  10867. // parameter will be set
  10868. std::unordered_set<std::string> param_name_set;
  10869. #endif
  10870. while (true) {
  10871. const auto marker_pos = pattern.find(
  10872. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10873. if (marker_pos == std::string::npos) { break; }
  10874. static_fragments_.push_back(
  10875. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10876. const auto param_name_start = marker_pos + str_len(marker);
  10877. auto sep_pos = pattern.find(separator, param_name_start);
  10878. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10879. auto param_name =
  10880. pattern.substr(param_name_start, sep_pos - param_name_start);
  10881. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10882. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10883. std::string msg = "Encountered path parameter '" + param_name +
  10884. "' multiple times in route pattern '" + pattern + "'.";
  10885. throw std::invalid_argument(msg);
  10886. }
  10887. #endif
  10888. param_names_.push_back(std::move(param_name));
  10889. last_param_end = sep_pos + 1;
  10890. }
  10891. if (last_param_end < pattern.length()) {
  10892. static_fragments_.push_back(pattern.substr(last_param_end));
  10893. }
  10894. }
  10895. inline bool PathParamsMatcher::match(Request &request) const {
  10896. request.matches = std::smatch();
  10897. request.path_params.clear();
  10898. // A pattern without parameters is just a literal path to compare against
  10899. if (param_names_.empty()) { return request.path == pattern(); }
  10900. request.path_params.reserve(param_names_.size());
  10901. // One past the position at which the path matched the pattern last time
  10902. std::size_t starting_pos = 0;
  10903. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10904. const auto &fragment = static_fragments_[i];
  10905. if (starting_pos + fragment.length() > request.path.length()) {
  10906. return false;
  10907. }
  10908. // Avoid unnecessary allocation by using strncmp instead of substr +
  10909. // comparison
  10910. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10911. fragment.length()) != 0) {
  10912. return false;
  10913. }
  10914. starting_pos += fragment.length();
  10915. // Should only happen when we have a static fragment after a param
  10916. // Example: '/users/:id/subscriptions'
  10917. // The 'subscriptions' fragment here does not have a corresponding param
  10918. if (i >= param_names_.size()) { continue; }
  10919. auto sep_pos = request.path.find(separator, starting_pos);
  10920. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10921. const auto &param_name = param_names_[i];
  10922. request.path_params.emplace(
  10923. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10924. // Mark everything up to '/' as matched
  10925. starting_pos = sep_pos + 1;
  10926. }
  10927. // Returns false if the path is longer than the pattern
  10928. return starting_pos >= request.path.length();
  10929. }
  10930. inline bool RegexMatcher::match(Request &request) const {
  10931. request.path_params.clear();
  10932. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10933. // a non-match rather than risking a stack overflow in std::regex_match.
  10934. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10935. return false;
  10936. }
  10937. return std::regex_match(request.path, request.matches, regex_);
  10938. }
  10939. // Enclose IPv6 address in brackets if needed
  10940. inline std::string prepare_host_string(const std::string &host) {
  10941. // Enclose IPv6 address in brackets (but not if already enclosed)
  10942. if (host.find(':') == std::string::npos ||
  10943. (!host.empty() && host[0] == '[')) {
  10944. // IPv4, hostname, or already bracketed IPv6
  10945. return host;
  10946. } else {
  10947. // IPv6 address without brackets
  10948. return "[" + host + "]";
  10949. }
  10950. }
  10951. inline std::string make_host_and_port_string(const std::string &host, int port,
  10952. bool is_ssl) {
  10953. auto result = prepare_host_string(host);
  10954. // Append port if not default
  10955. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10956. ; // do nothing
  10957. } else {
  10958. result += ":" + std::to_string(port);
  10959. }
  10960. return result;
  10961. }
  10962. // Create "host:port" string always including port number (for CONNECT method)
  10963. inline std::string
  10964. make_host_and_port_string_always_port(const std::string &host, int port) {
  10965. return prepare_host_string(host) + ":" + std::to_string(port);
  10966. }
  10967. // Value for the Host header a client sends when the caller supplied none.
  10968. // Only the value: callers decide where in their header list it goes.
  10969. inline std::string make_default_host_header_value(const std::string &host,
  10970. int port, bool is_ssl,
  10971. int address_family) {
  10972. if (address_family == AF_UNIX) { return "localhost"; }
  10973. return make_host_and_port_string(host, port, is_ssl);
  10974. }
  10975. inline void add_default_user_agent_header(Request &req) {
  10976. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10977. if (!req.has_header("User-Agent")) {
  10978. req.set_header("User-Agent",
  10979. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10980. }
  10981. #else
  10982. (void)req;
  10983. #endif
  10984. }
  10985. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10986. NormalizedTarget normalize_target(const std::string &host);
  10987. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10988. bool host_matches_no_proxy(const NormalizedTarget &target,
  10989. const std::vector<NoProxyEntry> &entries);
  10990. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10991. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10992. if (prefix_bits == 0) { return true; }
  10993. int full_bytes = prefix_bits / 8;
  10994. int rem_bits = prefix_bits % 8;
  10995. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10996. static_cast<size_t>(full_bytes)) != 0) {
  10997. return false;
  10998. }
  10999. if (rem_bits == 0) { return true; }
  11000. auto i = static_cast<size_t>(full_bytes);
  11001. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11002. return (ip[i] & mask) == (net[i] & mask);
  11003. }
  11004. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11005. if (token.empty()) { return false; }
  11006. if (token == "*") {
  11007. out.kind = NoProxyKind::Wildcard;
  11008. return true;
  11009. }
  11010. auto slash = token.find('/');
  11011. std::string addr_part =
  11012. (slash == std::string::npos) ? token : token.substr(0, slash);
  11013. std::string prefix_part =
  11014. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11015. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11016. // don't silently treat it as a /32 (or /128).
  11017. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11018. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11019. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11020. // when brackets are present.
  11021. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11022. addr_part.back() == ']';
  11023. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11024. if (!bracketed) {
  11025. struct in_addr v4;
  11026. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11027. int prefix = 32;
  11028. if (!prefix_part.empty() &&
  11029. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11030. prefix)) {
  11031. return false;
  11032. }
  11033. out.kind = NoProxyKind::IPv4Cidr;
  11034. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11035. out.prefix_bits = prefix;
  11036. return true;
  11037. }
  11038. }
  11039. struct in6_addr v6;
  11040. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11041. int prefix = 128;
  11042. if (!prefix_part.empty() &&
  11043. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11044. prefix)) {
  11045. return false;
  11046. }
  11047. out.kind = NoProxyKind::IPv6Cidr;
  11048. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11049. out.prefix_bits = prefix;
  11050. return true;
  11051. }
  11052. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11053. // the entry is malformed — don't fall through to the hostname branch.
  11054. if (bracketed) { return false; }
  11055. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11056. if (slash != std::string::npos) { return false; }
  11057. // Port-specific entries (host:port) are not supported.
  11058. if (token.find(':') != std::string::npos) { return false; }
  11059. std::string hostname = case_ignore::to_lower(token);
  11060. while (!hostname.empty() && hostname.front() == '.') {
  11061. hostname.erase(hostname.begin());
  11062. }
  11063. while (!hostname.empty() && hostname.back() == '.') {
  11064. hostname.pop_back();
  11065. }
  11066. if (hostname.empty()) { return false; }
  11067. out.kind = NoProxyKind::HostnameSuffix;
  11068. out.hostname_pattern = std::move(hostname);
  11069. return true;
  11070. }
  11071. inline std::vector<NoProxyEntry>
  11072. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11073. std::vector<NoProxyEntry> entries;
  11074. entries.reserve(patterns.size());
  11075. for (const auto &p : patterns) {
  11076. auto trimmed = trim_copy(p);
  11077. if (trimmed.empty()) { continue; }
  11078. NoProxyEntry entry;
  11079. if (parse_no_proxy_entry(trimmed, entry)) {
  11080. entries.push_back(std::move(entry));
  11081. }
  11082. }
  11083. return entries;
  11084. }
  11085. inline NormalizedTarget normalize_target(const std::string &host) {
  11086. NormalizedTarget t;
  11087. std::string h = host;
  11088. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11089. h = h.substr(1, h.size() - 2);
  11090. }
  11091. // Strip a single trailing dot so "example.com." canonicalizes to
  11092. // "example.com".
  11093. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11094. t.hostname = case_ignore::to_lower(h);
  11095. if (!t.hostname.empty()) {
  11096. struct in_addr v4;
  11097. struct in6_addr v6;
  11098. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11099. t.is_ipv4 = true;
  11100. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11101. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11102. t.is_ipv6 = true;
  11103. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11104. }
  11105. }
  11106. return t;
  11107. }
  11108. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11109. const std::vector<NoProxyEntry> &entries) {
  11110. if (target.hostname.empty()) { return false; }
  11111. for (const auto &e : entries) {
  11112. switch (e.kind) {
  11113. case NoProxyKind::Wildcard: return true;
  11114. case NoProxyKind::IPv4Cidr:
  11115. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11116. return true;
  11117. }
  11118. break;
  11119. case NoProxyKind::IPv6Cidr:
  11120. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11121. return true;
  11122. }
  11123. break;
  11124. case NoProxyKind::HostnameSuffix:
  11125. if (target.is_ipv4 || target.is_ipv6) { break; }
  11126. if (target.hostname == e.hostname_pattern) { return true; }
  11127. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11128. // an entry of "example.com".
  11129. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11130. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11131. if (target.hostname[offset - 1] == '.' &&
  11132. target.hostname.compare(offset, e.hostname_pattern.size(),
  11133. e.hostname_pattern) == 0) {
  11134. return true;
  11135. }
  11136. }
  11137. break;
  11138. }
  11139. }
  11140. return false;
  11141. }
  11142. template <typename T>
  11143. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11144. T header_writer, Error &error) {
  11145. for (const auto &h : headers) {
  11146. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11147. error = Error::InvalidHeaders;
  11148. return false;
  11149. }
  11150. }
  11151. if (header_writer(strm, headers) <= 0) {
  11152. error = Error::Write;
  11153. return false;
  11154. }
  11155. return true;
  11156. }
  11157. } // namespace detail
  11158. /*
  11159. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11160. */
  11161. #ifdef CPPHTTPLIB_SSL_ENABLED
  11162. namespace detail {
  11163. // SSL socket stream implementation
  11164. inline SSLSocketStream::SSLSocketStream(
  11165. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11166. time_t read_timeout_usec, time_t write_timeout_sec,
  11167. time_t write_timeout_usec, time_t max_timeout_msec,
  11168. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11169. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11170. read_timeout_usec_(read_timeout_usec),
  11171. write_timeout_sec_(write_timeout_sec),
  11172. write_timeout_usec_(write_timeout_usec),
  11173. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11174. tls_error_.code = tls::ErrorCode::Success;
  11175. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11176. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11177. // Note: create_session() also clears this, but SSLClient currently
  11178. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11179. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11180. // SSL session was created.
  11181. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11182. #endif
  11183. }
  11184. inline SSLSocketStream::~SSLSocketStream() = default;
  11185. inline bool SSLSocketStream::is_readable() const {
  11186. return tls::pending(session_) > 0;
  11187. }
  11188. inline bool SSLSocketStream::wait_readable() const {
  11189. if (max_timeout_msec_ <= 0) {
  11190. return select_read_interruptible(sock_, read_timeout_sec_,
  11191. read_timeout_usec_, read_interrupted_) > 0;
  11192. }
  11193. time_t read_timeout_sec;
  11194. time_t read_timeout_usec;
  11195. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11196. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11197. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11198. read_interrupted_) > 0;
  11199. }
  11200. inline bool SSLSocketStream::wait_writable() const {
  11201. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11202. !tls::is_peer_closed(session_, sock_);
  11203. }
  11204. inline bool SSLSocketStream::ensure_readable() {
  11205. if (readable_hint_) {
  11206. readable_hint_ = false;
  11207. return true;
  11208. }
  11209. return wait_readable();
  11210. }
  11211. inline bool SSLSocketStream::is_peer_alive() const {
  11212. return !tls::is_peer_closed(session_, sock_);
  11213. }
  11214. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11215. if (tls::pending(session_) > 0) {
  11216. tls::TlsError err;
  11217. auto ret = tls::read(session_, ptr, size, err);
  11218. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11219. error_ = Error::ConnectionClosed;
  11220. } else if (ret < 0) {
  11221. tls_error_ = err;
  11222. }
  11223. return ret;
  11224. } else if (ensure_readable()) {
  11225. tls::TlsError err;
  11226. auto ret = tls::read(session_, ptr, size, err);
  11227. if (ret < 0) {
  11228. auto n = 1000;
  11229. #ifdef _WIN32
  11230. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11231. (err.code == tls::ErrorCode::SyscallError &&
  11232. WSAGetLastError() == WSAETIMEDOUT))) {
  11233. #else
  11234. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11235. #endif
  11236. if (tls::pending(session_) > 0) {
  11237. ret = tls::read(session_, ptr, size, err);
  11238. if (ret >= 0) { return ret; }
  11239. break;
  11240. } else if (wait_readable()) {
  11241. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11242. ret = tls::read(session_, ptr, size, err);
  11243. if (ret >= 0) { return ret; }
  11244. } else {
  11245. break;
  11246. }
  11247. }
  11248. assert(ret < 0);
  11249. tls_error_ = err;
  11250. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11251. error_ = Error::ConnectionClosed;
  11252. }
  11253. return ret;
  11254. } else {
  11255. error_ = Error::Timeout;
  11256. return -1;
  11257. }
  11258. }
  11259. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11260. if (wait_writable()) {
  11261. auto handle_size =
  11262. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11263. tls::TlsError err;
  11264. auto ret = tls::write(session_, ptr, handle_size, err);
  11265. if (ret < 0) {
  11266. auto n = 1000;
  11267. #ifdef _WIN32
  11268. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11269. (err.code == tls::ErrorCode::SyscallError &&
  11270. WSAGetLastError() == WSAETIMEDOUT))) {
  11271. #else
  11272. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11273. #endif
  11274. if (wait_writable()) {
  11275. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11276. ret = tls::write(session_, ptr, handle_size, err);
  11277. if (ret >= 0) { return ret; }
  11278. } else {
  11279. break;
  11280. }
  11281. }
  11282. assert(ret < 0);
  11283. tls_error_ = err;
  11284. }
  11285. return ret;
  11286. }
  11287. return -1;
  11288. }
  11289. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11290. int &port) const {
  11291. detail::get_remote_ip_and_port(sock_, ip, port);
  11292. }
  11293. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11294. int &port) const {
  11295. detail::get_local_ip_and_port(sock_, ip, port);
  11296. }
  11297. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11298. inline time_t SSLSocketStream::duration() const {
  11299. return static_cast<time_t>(
  11300. std::chrono::duration_cast<std::chrono::milliseconds>(
  11301. std::chrono::steady_clock::now() - start_time_)
  11302. .count());
  11303. }
  11304. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11305. read_timeout_sec_ = sec;
  11306. read_timeout_usec_ = usec;
  11307. }
  11308. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11309. max_timeout_msec_ = msec;
  11310. start_time_ = std::chrono::steady_clock::now();
  11311. }
  11312. inline void
  11313. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11314. read_interrupted_ = std::move(interrupted);
  11315. }
  11316. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11317. tls::session_t session,
  11318. time_t read_timeout_sec,
  11319. time_t read_timeout_usec,
  11320. time_t write_timeout_sec,
  11321. time_t write_timeout_usec)
  11322. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11323. read_timeout_usec_(read_timeout_usec),
  11324. write_timeout_sec_(write_timeout_sec),
  11325. write_timeout_usec_(write_timeout_usec),
  11326. start_time_(std::chrono::steady_clock::now()) {
  11327. // The receive and send paths run on different threads, so each TLS call is
  11328. // driven in non-blocking mode and readiness is awaited with select()
  11329. // outside the session lock. Set the socket non-blocking once here; it is
  11330. // never flipped back, so no thread races on the flag.
  11331. detail::set_nonblocking(sock_, true);
  11332. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11333. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11334. #endif
  11335. }
  11336. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11337. inline bool WebSocketSSLStream::is_readable() const {
  11338. std::lock_guard<std::mutex> guard(session_mutex_);
  11339. return tls::pending(session_) > 0;
  11340. }
  11341. inline bool WebSocketSSLStream::wait_readable() const {
  11342. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11343. }
  11344. inline bool WebSocketSSLStream::wait_writable() const {
  11345. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11346. // that probe toggles the socket's blocking flag, which would race with the
  11347. // concurrent reader on a permanently non-blocking socket.
  11348. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11349. }
  11350. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11351. tls::TlsError err;
  11352. auto n = 1000;
  11353. while (--n >= 0) {
  11354. {
  11355. std::lock_guard<std::mutex> guard(session_mutex_);
  11356. auto ret = tls::read(session_, ptr, size, err);
  11357. if (ret > 0) { return ret; }
  11358. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11359. error_ = Error::ConnectionClosed;
  11360. return ret;
  11361. }
  11362. }
  11363. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11364. // direction: the send path shares this session, so output it left pending
  11365. // has to be flushed before more input can be decrypted. Anything else is
  11366. // a hard error.
  11367. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11368. #ifdef _WIN32
  11369. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11370. needs_readable =
  11371. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11372. WSAGetLastError() == WSAETIMEDOUT);
  11373. #endif
  11374. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11375. error_ = Error::Read;
  11376. return -1;
  11377. }
  11378. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11379. error_ = Error::Timeout;
  11380. return -1;
  11381. }
  11382. }
  11383. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11384. // to tell a timeout from a close would otherwise see whatever the previous
  11385. // failure left behind (error_ is never cleared on success).
  11386. error_ = Error::Read;
  11387. return -1;
  11388. }
  11389. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11390. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11391. tls::TlsError err;
  11392. auto n = 1000;
  11393. while (--n >= 0) {
  11394. {
  11395. std::lock_guard<std::mutex> guard(session_mutex_);
  11396. auto ret = tls::write(session_, ptr, handle_size, err);
  11397. if (ret >= 0) { return ret; }
  11398. }
  11399. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11400. // or a post-handshake message must be consumed before the record goes
  11401. // out. Anything else is a hard error.
  11402. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11403. #ifdef _WIN32
  11404. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11405. needs_writable =
  11406. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11407. WSAGetLastError() == WSAETIMEDOUT);
  11408. #endif
  11409. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11410. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11411. }
  11412. return -1;
  11413. }
  11414. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11415. int &port) const {
  11416. detail::get_remote_ip_and_port(sock_, ip, port);
  11417. }
  11418. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11419. int &port) const {
  11420. detail::get_local_ip_and_port(sock_, ip, port);
  11421. }
  11422. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11423. inline time_t WebSocketSSLStream::duration() const {
  11424. return static_cast<time_t>(
  11425. std::chrono::duration_cast<std::chrono::milliseconds>(
  11426. std::chrono::steady_clock::now() - start_time_)
  11427. .count());
  11428. }
  11429. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11430. read_timeout_sec_ = sec;
  11431. read_timeout_usec_ = usec;
  11432. }
  11433. } // namespace detail
  11434. #endif // CPPHTTPLIB_SSL_ENABLED
  11435. /*
  11436. * Group 4: Server implementation
  11437. */
  11438. // HTTP server implementation
  11439. inline Server::Server()
  11440. : new_task_queue([] {
  11441. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11442. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11443. }) {
  11444. #ifndef _WIN32
  11445. signal(SIGPIPE, SIG_IGN);
  11446. #endif
  11447. }
  11448. inline Server::~Server() = default;
  11449. inline std::unique_ptr<detail::MatcherBase>
  11450. Server::make_matcher(const std::string &pattern) {
  11451. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11452. // a path params pattern
  11453. if (pattern.find("/:") != std::string::npos) {
  11454. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11455. }
  11456. // A pattern with no regex metacharacter only has to be compared literally,
  11457. // which is what PathParamsMatcher already does when it captures no
  11458. // parameter, so std::regex is only worth building for the patterns that
  11459. // actually need it
  11460. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11461. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11462. }
  11463. return detail::make_unique<detail::RegexMatcher>(pattern);
  11464. }
  11465. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11466. return add_handler(get_handlers_, pattern, std::move(handler));
  11467. }
  11468. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11469. return add_handler(post_handlers_, pattern, std::move(handler));
  11470. }
  11471. inline Server &Server::Post(const std::string &pattern,
  11472. HandlerWithContentReader handler) {
  11473. return add_handler(post_handlers_for_content_reader_, pattern,
  11474. std::move(handler));
  11475. }
  11476. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11477. return add_handler(put_handlers_, pattern, std::move(handler));
  11478. }
  11479. inline Server &Server::Put(const std::string &pattern,
  11480. HandlerWithContentReader handler) {
  11481. return add_handler(put_handlers_for_content_reader_, pattern,
  11482. std::move(handler));
  11483. }
  11484. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11485. return add_handler(patch_handlers_, pattern, std::move(handler));
  11486. }
  11487. inline Server &Server::Patch(const std::string &pattern,
  11488. HandlerWithContentReader handler) {
  11489. return add_handler(patch_handlers_for_content_reader_, pattern,
  11490. std::move(handler));
  11491. }
  11492. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11493. return add_handler(delete_handlers_, pattern, std::move(handler));
  11494. }
  11495. inline Server &Server::Delete(const std::string &pattern,
  11496. HandlerWithContentReader handler) {
  11497. return add_handler(delete_handlers_for_content_reader_, pattern,
  11498. std::move(handler));
  11499. }
  11500. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11501. return add_handler(options_handlers_, pattern, std::move(handler));
  11502. }
  11503. inline const std::set<std::string> &Server::builtin_methods() {
  11504. thread_local const std::set<std::string> methods{
  11505. "GET", "HEAD", "POST", "PUT", "DELETE",
  11506. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11507. return methods;
  11508. }
  11509. inline Server::CustomHandlerEntry *
  11510. Server::custom_entry_for_registration(const std::string &method) {
  11511. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11512. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11513. // routing() before the custom tables are consulted, so a route registered
  11514. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11515. // there and would be reachable, but they carry protocol-level meaning
  11516. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11517. // library does not route.
  11518. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11519. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11520. has_invalid_registration_ = true;
  11521. return nullptr;
  11522. }
  11523. return &custom_handlers_[method];
  11524. }
  11525. inline Server &Server::CustomRoute(const std::string &method,
  11526. const std::string &pattern,
  11527. Handler handler) {
  11528. auto *entry = custom_entry_for_registration(method);
  11529. if (!entry) { return *this; }
  11530. return add_handler(entry->handlers, pattern, std::move(handler));
  11531. }
  11532. inline Server &Server::CustomRoute(const std::string &method,
  11533. const std::string &pattern,
  11534. HandlerWithContentReader handler) {
  11535. auto *entry = custom_entry_for_registration(method);
  11536. if (!entry) { return *this; }
  11537. return add_handler(entry->handlers_for_content_reader, pattern,
  11538. std::move(handler));
  11539. }
  11540. inline const Server::CustomHandlerEntry *
  11541. Server::find_custom_entry(const std::string &method) const {
  11542. // find() alone would be correct here. The empty() check is what keeps the
  11543. // per-request cost off servers that never call CustomRoute(), which is the
  11544. // overwhelmingly common case; keep it rather than walking into the tree.
  11545. if (custom_handlers_.empty()) { return nullptr; }
  11546. auto it = custom_handlers_.find(method);
  11547. return it == custom_handlers_.end() ? nullptr : &it->second;
  11548. }
  11549. inline Server &Server::WebSocket(const std::string &pattern,
  11550. WebSocketHandler handler) {
  11551. websocket_handlers_.push_back(
  11552. {make_matcher(pattern), std::move(handler), nullptr});
  11553. return *this;
  11554. }
  11555. inline Server &Server::WebSocket(const std::string &pattern,
  11556. WebSocketHandler handler,
  11557. SubProtocolSelector sub_protocol_selector) {
  11558. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11559. std::move(sub_protocol_selector)});
  11560. return *this;
  11561. }
  11562. inline bool Server::set_base_dir(const std::string &dir,
  11563. const std::string &mount_point) {
  11564. return set_mount_point(mount_point, dir);
  11565. }
  11566. inline bool Server::set_mount_point(const std::string &mount_point,
  11567. const std::string &dir, Headers headers) {
  11568. detail::FileStat stat(dir);
  11569. if (stat.is_dir()) {
  11570. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11571. if (!mnt.empty() && mnt[0] == '/') {
  11572. // Without the resolved directory, a file could not be checked to be
  11573. // inside it.
  11574. std::string resolved_base;
  11575. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11576. return false;
  11577. }
  11578. #if defined(_WIN32)
  11579. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11580. resolved_base += '\\';
  11581. }
  11582. #else
  11583. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11584. #endif
  11585. base_dirs_.push_back(
  11586. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11587. return true;
  11588. }
  11589. }
  11590. return false;
  11591. }
  11592. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11593. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11594. if (it->mount_point == mount_point) {
  11595. base_dirs_.erase(it);
  11596. return true;
  11597. }
  11598. }
  11599. return false;
  11600. }
  11601. inline Server &
  11602. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11603. const std::string &mime) {
  11604. file_extension_and_mimetype_map_[ext] = mime;
  11605. return *this;
  11606. }
  11607. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11608. default_file_mimetype_ = mime;
  11609. return *this;
  11610. }
  11611. inline Server &Server::set_file_request_handler(Handler handler) {
  11612. file_request_handler_ = std::move(handler);
  11613. return *this;
  11614. }
  11615. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11616. std::true_type) {
  11617. error_handler_ = std::move(handler);
  11618. return *this;
  11619. }
  11620. inline Server &Server::set_error_handler_core(Handler handler,
  11621. std::false_type) {
  11622. error_handler_ = [handler](const Request &req, Response &res) {
  11623. handler(req, res);
  11624. return HandlerResponse::Handled;
  11625. };
  11626. return *this;
  11627. }
  11628. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11629. exception_handler_ = std::move(handler);
  11630. return *this;
  11631. }
  11632. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11633. pre_routing_handler_ = std::move(handler);
  11634. return *this;
  11635. }
  11636. inline Server &Server::set_post_routing_handler(Handler handler) {
  11637. post_routing_handler_ = std::move(handler);
  11638. return *this;
  11639. }
  11640. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11641. pre_request_handler_ = std::move(handler);
  11642. return *this;
  11643. }
  11644. inline Server &Server::set_logger(Logger logger) {
  11645. logger_ = std::move(logger);
  11646. return *this;
  11647. }
  11648. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11649. error_logger_ = std::move(error_logger);
  11650. return *this;
  11651. }
  11652. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11653. pre_compression_logger_ = std::move(logger);
  11654. return *this;
  11655. }
  11656. inline Server &
  11657. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11658. expect_100_continue_handler_ = std::move(handler);
  11659. return *this;
  11660. }
  11661. inline Server &Server::set_start_handler(StartHandler handler) {
  11662. start_handler_ = std::move(handler);
  11663. return *this;
  11664. }
  11665. inline Server &Server::set_address_family(int family) {
  11666. address_family_ = family;
  11667. return *this;
  11668. }
  11669. inline Server &Server::set_tcp_nodelay(bool on) {
  11670. tcp_nodelay_ = on;
  11671. return *this;
  11672. }
  11673. inline Server &Server::set_ipv6_v6only(bool on) {
  11674. ipv6_v6only_ = on;
  11675. return *this;
  11676. }
  11677. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11678. socket_options_ = std::move(socket_options);
  11679. return *this;
  11680. }
  11681. inline Server &Server::set_default_headers(Headers headers) {
  11682. default_headers_ = std::move(headers);
  11683. return *this;
  11684. }
  11685. inline Server &Server::set_header_writer(
  11686. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11687. header_writer_ = writer;
  11688. return *this;
  11689. }
  11690. inline Server &
  11691. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11692. trusted_proxies_ = proxies;
  11693. return *this;
  11694. }
  11695. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11696. keep_alive_max_count_ = count;
  11697. return *this;
  11698. }
  11699. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11700. keep_alive_timeout_sec_ = sec;
  11701. return *this;
  11702. }
  11703. template <class Rep, class Period>
  11704. inline Server &Server::set_keep_alive_timeout(
  11705. const std::chrono::duration<Rep, Period> &duration) {
  11706. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11707. set_keep_alive_timeout(sec);
  11708. });
  11709. return *this;
  11710. }
  11711. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11712. read_timeout_sec_ = sec;
  11713. read_timeout_usec_ = usec;
  11714. return *this;
  11715. }
  11716. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11717. write_timeout_sec_ = sec;
  11718. write_timeout_usec_ = usec;
  11719. return *this;
  11720. }
  11721. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11722. idle_interval_sec_ = sec;
  11723. idle_interval_usec_ = usec;
  11724. return *this;
  11725. }
  11726. inline Server &Server::set_payload_max_length(size_t length) {
  11727. payload_max_length_ = length;
  11728. return *this;
  11729. }
  11730. inline Server &Server::set_static_file_compression(bool on) {
  11731. static_file_compression_ = on;
  11732. return *this;
  11733. }
  11734. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11735. static_file_compression_min_length_ = length;
  11736. return *this;
  11737. }
  11738. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11739. static_file_compression_max_length_ = length;
  11740. return *this;
  11741. }
  11742. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11743. websocket_max_missed_pongs_ = count;
  11744. return *this;
  11745. }
  11746. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11747. websocket_ping_interval_sec_ = sec;
  11748. return *this;
  11749. }
  11750. template <class Rep, class Period>
  11751. inline Server &Server::set_websocket_ping_interval(
  11752. const std::chrono::duration<Rep, Period> &duration) {
  11753. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11754. set_websocket_ping_interval(sec);
  11755. });
  11756. return *this;
  11757. }
  11758. inline bool Server::bind_to_port(const std::string &host, int port,
  11759. int socket_flags) {
  11760. auto ret = bind_internal(host, port, socket_flags);
  11761. if (ret == -1) { is_decommissioned = true; }
  11762. return ret >= 0;
  11763. }
  11764. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11765. auto ret = bind_internal(host, 0, socket_flags);
  11766. if (ret == -1) { is_decommissioned = true; }
  11767. return ret;
  11768. }
  11769. inline bool Server::listen_after_bind() { return listen_internal(); }
  11770. inline bool Server::listen(const std::string &host, int port,
  11771. int socket_flags) {
  11772. return bind_to_port(host, port, socket_flags) && listen_internal();
  11773. }
  11774. inline bool Server::is_running() const { return is_running_; }
  11775. inline void Server::wait_until_ready() const {
  11776. while (!is_running_ && !is_decommissioned) {
  11777. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11778. }
  11779. }
  11780. inline void Server::stop() noexcept {
  11781. // Release the listening socket whether or not the accept loop is running:
  11782. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11783. // exchange is what makes this safe to call concurrently with the accept loop.
  11784. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11785. if (sock != INVALID_SOCKET) {
  11786. detail::shutdown_socket(sock);
  11787. detail::close_socket(sock);
  11788. }
  11789. is_decommissioned = false;
  11790. }
  11791. inline void Server::decommission() { is_decommissioned = true; }
  11792. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11793. auto len = strlen(s);
  11794. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11795. len -= 2;
  11796. {
  11797. // RFC 9112 §3: exactly one SP between the method, the target and the
  11798. // version. Taking other whitespace as a separator too lets recipients
  11799. // that parse more strictly see a different request.
  11800. auto end = s + len;
  11801. if (std::count(s, end, ' ') != 2) { return false; }
  11802. auto sp1 = std::find(s, end, ' ');
  11803. auto sp2 = std::find(sp1 + 1, end, ' ');
  11804. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11805. req.method.assign(s, sp1);
  11806. req.target.assign(sp1 + 1, sp2);
  11807. req.version.assign(sp2 + 1, end);
  11808. }
  11809. // A method outside the built-in set is accepted only when a handler has been
  11810. // registered for it with CustomRoute().
  11811. const auto &methods = builtin_methods();
  11812. if (methods.find(req.method) == methods.end() &&
  11813. !find_custom_entry(req.method)) {
  11814. output_error_log(Error::InvalidHTTPMethod, &req);
  11815. return false;
  11816. }
  11817. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11818. output_error_log(Error::InvalidHTTPVersion, &req);
  11819. return false;
  11820. }
  11821. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11822. // would leave this server routing a different path than a cache or a
  11823. // filter in front of it sees.
  11824. if (!detail::fields::is_request_target(req.target) ||
  11825. req.target.find('#') != std::string::npos) {
  11826. return false;
  11827. }
  11828. {
  11829. detail::divide(req.target, '?',
  11830. [&](const char *lhs_data, std::size_t lhs_size,
  11831. const char *rhs_data, std::size_t rhs_size) {
  11832. req.path =
  11833. decode_path_component(std::string(lhs_data, lhs_size));
  11834. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11835. });
  11836. }
  11837. return true;
  11838. }
  11839. inline bool Server::write_response(Stream &strm, bool close_connection,
  11840. Request &req, Response &res) {
  11841. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11842. // incorrectly to the error content.
  11843. req.ranges.clear();
  11844. return write_response_core(strm, close_connection, req, res, false);
  11845. }
  11846. inline bool Server::write_response_with_content(Stream &strm,
  11847. bool close_connection,
  11848. const Request &req,
  11849. Response &res) {
  11850. return write_response_core(strm, close_connection, req, res, true);
  11851. }
  11852. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11853. const Request &req, Response &res,
  11854. bool need_apply_ranges) {
  11855. assert(res.status != -1);
  11856. if (400 <= res.status && error_handler_ &&
  11857. error_handler_(req, res) == HandlerResponse::Handled) {
  11858. need_apply_ranges = true;
  11859. }
  11860. if (!detail::body_allowed_for_status(res.status)) {
  11861. detail::clear_content(res);
  11862. }
  11863. detail::prefer_assigned_body(res);
  11864. std::string content_type;
  11865. std::string boundary;
  11866. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11867. // Prepare additional headers
  11868. if (close_connection ||
  11869. detail::has_header_token(req.headers, "Connection", "close") ||
  11870. 400 <= res.status || // Don't leave connections open after errors
  11871. // The client withholds the body until `100 Continue`, which was never
  11872. // sent, so whether and when the body follows is unknown.
  11873. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11874. // The body was left partway, e.g. by a content receiver that returned
  11875. // false, so the rest of it cannot be told from the next request.
  11876. (req.body_read_started_ && !req.body_consumed_)) {
  11877. res.set_header("Connection", "close");
  11878. } else {
  11879. std::string s = "timeout=";
  11880. s += std::to_string(keep_alive_timeout_sec_);
  11881. if (keep_alive_max_count_ > 0) {
  11882. s += ", max=";
  11883. s += std::to_string(keep_alive_max_count_);
  11884. }
  11885. res.set_header("Keep-Alive", s);
  11886. }
  11887. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11888. !res.has_header("Content-Type")) {
  11889. res.set_header("Content-Type", "text/plain");
  11890. }
  11891. detail::set_framing_headers(req, res, boundary, content_type);
  11892. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11893. res.set_header("Accept-Ranges", "bytes");
  11894. }
  11895. if (post_routing_handler_) {
  11896. post_routing_handler_(req, res);
  11897. // Again, for a body or framing headers the handler changed.
  11898. detail::set_framing_headers(req, res, boundary, content_type);
  11899. }
  11900. // Response line and headers
  11901. detail::BufferStream bstrm;
  11902. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11903. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11904. // Combine a small body with the headers so the whole response leaves in a
  11905. // single write. A large body is written on its own instead: a copy of it
  11906. // costs more than the extra write saves.
  11907. auto send_body =
  11908. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11909. auto body_is_separate = false;
  11910. auto provider_done = false;
  11911. if (send_body && !res.body.empty() && !res.content_provider_) {
  11912. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11913. bstrm.write(res.body.data(), res.body.size());
  11914. } else {
  11915. body_is_separate = true;
  11916. }
  11917. } else if (send_body && res.content_provider_ &&
  11918. res.is_file_content_provider_ &&
  11919. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11920. // A small file is read into the same buffer. Other providers may produce
  11921. // their data over time, so they are never held back.
  11922. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11923. return false;
  11924. }
  11925. provider_done = true;
  11926. }
  11927. // Log before writing to avoid race condition with client-side code that
  11928. // accesses logger-captured data immediately after receiving the response.
  11929. output_log(req, res);
  11930. // Flush buffer
  11931. auto &data = bstrm.get_buffer();
  11932. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11933. if (body_is_separate) {
  11934. return detail::write_data(strm, res.body.data(), res.body.size());
  11935. }
  11936. // Streaming body
  11937. if (send_body && res.content_provider_) {
  11938. if (!provider_done &&
  11939. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11940. return false;
  11941. }
  11942. res.content_provider_success_ = true;
  11943. }
  11944. return true;
  11945. }
  11946. inline bool
  11947. Server::write_content_with_provider(Stream &strm, const Request &req,
  11948. Response &res, const std::string &boundary,
  11949. const std::string &content_type) {
  11950. auto is_shutting_down = [this]() {
  11951. return this->svr_sock_ == INVALID_SOCKET;
  11952. };
  11953. if (res.content_length_ > 0) {
  11954. if (!detail::is_partial_content(req, res)) {
  11955. return detail::write_content(strm, res.content_provider_, 0,
  11956. res.content_length_, is_shutting_down);
  11957. } else if (req.ranges.size() == 1) {
  11958. auto offset_and_length = detail::get_range_offset_and_length(
  11959. req.ranges[0], res.content_length_);
  11960. return detail::write_content(strm, res.content_provider_,
  11961. offset_and_length.first,
  11962. offset_and_length.second, is_shutting_down);
  11963. } else {
  11964. return detail::write_multipart_ranges_data(
  11965. strm, req, res, boundary, content_type, res.content_length_,
  11966. is_shutting_down);
  11967. }
  11968. } else {
  11969. if (res.is_chunked_content_provider_) {
  11970. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11971. // re-negotiating here would disagree with them, e.g. once a handler's
  11972. // own Content-Encoding header suppresses the negotiation.
  11973. auto compressor = detail::make_compressor(res.content_coding_);
  11974. if (!compressor) {
  11975. compressor = detail::make_unique<detail::nocompressor>();
  11976. }
  11977. return detail::write_content_chunked(strm, res.content_provider_,
  11978. is_shutting_down, *compressor);
  11979. } else {
  11980. return detail::write_content_without_length(strm, res.content_provider_,
  11981. is_shutting_down);
  11982. }
  11983. }
  11984. }
  11985. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11986. FormFields::iterator cur_field;
  11987. FormFiles::iterator cur_file;
  11988. auto is_text_field = false;
  11989. size_t count = 0;
  11990. if (read_content_core(
  11991. strm, req, res,
  11992. // Regular
  11993. [&](const char *buf, size_t n) {
  11994. // Prevent arithmetic overflow when checking sizes.
  11995. // Avoid computing (req.body.size() + n) directly because
  11996. // adding two unsigned `size_t` values can wrap around and
  11997. // produce a small result instead of indicating overflow.
  11998. // Instead, check using subtraction: ensure `n` does not
  11999. // exceed the remaining capacity `max_size() - size()`.
  12000. if (req.body.size() >= req.body.max_size() ||
  12001. n > req.body.max_size() - req.body.size()) {
  12002. return false;
  12003. }
  12004. // Limit decompressed body size to payload_max_length_ to protect
  12005. // against "zip bomb" attacks where a small compressed payload
  12006. // decompresses to a massive size.
  12007. if (payload_max_length_ > 0 &&
  12008. (req.body.size() >= payload_max_length_ ||
  12009. n > payload_max_length_ - req.body.size())) {
  12010. return false;
  12011. }
  12012. req.body.append(buf, n);
  12013. return true;
  12014. },
  12015. // Multipart FormData
  12016. [&](const FormData &file) {
  12017. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12018. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12019. output_error_log(Error::TooManyFormDataFiles, &req);
  12020. return false;
  12021. }
  12022. if (file.filename.empty()) {
  12023. cur_field = req.form.fields.emplace(
  12024. file.name, FormField{file.name, file.content, file.headers});
  12025. is_text_field = true;
  12026. } else {
  12027. cur_file = req.form.files.emplace(file.name, file);
  12028. is_text_field = false;
  12029. }
  12030. return true;
  12031. },
  12032. [&](const char *buf, size_t n) {
  12033. if (is_text_field) {
  12034. auto &content = cur_field->second.content;
  12035. if (content.size() + n > content.max_size()) { return false; }
  12036. content.append(buf, n);
  12037. } else {
  12038. auto &content = cur_file->second.content;
  12039. if (content.size() + n > content.max_size()) { return false; }
  12040. content.append(buf, n);
  12041. }
  12042. return true;
  12043. })) {
  12044. const auto &content_type = req.get_header_value("Content-Type");
  12045. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12046. "application/x-www-form-urlencoded")) {
  12047. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12048. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12049. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12050. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12051. return false;
  12052. }
  12053. detail::parse_query_text(req.body, req.params);
  12054. }
  12055. return true;
  12056. }
  12057. return false;
  12058. }
  12059. inline bool Server::read_content_with_content_receiver(
  12060. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12061. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12062. return read_content_core(strm, req, res, std::move(receiver),
  12063. std::move(multipart_header),
  12064. std::move(multipart_receiver));
  12065. }
  12066. inline bool Server::read_content_core(
  12067. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12068. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12069. detail::FormDataParser multipart_form_data_parser;
  12070. ContentReceiverWithProgress out;
  12071. if (req.is_multipart_form_data()) {
  12072. const auto &content_type = req.get_header_value("Content-Type");
  12073. std::string boundary;
  12074. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12075. res.status = StatusCode::BadRequest_400;
  12076. output_error_log(Error::MultipartParsing, &req);
  12077. return false;
  12078. }
  12079. multipart_form_data_parser.set_boundary(std::move(boundary));
  12080. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12081. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12082. multipart_receiver);
  12083. };
  12084. } else {
  12085. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12086. size_t /*len*/) { return receiver(buf, n); };
  12087. }
  12088. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12089. // For non-SSL builds we still scan non-persistent connections for stray
  12090. // body bytes so the payload limit is enforced (413). On keep-alive,
  12091. // pending bytes may be the next request (issue #2450), so skip.
  12092. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  12093. if (!req.has_header("Content-Length") &&
  12094. !detail::is_chunked_transfer_encoding(req.headers)) {
  12095. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  12096. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  12097. auto has_data = strm.is_readable();
  12098. if (!has_data) {
  12099. auto s = strm.socket();
  12100. if (s != INVALID_SOCKET) {
  12101. has_data = detail::select_read(s, 0, 0) > 0;
  12102. }
  12103. }
  12104. if (has_data) {
  12105. // Route through the same decompressing reader used by the
  12106. // length-framed and chunked paths below, so payload_max_length_ is
  12107. // enforced on the decompressed size here too instead of only on the
  12108. // compressed wire bytes.
  12109. return detail::read_content(strm, req, payload_max_length_, res.status,
  12110. nullptr, out, true);
  12111. }
  12112. }
  12113. return true;
  12114. }
  12115. #else
  12116. if (!req.has_header("Content-Length") &&
  12117. !detail::is_chunked_transfer_encoding(req.headers)) {
  12118. return true;
  12119. }
  12120. #endif
  12121. // A second read would start where the first one stopped, or in the next
  12122. // request.
  12123. if (req.body_read_started_) { return false; }
  12124. // The client is waiting for this before it sends the body.
  12125. if (req.expect_100_continue_pending_) {
  12126. req.expect_100_continue_pending_ = false;
  12127. detail::write_response_line(strm, StatusCode::Continue_100);
  12128. strm.write("\r\n");
  12129. }
  12130. // Set before reading, since a receiver may also stop by throwing.
  12131. req.body_read_started_ = true;
  12132. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12133. out, true)) {
  12134. return false;
  12135. }
  12136. req.body_consumed_ = true;
  12137. if (req.is_multipart_form_data()) {
  12138. if (!multipart_form_data_parser.is_valid()) {
  12139. res.status = StatusCode::BadRequest_400;
  12140. output_error_log(Error::MultipartParsing, &req);
  12141. return false;
  12142. }
  12143. }
  12144. return true;
  12145. }
  12146. inline bool Server::handle_file_request(Request &req, Response &res) {
  12147. for (const auto &entry : base_dirs_) {
  12148. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12149. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12150. // One that already ends in '/' (the root mount among them) carries its own
  12151. // boundary; set_mount_point() guarantees the mount point is not empty.
  12152. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12153. (entry.mount_point.back() == '/' ||
  12154. req.path.size() == entry.mount_point.size() ||
  12155. req.path[entry.mount_point.size()] == '/')) {
  12156. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12157. if (detail::is_valid_path(sub_path)) {
  12158. auto path = entry.base_dir + sub_path;
  12159. if (path.back() == '/') { path += "index.html"; }
  12160. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12161. // but symlinks/junctions can still escape the base directory. A path
  12162. // that cannot be resolved, which includes one that does not exist, is
  12163. // not served from here.
  12164. std::string resolved_path;
  12165. if (!detail::canonicalize_path(path.c_str(), resolved_path)) {
  12166. continue;
  12167. }
  12168. if (!detail::is_path_within_base(resolved_path,
  12169. entry.resolved_base_dir)) {
  12170. res.status = StatusCode::Forbidden_403;
  12171. return true;
  12172. }
  12173. detail::FileStat stat(path);
  12174. if (stat.is_dir()) {
  12175. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12176. // in the name from reading as a scheme.
  12177. auto name = req.path.substr(req.path.rfind('/') + 1);
  12178. res.set_redirect("./" + encode_path_component(name) + "/",
  12179. StatusCode::MovedPermanently_301);
  12180. return true;
  12181. }
  12182. if (stat.is_file()) {
  12183. for (const auto &kv : entry.headers) {
  12184. res.set_header(kv.first, kv.second);
  12185. }
  12186. auto content_type = detail::find_content_type(
  12187. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12188. auto encoding = detail::EncodingType::None;
  12189. if (static_file_compression_) {
  12190. encoding =
  12191. static_file_encoding(req, res, content_type, stat.size());
  12192. }
  12193. // The ETag names the representation actually sent, so a client that
  12194. // cached the compressed form revalidates against the compressed ETag
  12195. // and still gets a 304, while one that took identity keeps the plain
  12196. // ETag.
  12197. auto etag = detail::compute_etag(
  12198. stat, encoding == detail::EncodingType::None
  12199. ? std::string()
  12200. : std::string("-") + detail::encoding_name(encoding));
  12201. if (!etag.empty()) { res.set_header("ETag", etag); }
  12202. auto mtime = stat.mtime();
  12203. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12204. if (!last_modified.empty()) {
  12205. res.set_header("Last-Modified", last_modified);
  12206. }
  12207. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12208. check_if_range(req, etag, mtime);
  12209. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12210. if (!mm->is_open()) {
  12211. output_error_log(Error::OpenFile, &req);
  12212. return false;
  12213. }
  12214. detail::set_file_content_provider(res, mm, content_type, encoding);
  12215. if (req.method != "HEAD" && file_request_handler_) {
  12216. file_request_handler_(req, res);
  12217. }
  12218. return true;
  12219. } else {
  12220. output_error_log(Error::OpenFile, &req);
  12221. }
  12222. }
  12223. }
  12224. }
  12225. return false;
  12226. }
  12227. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12228. const std::string &etag,
  12229. time_t mtime) const {
  12230. // Handle conditional GET:
  12231. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12232. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12233. if (req.has_header("If-None-Match")) {
  12234. if (!etag.empty()) {
  12235. auto val =
  12236. detail::get_combined_header_value(req.headers, "If-None-Match");
  12237. // NOTE: We use exact string matching here. This works correctly
  12238. // because our server always generates weak ETags (W/"..."), and
  12239. // clients typically send back the same ETag they received.
  12240. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12241. // If-None-Match, where W/"x" and "x" would match, but this
  12242. // simplified implementation requires exact matches.
  12243. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12244. [&](const char *b, const char *e) {
  12245. auto seg_len = static_cast<size_t>(e - b);
  12246. return (seg_len == 1 && *b == '*') ||
  12247. (seg_len == etag.size() &&
  12248. std::equal(b, e, etag.begin()));
  12249. });
  12250. if (ret) {
  12251. res.status = StatusCode::NotModified_304;
  12252. return true;
  12253. }
  12254. }
  12255. } else if (req.has_header("If-Modified-Since")) {
  12256. auto val = req.get_header_value("If-Modified-Since");
  12257. auto t = detail::parse_http_date(val);
  12258. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12259. res.status = StatusCode::NotModified_304;
  12260. return true;
  12261. }
  12262. }
  12263. return false;
  12264. }
  12265. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12266. time_t mtime) const {
  12267. // Handle If-Range for partial content requests (RFC 9110
  12268. // Section 13.1.5). If-Range is only evaluated when Range header is
  12269. // present. If the validator matches, serve partial content; otherwise
  12270. // serve full content.
  12271. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12272. auto val = req.get_header_value("If-Range");
  12273. auto is_valid_range = [&]() {
  12274. if (detail::is_strong_etag(val)) {
  12275. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12276. // comparison.
  12277. return (!etag.empty() && val == etag);
  12278. } else if (detail::is_weak_etag(val)) {
  12279. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12280. return false;
  12281. } else {
  12282. // HTTP-date comparison
  12283. auto t = detail::parse_http_date(val);
  12284. return (t != static_cast<time_t>(-1) && mtime <= t);
  12285. }
  12286. };
  12287. if (!is_valid_range()) {
  12288. // Validator doesn't match: ignore Range and serve full content
  12289. req.ranges.clear();
  12290. return false;
  12291. }
  12292. }
  12293. return true;
  12294. }
  12295. inline socket_t
  12296. Server::create_server_socket(const std::string &host, int port,
  12297. int socket_flags,
  12298. SocketOptions socket_options) const {
  12299. return detail::create_socket(
  12300. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12301. ipv6_v6only_, std::move(socket_options),
  12302. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12303. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12304. output_error_log(Error::BindIPAddress, nullptr);
  12305. return false;
  12306. }
  12307. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12308. output_error_log(Error::Listen, nullptr);
  12309. return false;
  12310. }
  12311. return true;
  12312. });
  12313. }
  12314. inline int Server::bind_internal(const std::string &host, int port,
  12315. int socket_flags) {
  12316. if (is_decommissioned) { return -1; }
  12317. if (!is_valid()) { return -1; }
  12318. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12319. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12320. if (port == 0) {
  12321. struct sockaddr_storage addr;
  12322. socklen_t addr_len = sizeof(addr);
  12323. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12324. &addr_len) == -1) {
  12325. output_error_log(Error::GetSockName, nullptr);
  12326. return -1;
  12327. }
  12328. if (addr.ss_family == AF_INET) {
  12329. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12330. } else if (addr.ss_family == AF_INET6) {
  12331. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12332. } else {
  12333. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12334. return -1;
  12335. }
  12336. } else {
  12337. return port;
  12338. }
  12339. }
  12340. inline bool Server::listen_internal() {
  12341. // A stop() between bind and listen leaves nothing to accept on. Report
  12342. // failure instead of returning success without ever serving, and mark the
  12343. // server decommissioned the way any failed listen does so that a concurrent
  12344. // wait_until_ready() wakes up instead of spinning forever.
  12345. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12346. is_decommissioned = true;
  12347. return false;
  12348. }
  12349. auto ret = true;
  12350. is_running_ = true;
  12351. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12352. if (start_handler_) { start_handler_(); }
  12353. {
  12354. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12355. while (svr_sock_ != INVALID_SOCKET) {
  12356. #ifndef _WIN32
  12357. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12358. #endif
  12359. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12360. idle_interval_usec_);
  12361. if (val == 0) { // Timeout
  12362. task_queue->on_idle();
  12363. continue;
  12364. }
  12365. #ifndef _WIN32
  12366. }
  12367. #endif
  12368. #if defined _WIN32
  12369. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12370. // OVERLAPPED
  12371. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12372. #elif defined SOCK_CLOEXEC
  12373. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12374. #else
  12375. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12376. #endif
  12377. if (sock == INVALID_SOCKET) {
  12378. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12379. // touches the CRT errno, so the two have to be asked platform by
  12380. // platform rather than by testing errno here.
  12381. if (detail::is_accept_resource_error()) {
  12382. // The per-process descriptor limit or the network stack's buffer
  12383. // space has been reached. Try to accept new connections after a
  12384. // short sleep.
  12385. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12386. continue;
  12387. } else if (detail::is_accept_transient_error()) {
  12388. continue;
  12389. }
  12390. // Take the descriptor out of svr_sock_ before closing it: a later
  12391. // stop() would otherwise shutdown()/close() a value the OS may have
  12392. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12393. // gone. The exchange also settles the race with a concurrent stop(),
  12394. // since whichever side takes the descriptor closes it exactly once.
  12395. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12396. if (listen_sock != INVALID_SOCKET) {
  12397. detail::close_socket(listen_sock);
  12398. ret = false;
  12399. output_error_log(Error::Connection, nullptr);
  12400. } else {
  12401. ; // The server socket was closed by user.
  12402. }
  12403. break;
  12404. }
  12405. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12406. read_timeout_sec_, read_timeout_usec_);
  12407. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12408. write_timeout_sec_, write_timeout_usec_);
  12409. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12410. if (!task_queue->enqueue(
  12411. [this, sock]() { process_and_close_socket(sock); })) {
  12412. output_error_log(Error::ResourceExhaustion, nullptr);
  12413. detail::shutdown_socket(sock);
  12414. detail::close_socket(sock);
  12415. }
  12416. }
  12417. task_queue->shutdown();
  12418. }
  12419. is_decommissioned = !ret;
  12420. return ret;
  12421. }
  12422. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12423. bool skip_pre_routing) {
  12424. if (!skip_pre_routing && pre_routing_handler_ &&
  12425. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12426. return true;
  12427. }
  12428. // File handler
  12429. if ((req.method == "GET" || req.method == "HEAD") &&
  12430. handle_file_request(req, res)) {
  12431. return true;
  12432. }
  12433. const auto *custom = find_custom_entry(req.method);
  12434. // The second clause mirrors what expect_content() does unconditionally for
  12435. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12436. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12437. // `allprop`) would skip its handler and fall through to 404.
  12438. if (detail::expect_content(req) ||
  12439. (custom && !custom->handlers_for_content_reader.empty())) {
  12440. // Content reader handler
  12441. {
  12442. // Track whether the ContentReader was aborted due to the decompressed
  12443. // payload exceeding `payload_max_length_`.
  12444. // The user handler runs after the lambda returns, so we must restore the
  12445. // 413 status if the handler overwrites it.
  12446. bool content_reader_payload_too_large = false;
  12447. ContentReader reader(
  12448. [&](ContentReceiver receiver) {
  12449. auto result = read_content_with_content_receiver(
  12450. strm, req, res, std::move(receiver), nullptr, nullptr);
  12451. if (!result) {
  12452. output_error_log(Error::Read, &req);
  12453. if (res.status == StatusCode::PayloadTooLarge_413) {
  12454. content_reader_payload_too_large = true;
  12455. }
  12456. }
  12457. return result;
  12458. },
  12459. [&](FormDataHeader header, ContentReceiver receiver) {
  12460. auto result = read_content_with_content_receiver(
  12461. strm, req, res, nullptr, std::move(header),
  12462. std::move(receiver));
  12463. if (!result) {
  12464. output_error_log(Error::Read, &req);
  12465. if (res.status == StatusCode::PayloadTooLarge_413) {
  12466. content_reader_payload_too_large = true;
  12467. }
  12468. }
  12469. return result;
  12470. });
  12471. bool dispatched = false;
  12472. if (req.method == "POST") {
  12473. dispatched = dispatch_request_for_content_reader(
  12474. req, res, std::move(reader), post_handlers_for_content_reader_);
  12475. } else if (req.method == "PUT") {
  12476. dispatched = dispatch_request_for_content_reader(
  12477. req, res, std::move(reader), put_handlers_for_content_reader_);
  12478. } else if (req.method == "PATCH") {
  12479. dispatched = dispatch_request_for_content_reader(
  12480. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12481. } else if (req.method == "DELETE") {
  12482. dispatched = dispatch_request_for_content_reader(
  12483. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12484. } else if (custom) {
  12485. dispatched = dispatch_request_for_content_reader(
  12486. req, res, std::move(reader), custom->handlers_for_content_reader);
  12487. }
  12488. if (dispatched) {
  12489. if (content_reader_payload_too_large) {
  12490. // Enforce the limit: override any status the handler may have set
  12491. // and return false so the error path sends a plain 413 response.
  12492. res.status = StatusCode::PayloadTooLarge_413;
  12493. detail::clear_content(res);
  12494. return false;
  12495. }
  12496. return true;
  12497. }
  12498. }
  12499. // NOTE: `req.body` is not read here. For a regular handler the body is
  12500. // read inside dispatch_request(), after the route has matched and the
  12501. // pre-request handler has approved the request, so that a rejected
  12502. // request (e.g. failed authentication) never forces us to buffer a
  12503. // potentially large body.
  12504. }
  12505. // Regular handler
  12506. if (req.method == "GET" || req.method == "HEAD") {
  12507. return dispatch_request(req, res, get_handlers_, strm);
  12508. } else if (req.method == "POST") {
  12509. return dispatch_request(req, res, post_handlers_, strm);
  12510. } else if (req.method == "PUT") {
  12511. return dispatch_request(req, res, put_handlers_, strm);
  12512. } else if (req.method == "DELETE") {
  12513. return dispatch_request(req, res, delete_handlers_, strm);
  12514. } else if (req.method == "OPTIONS") {
  12515. return dispatch_request(req, res, options_handlers_, strm);
  12516. } else if (req.method == "PATCH") {
  12517. return dispatch_request(req, res, patch_handlers_, strm);
  12518. } else if (custom) {
  12519. return dispatch_request(req, res, custom->handlers, strm);
  12520. }
  12521. res.status = StatusCode::BadRequest_400;
  12522. return false;
  12523. }
  12524. inline bool Server::dispatch_request(Request &req, Response &res,
  12525. const Handlers &handlers, Stream &strm) {
  12526. for (const auto &x : handlers) {
  12527. const auto &matcher = x.first;
  12528. const auto &handler = x.second;
  12529. if (matcher->match(req)) {
  12530. req.matched_route = matcher->pattern();
  12531. // Run the pre-request handler before reading the body so a rejected
  12532. // request (e.g. failed authentication) never forces us to buffer a
  12533. // potentially large body. `req.matched_route` is available here.
  12534. if (pre_request_handler_ &&
  12535. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12536. return true;
  12537. }
  12538. // The route matched and the request was approved; read the body now.
  12539. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12540. output_error_log(Error::Read, &req);
  12541. return false;
  12542. }
  12543. handler(req, res);
  12544. return true;
  12545. }
  12546. }
  12547. return false;
  12548. }
  12549. // Decides the content coding for a response served straight from a file. Both
  12550. // the ETag, which has to name the representation actually sent, and
  12551. // `apply_static_file_compression()` go through this, so the two cannot drift
  12552. // apart.
  12553. inline detail::EncodingType
  12554. Server::static_file_encoding(const Request &req, const Response &res,
  12555. const std::string &content_type,
  12556. size_t length) const {
  12557. if (!static_file_compression_) { return detail::EncodingType::None; }
  12558. // Nothing to compress, and an empty file already answers with
  12559. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12560. // turn an empty body into a 20-byte gzip stream.
  12561. if (length == 0) { return detail::EncodingType::None; }
  12562. // A file that already fits in a single packet gains nothing from being made
  12563. // smaller, since it still travels in that one segment, and a file of a few
  12564. // bytes comes out larger than it went in.
  12565. if (length < static_file_compression_min_length_) {
  12566. return detail::EncodingType::None;
  12567. }
  12568. // RFC 9110 applies Range to the representation after content coding, so a
  12569. // compressed 206 would mean compressing the whole file and then slicing it.
  12570. // Serve ranges from the identity representation instead.
  12571. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12572. if (static_file_compression_max_length_ > 0 &&
  12573. length > static_file_compression_max_length_) {
  12574. return detail::EncodingType::None;
  12575. }
  12576. return detail::encoding_type(req, res, content_type);
  12577. }
  12578. // Compresses a file-backed content provider into `res.body`. Returns false when
  12579. // the response is left untouched.
  12580. inline bool Server::apply_static_file_compression(const Request &req,
  12581. Response &res) const {
  12582. auto type = res.content_coding_;
  12583. if (type == detail::EncodingType::None || !res.content_provider_) {
  12584. return false;
  12585. }
  12586. auto compressor = detail::make_compressor(type);
  12587. if (!compressor) { return false; }
  12588. output_pre_compression_log(req, res);
  12589. std::string compressed;
  12590. if (!detail::compress_content_provider(res.content_provider_,
  12591. res.content_length_, *compressor,
  12592. compressed)) {
  12593. return false;
  12594. }
  12595. res.body.swap(compressed);
  12596. // The provider was consumed in full, so its releaser hears about a success.
  12597. res.content_provider_success_ = true;
  12598. detail::clear_content_provider(res);
  12599. res.set_header("Content-Encoding", detail::encoding_name(type));
  12600. res.set_header("Vary", "Accept-Encoding");
  12601. return true;
  12602. }
  12603. inline void Server::apply_ranges(const Request &req, Response &res,
  12604. std::string &content_type,
  12605. std::string &boundary) const {
  12606. // A known-length content provider leaves `res.body` empty, so the compressor
  12607. // at the end of this function never runs for one (issue #2545). A file-backed
  12608. // provider is fully readable right here, so compress it and answer with an
  12609. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12610. // takes the same path as `set_content()` from here on. Range requests never
  12611. // get a content coding, so `Content-Range` still names identity bytes and
  12612. // none of the range handling below applies.
  12613. if (apply_static_file_compression(req, res)) { return; }
  12614. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12615. auto it = res.headers.find("Content-Type");
  12616. if (it != res.headers.end()) {
  12617. content_type = it->second;
  12618. res.headers.erase(it);
  12619. }
  12620. boundary = detail::make_multipart_data_boundary();
  12621. res.set_header("Content-Type",
  12622. "multipart/byteranges; boundary=" + boundary);
  12623. }
  12624. auto type = detail::encoding_type(req, res);
  12625. if (res.body.empty()) {
  12626. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12627. res.status == StatusCode::PartialContent_206) {
  12628. auto offset_and_length = detail::get_range_offset_and_length(
  12629. req.ranges[0], res.content_length_);
  12630. auto content_range = detail::make_content_range_header_field(
  12631. offset_and_length, res.content_length_);
  12632. res.set_header("Content-Range", content_range);
  12633. } else if (res.is_chunked_content_provider_) {
  12634. res.content_coding_ = type;
  12635. if (type != detail::EncodingType::None) {
  12636. res.set_header("Content-Encoding", detail::encoding_name(type));
  12637. res.set_header("Vary", "Accept-Encoding");
  12638. }
  12639. }
  12640. } else {
  12641. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12642. ;
  12643. } else if (req.ranges.size() == 1) {
  12644. auto offset_and_length =
  12645. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12646. auto offset = offset_and_length.first;
  12647. auto length = offset_and_length.second;
  12648. auto content_range = detail::make_content_range_header_field(
  12649. offset_and_length, res.body.size());
  12650. res.set_header("Content-Range", content_range);
  12651. assert(offset + length <= res.body.size());
  12652. res.body = res.body.substr(offset, length);
  12653. } else {
  12654. std::string data;
  12655. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12656. res.body.size(), data);
  12657. res.body.swap(data);
  12658. }
  12659. if (type != detail::EncodingType::None) {
  12660. output_pre_compression_log(req, res);
  12661. if (auto compressor = detail::make_compressor(type)) {
  12662. std::string compressed;
  12663. if (compressor->compress(res.body.data(), res.body.size(), true,
  12664. [&](const char *data, size_t data_len) {
  12665. compressed.append(data, data_len);
  12666. return true;
  12667. })) {
  12668. res.body.swap(compressed);
  12669. res.set_header("Content-Encoding", detail::encoding_name(type));
  12670. res.set_header("Vary", "Accept-Encoding");
  12671. }
  12672. }
  12673. }
  12674. res.content_length_ = res.body.size();
  12675. }
  12676. }
  12677. inline bool Server::dispatch_request_for_content_reader(
  12678. Request &req, Response &res, ContentReader content_reader,
  12679. const HandlersForContentReader &handlers) const {
  12680. for (const auto &x : handlers) {
  12681. const auto &matcher = x.first;
  12682. const auto &handler = x.second;
  12683. if (matcher->match(req)) {
  12684. req.matched_route = matcher->pattern();
  12685. if (!pre_request_handler_ ||
  12686. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12687. handler(req, res, content_reader);
  12688. }
  12689. return true;
  12690. }
  12691. }
  12692. return false;
  12693. }
  12694. inline std::string
  12695. get_client_ip(const std::string &x_forwarded_for,
  12696. const std::vector<std::string> &trusted_proxies) {
  12697. // X-Forwarded-For is a comma-separated list per RFC 7239
  12698. std::vector<std::string> ip_list;
  12699. detail::split(x_forwarded_for.data(),
  12700. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12701. [&](const char *b, const char *e) {
  12702. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12703. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12704. });
  12705. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12706. // no segments. Signal "no client IP derived" with an empty string so the
  12707. // caller can fall back to the connection-level remote address.
  12708. if (ip_list.empty()) { return std::string(); }
  12709. // Each hop appends the address it received the request from, so the rightmost
  12710. // entries are the ones written by our own infrastructure while the leftmost
  12711. // are whatever the original client chose to send. Walk from the right and
  12712. // skip trusted proxies; the first address that is not a trusted proxy is the
  12713. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12714. // from the left instead lets a client forge an arbitrary address by following
  12715. // it with a trusted proxy's address, which the left-to-right scan then
  12716. // returned as the client.
  12717. for (size_t i = ip_list.size(); i-- > 0;) {
  12718. const auto &ip = ip_list[i];
  12719. auto is_trusted_proxy =
  12720. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12721. [&](const std::string &proxy) { return ip == proxy; });
  12722. if (!is_trusted_proxy) { return ip; }
  12723. }
  12724. // Every hop was a trusted proxy; fall back to the first entry.
  12725. return ip_list.front();
  12726. }
  12727. inline bool
  12728. Server::process_request(Stream &strm, const std::string &remote_addr,
  12729. int remote_port, const std::string &local_addr,
  12730. int local_port, bool close_connection,
  12731. bool &connection_closed,
  12732. const std::function<void(Request &)> &setup_request,
  12733. bool *websocket_upgraded) {
  12734. std::array<char, 2048> buf{};
  12735. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12736. // The read timeout bounds the request line and headers as a whole, so a
  12737. // client sending them a byte at a time cannot hold the worker any longer.
  12738. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12739. // Connection has been closed on client
  12740. if (!line_reader.getline()) { return false; }
  12741. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12742. // clients send an extra CRLF after a request body, which would otherwise be
  12743. // parsed as the next request on a persistent connection.
  12744. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12745. return false;
  12746. }
  12747. Request req;
  12748. req.start_time_ = std::chrono::steady_clock::now();
  12749. req.remote_addr = remote_addr;
  12750. req.remote_port = remote_port;
  12751. req.local_addr = local_addr;
  12752. req.local_port = local_port;
  12753. Response res;
  12754. res.version = "HTTP/1.1";
  12755. res.headers = default_headers_;
  12756. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12757. // close the connection after that response, whichever path wrote it (an
  12758. // error status, a handler, or a rejected request). Reading on would also
  12759. // parse whatever the client sent next on a connection it considers done.
  12760. auto honor_connection_close = detail::scope_exit([&] {
  12761. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12762. connection_closed = true;
  12763. }
  12764. });
  12765. // Request line and headers. A rejected message leaves the rest of it (and
  12766. // any body) unread, so the connection cannot be reused: the leftover bytes
  12767. // would be parsed as the next request.
  12768. if (!parse_request_line(line_reader.ptr(), req)) {
  12769. connection_closed = true;
  12770. res.status = StatusCode::BadRequest_400;
  12771. output_error_log(Error::InvalidRequestLine, &req);
  12772. return write_response(strm, close_connection, req, res);
  12773. }
  12774. // Request headers
  12775. if (!detail::read_headers(strm, req.headers)) {
  12776. connection_closed = true;
  12777. res.status = StatusCode::BadRequest_400;
  12778. output_error_log(Error::InvalidHeaders, &req);
  12779. return write_response(strm, close_connection, req, res);
  12780. }
  12781. strm.set_max_timeout(0);
  12782. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12783. // which would otherwise let an intermediary and this parser disagree on
  12784. // where the body ends and enable request smuggling. Three cases: a
  12785. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12786. // or empty), which would otherwise be read as "no body"; a non-zero
  12787. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12788. // tolerated for compatibility with existing clients); and a
  12789. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12790. // length undeterminable. None of them may fall through to the "no body"
  12791. // path, or the body bytes are parsed as the next request on a persistent
  12792. // connection.
  12793. auto is_invalid_content_length = false;
  12794. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12795. is_invalid_content_length);
  12796. if (is_invalid_content_length ||
  12797. detail::has_conflicting_content_length(req.headers) ||
  12798. (req.has_header("Transfer-Encoding") &&
  12799. !detail::is_chunked_transfer_encoding(req.headers))) {
  12800. connection_closed = true;
  12801. res.status = StatusCode::BadRequest_400;
  12802. return write_response(strm, close_connection, req, res);
  12803. }
  12804. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12805. // HTTP/1.0 request, is honoured, but the connection closes after the
  12806. // response.
  12807. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12808. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12809. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12810. // the same authority.
  12811. auto host_count = req.get_header_value_count("Host");
  12812. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12813. !detail::fields::is_host(req.get_header_value("Host"))) {
  12814. connection_closed = true;
  12815. res.status = StatusCode::BadRequest_400;
  12816. output_error_log(Error::InvalidHeaders, &req);
  12817. return write_response(strm, close_connection, req, res);
  12818. }
  12819. // Check if the request URI doesn't exceed the limit
  12820. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12821. connection_closed = true;
  12822. res.status = StatusCode::UriTooLong_414;
  12823. output_error_log(Error::ExceedUriMaxLength, &req);
  12824. return write_response(strm, close_connection, req, res);
  12825. }
  12826. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12827. connection_closed = true;
  12828. }
  12829. if (req.version == "HTTP/1.0" &&
  12830. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12831. connection_closed = true;
  12832. }
  12833. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12834. // itself a trusted proxy. Otherwise any direct client could spoof
  12835. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12836. auto is_trusted_peer = std::any_of(
  12837. trusted_proxies_.begin(), trusted_proxies_.end(),
  12838. [&](const std::string &proxy) { return proxy == remote_addr; });
  12839. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12840. // Some proxies append the address they observed as a separate
  12841. // X-Forwarded-For field line instead of extending the one the client sent
  12842. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12843. // be scanned. Reading only the first occurrence would hand back the
  12844. // client-supplied, and therefore forgeable, value.
  12845. auto x_forwarded_for =
  12846. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12847. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12848. req.remote_addr = derived.empty() ? remote_addr : derived;
  12849. } else {
  12850. req.remote_addr = remote_addr;
  12851. }
  12852. req.remote_port = remote_port;
  12853. req.local_addr = local_addr;
  12854. req.local_port = local_port;
  12855. if (req.has_header("Accept")) {
  12856. auto accept_header =
  12857. detail::get_combined_header_value(req.headers, "Accept");
  12858. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12859. connection_closed = true;
  12860. res.status = StatusCode::BadRequest_400;
  12861. output_error_log(Error::HTTPParsing, &req);
  12862. return write_response(strm, close_connection, req, res);
  12863. }
  12864. }
  12865. if (req.has_header("Range")) {
  12866. const auto &range_header_value = req.get_header_value("Range");
  12867. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12868. connection_closed = true;
  12869. res.status = StatusCode::RangeNotSatisfiable_416;
  12870. output_error_log(Error::InvalidRangeHeader, &req);
  12871. return write_response(strm, close_connection, req, res);
  12872. }
  12873. }
  12874. if (setup_request) { setup_request(req); }
  12875. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12876. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12877. // must be ignored. An expectation we do not recognize is left alone; the
  12878. // 417 the section allows for one is a MAY, not a requirement.
  12879. //
  12880. // `100 Continue` itself is deferred until the body is actually read (see
  12881. // read_content_core), so a request rejected by a later handler never
  12882. // invites the client to send a body nobody will read.
  12883. if (req.version != "HTTP/1.0" &&
  12884. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12885. int status = StatusCode::Continue_100;
  12886. if (expect_100_continue_handler_) {
  12887. status = expect_100_continue_handler_(req, res);
  12888. }
  12889. if (status == StatusCode::Continue_100) {
  12890. req.expect_100_continue_pending_ = true;
  12891. } else {
  12892. if (res.status == -1) { res.status = status; }
  12893. connection_closed = true;
  12894. return write_response(strm, true, req, res);
  12895. }
  12896. }
  12897. // Setup `is_connection_closed` method
  12898. auto sock = strm.socket();
  12899. req.is_connection_closed = [sock]() {
  12900. return !detail::is_socket_alive(sock);
  12901. };
  12902. // WebSocket upgrade
  12903. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12904. // that authentication and other middleware can reject the request with an
  12905. // HTTP response (e.g., 401) before the protocol switches.
  12906. // The response says so when this connection closes after it.
  12907. auto close_after_response = close_connection || connection_closed;
  12908. // An upgrade request has been through pre-routing before it reaches routing()
  12909. auto is_upgrade = detail::is_websocket_upgrade(req);
  12910. if (is_upgrade) {
  12911. if (pre_routing_handler_ &&
  12912. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12913. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12914. return write_response_with_content(strm, close_after_response, req, res);
  12915. }
  12916. // Find matching WebSocket handler
  12917. for (const auto &entry : websocket_handlers_) {
  12918. if (entry.matcher->match(req)) {
  12919. req.matched_route = entry.matcher->pattern();
  12920. if (pre_request_handler_ &&
  12921. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12922. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12923. return write_response_with_content(strm, close_after_response, req,
  12924. res);
  12925. }
  12926. // Compute accept key
  12927. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12928. auto accept_key = detail::websocket_accept_key(client_key);
  12929. // Negotiate subprotocol
  12930. std::string selected_subprotocol;
  12931. if (entry.sub_protocol_selector) {
  12932. auto protocol_header = detail::get_combined_header_value(
  12933. req.headers, "Sec-WebSocket-Protocol");
  12934. if (!protocol_header.empty()) {
  12935. std::vector<std::string> protocols;
  12936. detail::split(protocol_header.data(),
  12937. protocol_header.data() + protocol_header.size(), ',',
  12938. [&](const char *b, const char *e) {
  12939. protocols.emplace_back(b, e);
  12940. });
  12941. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12942. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12943. if (std::find(protocols.begin(), protocols.end(),
  12944. selected_subprotocol) == protocols.end()) {
  12945. selected_subprotocol.clear();
  12946. }
  12947. }
  12948. }
  12949. // Send 101 Switching Protocols
  12950. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12951. "Upgrade: websocket\r\n"
  12952. "Connection: Upgrade\r\n"
  12953. "Sec-WebSocket-Accept: " +
  12954. accept_key + "\r\n";
  12955. if (!selected_subprotocol.empty()) {
  12956. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12957. return false;
  12958. }
  12959. handshake_response +=
  12960. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12961. }
  12962. handshake_response += "\r\n";
  12963. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12964. 0) {
  12965. return false;
  12966. }
  12967. connection_closed = true;
  12968. if (websocket_upgraded) { *websocket_upgraded = true; }
  12969. {
  12970. #ifdef CPPHTTPLIB_SSL_ENABLED
  12971. if (req.ssl) {
  12972. // wss: the heartbeat ping thread and the read path enter the same
  12973. // TLS session from different threads. Hand the WebSocket a stream
  12974. // that serializes every TLS call, so the shared SSLSocketStream on
  12975. // the plain HTTP/HTTPS paths stays untouched.
  12976. auto ws_strm =
  12977. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12978. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12979. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12980. write_timeout_sec_, write_timeout_usec_));
  12981. ws::WebSocket ws(std::move(ws_strm), req, true,
  12982. websocket_ping_interval_sec_,
  12983. websocket_max_missed_pongs_);
  12984. entry.handler(req, ws);
  12985. return true;
  12986. }
  12987. #endif
  12988. // Use WebSocket-specific read timeout instead of HTTP timeout
  12989. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12990. 0);
  12991. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12992. websocket_max_missed_pongs_);
  12993. entry.handler(req, ws);
  12994. }
  12995. return true;
  12996. }
  12997. }
  12998. // No WebSocket route: route it as a plain HTTP request
  12999. }
  13000. // Routing
  13001. auto routed = false;
  13002. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13003. routed = routing(req, res, strm, is_upgrade);
  13004. #else
  13005. try {
  13006. routed = routing(req, res, strm, is_upgrade);
  13007. } catch (std::exception &) {
  13008. if (exception_handler_) {
  13009. auto ep = std::current_exception();
  13010. exception_handler_(req, res, ep);
  13011. routed = true;
  13012. } else {
  13013. res.status = StatusCode::InternalServerError_500;
  13014. }
  13015. } catch (...) {
  13016. if (exception_handler_) {
  13017. auto ep = std::current_exception();
  13018. exception_handler_(req, res, ep);
  13019. routed = true;
  13020. } else {
  13021. res.status = StatusCode::InternalServerError_500;
  13022. }
  13023. }
  13024. #endif
  13025. auto ret = false;
  13026. if (routed) {
  13027. if (res.status == -1) {
  13028. res.status = req.ranges.empty() ? StatusCode::OK_200
  13029. : StatusCode::PartialContent_206;
  13030. }
  13031. // Before the Range checks below, so they see the body's own length.
  13032. detail::prefer_assigned_body(res);
  13033. // Serve file content by using a content provider
  13034. auto file_open_error = false;
  13035. if (!res.file_content_path_.empty()) {
  13036. const auto &path = res.file_content_path_;
  13037. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13038. if (!mm->is_open()) {
  13039. res.status = StatusCode::NotFound_404;
  13040. output_error_log(Error::OpenFile, &req);
  13041. file_open_error = true;
  13042. } else {
  13043. auto content_type = res.file_content_content_type_;
  13044. if (content_type.empty()) {
  13045. // One the handler set after set_file_content()
  13046. content_type = res.get_header_value("Content-Type");
  13047. }
  13048. if (content_type.empty()) {
  13049. content_type = detail::find_content_type(
  13050. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13051. }
  13052. detail::set_file_content_provider(
  13053. res, mm, content_type,
  13054. static_file_encoding(req, res, content_type, mm->size()));
  13055. }
  13056. }
  13057. if (file_open_error) {
  13058. ret = write_response(strm, close_after_response, req, res);
  13059. } else if (detail::range_error(req, res)) {
  13060. detail::clear_content(res);
  13061. res.status = StatusCode::RangeNotSatisfiable_416;
  13062. ret = write_response(strm, close_after_response, req, res);
  13063. } else {
  13064. ret = write_response_with_content(strm, close_after_response, req, res);
  13065. }
  13066. } else {
  13067. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13068. ret = write_response(strm, close_after_response, req, res);
  13069. }
  13070. // Drain any unconsumed framed body to prevent request smuggling on
  13071. // keep-alive. Without framing there is no body to drain — reading would
  13072. // consume the next request (issue #2450). If the response has committed the
  13073. // connection to close, there is no next request to protect. A body read in
  13074. // part cannot be drained from where it stopped, so the connection closes.
  13075. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13076. !detail::has_header_token(res.headers, "Connection", "close")) {
  13077. int dummy_status;
  13078. if (req.body_read_started_ ||
  13079. !detail::read_content(
  13080. strm, req, payload_max_length_, dummy_status, nullptr,
  13081. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  13082. connection_closed = true;
  13083. }
  13084. }
  13085. return ret;
  13086. }
  13087. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13088. inline bool Server::process_and_close_socket(socket_t sock) {
  13089. std::string remote_addr;
  13090. int remote_port = 0;
  13091. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13092. std::string local_addr;
  13093. int local_port = 0;
  13094. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13095. bool websocket_upgraded = false;
  13096. auto ret = serve_guarded([&]() {
  13097. return detail::process_server_socket(
  13098. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13099. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13100. write_timeout_usec_,
  13101. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13102. return process_request(strm, remote_addr, remote_port, local_addr,
  13103. local_port, close_connection,
  13104. connection_closed, nullptr,
  13105. &websocket_upgraded);
  13106. });
  13107. });
  13108. detail::drain_and_close_socket(sock);
  13109. return ret;
  13110. }
  13111. inline void Server::output_log(const Request &req, const Response &res) const {
  13112. if (logger_) {
  13113. std::lock_guard<std::mutex> guard(logger_mutex_);
  13114. logger_(req, res);
  13115. }
  13116. }
  13117. inline void Server::output_pre_compression_log(const Request &req,
  13118. const Response &res) const {
  13119. if (pre_compression_logger_) {
  13120. std::lock_guard<std::mutex> guard(logger_mutex_);
  13121. pre_compression_logger_(req, res);
  13122. }
  13123. }
  13124. inline void Server::output_error_log(const Error &err,
  13125. const Request *req) const {
  13126. if (error_logger_) {
  13127. std::lock_guard<std::mutex> guard(logger_mutex_);
  13128. error_logger_(err, req);
  13129. }
  13130. }
  13131. /*
  13132. * Group 5: ClientImpl and Client (Universal) implementation
  13133. */
  13134. // HTTP client implementation
  13135. inline ClientImpl::ClientImpl(const std::string &host)
  13136. : ClientImpl(host, 80, std::string(), std::string()) {}
  13137. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13138. : ClientImpl(host, port, std::string(), std::string()) {}
  13139. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13140. const std::string &client_cert_path,
  13141. const std::string &client_key_path)
  13142. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13143. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13144. inline ClientImpl::~ClientImpl() {
  13145. // Wait until all the requests in flight are handled.
  13146. size_t retry_count = 10;
  13147. while (retry_count-- > 0) {
  13148. {
  13149. std::lock_guard<std::mutex> guard(socket_mutex_);
  13150. if (socket_requests_in_flight_ == 0) { break; }
  13151. }
  13152. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13153. }
  13154. std::lock_guard<std::mutex> guard(socket_mutex_);
  13155. shutdown_socket(socket_);
  13156. close_socket(socket_);
  13157. }
  13158. inline bool ClientImpl::is_valid() const { return true; }
  13159. inline bool
  13160. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13161. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13162. if (no_proxy_entries_.empty()) { return true; }
  13163. // host_ is const so its normalized form is invariant; cache it. The
  13164. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13165. if (host == host_) {
  13166. if (!host_normalized_valid_) {
  13167. host_normalized_ = detail::normalize_target(host_);
  13168. host_normalized_valid_ = true;
  13169. }
  13170. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13171. }
  13172. auto target = detail::normalize_target(host);
  13173. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13174. }
  13175. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13176. if (is_proxy_enabled_for_host(host_)) {
  13177. return detail::create_client_socket(
  13178. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13179. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13180. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13181. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13182. }
  13183. // Check is custom IP or hostname specified for host_
  13184. std::string connect_host;
  13185. std::string ip;
  13186. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13187. return detail::create_client_socket(
  13188. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13189. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13190. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13191. write_timeout_usec_, interface_, error);
  13192. }
  13193. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13194. Error &error) {
  13195. auto sock = create_client_socket(error);
  13196. if (sock == INVALID_SOCKET) { return false; }
  13197. socket.sock = sock;
  13198. return true;
  13199. }
  13200. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13201. return create_and_connect_socket(socket, error);
  13202. }
  13203. inline bool ClientImpl::setup_proxy_connection(
  13204. Socket & /*socket*/,
  13205. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13206. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13207. return true;
  13208. }
  13209. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13210. bool /*shutdown_gracefully*/) {
  13211. // If there are any requests in flight from threads other than us, then it's
  13212. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13213. assert(socket_requests_in_flight_ == 0 ||
  13214. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13215. }
  13216. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13217. if (socket.sock == INVALID_SOCKET) { return; }
  13218. detail::shutdown_socket(socket.sock);
  13219. }
  13220. inline void ClientImpl::close_socket(Socket &socket) {
  13221. // If there are requests in flight in another thread, usually closing
  13222. // the socket will be fine and they will simply receive an error when
  13223. // using the closed socket, but it is still a bug since rarely the OS
  13224. // may reassign the socket id to be used for a new socket, and then
  13225. // suddenly they will be operating on a live socket that is different
  13226. // than the one they intended!
  13227. assert(socket_requests_in_flight_ == 0 ||
  13228. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13229. // It is also a bug if this happens while SSL is still active
  13230. #ifdef CPPHTTPLIB_SSL_ENABLED
  13231. assert(socket.ssl == nullptr);
  13232. #endif
  13233. if (socket.sock == INVALID_SOCKET) { return; }
  13234. detail::close_socket(socket.sock);
  13235. socket.sock = INVALID_SOCKET;
  13236. }
  13237. inline void ClientImpl::disconnect(bool gracefully) {
  13238. shutdown_ssl(socket_, gracefully);
  13239. shutdown_socket(socket_);
  13240. close_socket(socket_);
  13241. }
  13242. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13243. Response &res,
  13244. bool skip_100_continue) const {
  13245. std::array<char, 2048> buf{};
  13246. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13247. if (!line_reader.getline()) { return false; }
  13248. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13249. res.reason)) {
  13250. return req.method == "CONNECT";
  13251. }
  13252. // Skip interim (1xx) responses along with their header fields, except a 100
  13253. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13254. // HTTP on the connection, so it is final. A server sending them without end
  13255. // would hold the client, so there may be only so many.
  13256. size_t interim_count = 0;
  13257. while (100 <= res.status && res.status < 200 &&
  13258. res.status != StatusCode::SwitchingProtocol_101 &&
  13259. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13260. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13261. return false;
  13262. }
  13263. Headers interim_headers;
  13264. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13265. if (!line_reader.getline()) { return false; } // next response line
  13266. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13267. res.reason)) {
  13268. return false;
  13269. }
  13270. }
  13271. return true;
  13272. }
  13273. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13274. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13275. auto ret = send_(req, res, error);
  13276. if (error == Error::SSLPeerCouldBeClosed_) {
  13277. assert(!ret);
  13278. ret = send_(req, res, error);
  13279. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13280. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13281. }
  13282. return ret;
  13283. }
  13284. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13285. #ifdef CPPHTTPLIB_SSL_ENABLED
  13286. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13287. // client that failed to set up its TLS context keeps reporting why.
  13288. if (is_valid()) {
  13289. last_ssl_error_ = 0;
  13290. last_backend_error_ = 0;
  13291. }
  13292. #endif
  13293. {
  13294. std::lock_guard<std::mutex> guard(socket_mutex_);
  13295. // Set this to false immediately - if it ever gets set to true by the end
  13296. // of the request, we know another thread instructed us to close the
  13297. // socket.
  13298. socket_should_be_closed_when_request_is_done_ = false;
  13299. auto is_alive = false;
  13300. if (socket_.is_open()) {
  13301. is_alive = detail::is_socket_alive(socket_.sock);
  13302. #ifdef CPPHTTPLIB_SSL_ENABLED
  13303. if (is_alive && is_ssl()) {
  13304. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13305. is_alive = false;
  13306. }
  13307. }
  13308. #endif
  13309. if (!is_alive) {
  13310. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13311. disconnect(/*gracefully=*/false);
  13312. }
  13313. }
  13314. if (!is_alive) {
  13315. if (!ensure_socket_connection(socket_, error)) {
  13316. output_error_log(error, &req);
  13317. return false;
  13318. }
  13319. {
  13320. auto success = true;
  13321. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13322. error)) {
  13323. if (!success) { output_error_log(error, &req); }
  13324. return success;
  13325. }
  13326. }
  13327. }
  13328. // Mark the current socket as being in use so that it cannot be closed by
  13329. // anyone else while this request is ongoing, even though we will be
  13330. // releasing the mutex.
  13331. if (socket_requests_in_flight_ > 1) {
  13332. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13333. }
  13334. socket_requests_in_flight_ += 1;
  13335. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13336. }
  13337. for (const auto &header : default_headers_) {
  13338. if (req.headers.find(header.first) == req.headers.end()) {
  13339. req.headers.insert(header);
  13340. }
  13341. }
  13342. auto ret = false;
  13343. auto close_connection = !keep_alive_;
  13344. auto se = detail::scope_exit([&]() {
  13345. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13346. std::lock_guard<std::mutex> guard(socket_mutex_);
  13347. socket_requests_in_flight_ -= 1;
  13348. if (socket_requests_in_flight_ <= 0) {
  13349. assert(socket_requests_in_flight_ == 0);
  13350. socket_requests_are_from_thread_ = std::thread::id();
  13351. }
  13352. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13353. !ret) {
  13354. disconnect(/*gracefully=*/true);
  13355. }
  13356. });
  13357. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13358. return handle_request(strm, req, res, close_connection, error);
  13359. });
  13360. if (!ret) {
  13361. if (error == Error::Success) {
  13362. error = Error::Unknown;
  13363. output_error_log(error, &req);
  13364. }
  13365. }
  13366. return ret;
  13367. }
  13368. inline Result ClientImpl::send(const Request &req) {
  13369. auto req2 = req;
  13370. return send_(std::move(req2));
  13371. }
  13372. inline Result ClientImpl::send_(Request &&req) {
  13373. auto res = detail::make_unique<Response>();
  13374. auto error = Error::Success;
  13375. #ifdef CPPHTTPLIB_SSL_ENABLED
  13376. // Hold the request lock until the Result has read this request's TLS error
  13377. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13378. #endif
  13379. auto ret = send(req, *res, error);
  13380. #ifdef CPPHTTPLIB_SSL_ENABLED
  13381. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13382. last_ssl_error_, last_backend_error_};
  13383. #else
  13384. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13385. #endif
  13386. }
  13387. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13388. const std::string &ct) {
  13389. (void)for_stream;
  13390. // Default headers are meant for the origin and may carry its credentials, so
  13391. // keep them off the CONNECT request the proxy reads.
  13392. if (r.method != "CONNECT") {
  13393. for (const auto &header : default_headers_) {
  13394. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13395. }
  13396. }
  13397. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13398. // prepend it rather than appending it after the caller's own fields.
  13399. if (!r.has_header("Host")) {
  13400. r.headers.emplace_front(
  13401. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13402. address_family_));
  13403. }
  13404. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13405. if (!r.content_receiver) {
  13406. if (!r.has_header("Accept-Encoding")) {
  13407. std::string accept_encoding;
  13408. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13409. accept_encoding = "br";
  13410. #endif
  13411. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13412. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13413. accept_encoding += "gzip, deflate";
  13414. #endif
  13415. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13416. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13417. accept_encoding += "zstd";
  13418. #endif
  13419. r.set_header("Accept-Encoding", accept_encoding);
  13420. }
  13421. detail::add_default_user_agent_header(r);
  13422. }
  13423. if (!r.body.empty()) {
  13424. if (!ct.empty() && !r.has_header("Content-Type")) {
  13425. r.headers.emplace("Content-Type", ct);
  13426. }
  13427. if (!r.has_header("Content-Length")) {
  13428. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13429. }
  13430. }
  13431. }
  13432. inline ClientImpl::StreamHandle
  13433. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13434. const Params &params, const Headers &headers,
  13435. const std::string &body,
  13436. const std::string &content_type) {
  13437. StreamHandle handle;
  13438. handle.response = detail::make_unique<Response>();
  13439. handle.error = Error::Success;
  13440. // Encode the target exactly like the buffered send path does, so that the
  13441. // same `path` produces the same request line through either API.
  13442. auto raw_query_path =
  13443. params.empty() ? path : append_query_params(path, params);
  13444. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13445. handle.connection_ = detail::make_unique<ClientConnection>();
  13446. {
  13447. std::lock_guard<std::mutex> guard(socket_mutex_);
  13448. auto is_alive = false;
  13449. if (socket_.is_open()) {
  13450. is_alive = detail::is_socket_alive(socket_.sock);
  13451. #ifdef CPPHTTPLIB_SSL_ENABLED
  13452. if (is_alive && is_ssl()) {
  13453. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13454. is_alive = false;
  13455. }
  13456. }
  13457. #endif
  13458. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13459. }
  13460. if (!is_alive) {
  13461. if (!ensure_socket_connection(socket_, handle.error)) {
  13462. handle.response.reset();
  13463. return handle;
  13464. }
  13465. {
  13466. auto success = true;
  13467. auto start_time = std::chrono::steady_clock::now();
  13468. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13469. success, handle.error)) {
  13470. if (!success) { handle.response.reset(); }
  13471. return handle;
  13472. }
  13473. }
  13474. }
  13475. transfer_socket_ownership_to_handle(handle);
  13476. }
  13477. #ifdef CPPHTTPLIB_SSL_ENABLED
  13478. if (is_ssl() && handle.connection_->session) {
  13479. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13480. handle.connection_->sock, handle.connection_->session,
  13481. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13482. write_timeout_usec_);
  13483. } else {
  13484. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13485. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13486. write_timeout_sec_, write_timeout_usec_);
  13487. }
  13488. #else
  13489. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13490. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13491. write_timeout_sec_, write_timeout_usec_);
  13492. #endif
  13493. handle.stream_ = handle.socket_stream_.get();
  13494. Request req;
  13495. req.method = method;
  13496. req.path = query_path;
  13497. req.headers = headers;
  13498. req.body = body;
  13499. prepare_default_headers(req, true, content_type);
  13500. auto &strm = *handle.stream_;
  13501. // Build the request line and headers in memory first, like write_request()
  13502. // does, so that a rejected header leaves nothing on the wire.
  13503. {
  13504. detail::BufferStream bstrm;
  13505. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13506. handle.error = Error::Write;
  13507. handle.response.reset();
  13508. return handle;
  13509. }
  13510. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13511. handle.error)) {
  13512. handle.response.reset();
  13513. return handle;
  13514. }
  13515. const auto &data = bstrm.get_buffer();
  13516. if (!detail::write_data(strm, data.data(), data.size())) {
  13517. handle.error = Error::Write;
  13518. handle.response.reset();
  13519. return handle;
  13520. }
  13521. }
  13522. if (!body.empty()) {
  13523. if (strm.write(body.data(), body.size()) < 0) {
  13524. handle.error = Error::Write;
  13525. handle.response.reset();
  13526. return handle;
  13527. }
  13528. }
  13529. if (!read_response_line(strm, req, *handle.response) ||
  13530. !detail::read_headers(strm, handle.response->headers)) {
  13531. handle.error = Error::Read;
  13532. handle.response.reset();
  13533. return handle;
  13534. }
  13535. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13536. // (204/304) response legitimately carries framing headers with no body.
  13537. if (method != "HEAD" &&
  13538. handle.response->status != StatusCode::NoContent_204 &&
  13539. handle.response->status != StatusCode::NotModified_304 &&
  13540. detail::has_conflicting_content_length(handle.response->headers)) {
  13541. handle.error = Error::Read;
  13542. handle.response.reset();
  13543. return handle;
  13544. }
  13545. handle.body_reader_.stream = handle.stream_;
  13546. handle.body_reader_.payload_max_length = payload_max_length_;
  13547. if (handle.response->has_header("Content-Length")) {
  13548. bool is_invalid = false;
  13549. auto content_length = detail::get_header_value_u64(
  13550. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13551. if (is_invalid) {
  13552. handle.error = Error::Read;
  13553. handle.response.reset();
  13554. return handle;
  13555. }
  13556. handle.body_reader_.has_content_length = true;
  13557. handle.body_reader_.content_length = content_length;
  13558. }
  13559. handle.body_reader_.chunked =
  13560. detail::is_chunked_transfer_encoding(handle.response->headers);
  13561. auto content_encoding = detail::get_combined_header_value(
  13562. handle.response->headers, "Content-Encoding");
  13563. if (!content_encoding.empty()) {
  13564. // Same policy as prepare_content_receiver(): reject a coding we know about
  13565. // but were not built with, pass an unrecognized one through as-is.
  13566. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13567. if (!handle.decompressor_) {
  13568. if (detail::is_known_content_encoding(content_encoding)) {
  13569. handle.error = Error::UnsupportedContentEncoding;
  13570. handle.response.reset();
  13571. return handle;
  13572. }
  13573. } else if (!handle.decompressor_->is_valid()) {
  13574. handle.error = Error::Compression;
  13575. handle.response.reset();
  13576. return handle;
  13577. }
  13578. }
  13579. return handle;
  13580. }
  13581. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13582. if (!is_valid() || !response) { return -1; }
  13583. auto n = decompressor_
  13584. ? read_with_decompression(buf, len)
  13585. : detail::read_body_content(stream_, body_reader_, buf, len);
  13586. if (n == 0) { parse_trailers_if_needed(); }
  13587. return n;
  13588. }
  13589. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13590. size_t len) {
  13591. if (decompress_offset_ < decompress_buffer_.size()) {
  13592. auto available = decompress_buffer_.size() - decompress_offset_;
  13593. auto to_copy = (std::min)(len, available);
  13594. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13595. decompress_offset_ += to_copy;
  13596. decompressed_bytes_read_ += to_copy;
  13597. return static_cast<ssize_t>(to_copy);
  13598. }
  13599. decompress_buffer_.clear();
  13600. decompress_offset_ = 0;
  13601. constexpr size_t kDecompressionBufferSize = 8192;
  13602. char compressed_buf[kDecompressionBufferSize];
  13603. while (true) {
  13604. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13605. sizeof(compressed_buf));
  13606. if (n <= 0) { return n; }
  13607. auto exceeded = false;
  13608. bool decompress_ok = decompressor_->decompress(
  13609. compressed_buf, static_cast<size_t>(n),
  13610. [&](const char *data, size_t data_len) {
  13611. decompress_buffer_.append(data, data_len);
  13612. auto limit = body_reader_.payload_max_length;
  13613. exceeded =
  13614. limit > 0 &&
  13615. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13616. return !exceeded;
  13617. });
  13618. if (!decompress_ok) {
  13619. body_reader_.last_error =
  13620. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13621. return -1;
  13622. }
  13623. if (!decompress_buffer_.empty()) { break; }
  13624. }
  13625. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13626. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13627. decompress_offset_ = to_copy;
  13628. decompressed_bytes_read_ += to_copy;
  13629. return static_cast<ssize_t>(to_copy);
  13630. }
  13631. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13632. // The trailers follow the last chunk, so there are none before it
  13633. auto &decoder = body_reader_.chunked_decoder;
  13634. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13635. return;
  13636. }
  13637. trailers_parsed_ = true;
  13638. decoder->parse_trailers_into(response->trailers, response->headers);
  13639. }
  13640. namespace detail {
  13641. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13642. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13643. size_t &out_chunk_offset,
  13644. size_t &out_chunk_total) {
  13645. if (finished) { return 0; }
  13646. if (chunk_remaining == 0) {
  13647. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13648. if (!lr.getline()) { return -1; }
  13649. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13650. // the line terminator is never mistaken for line content.
  13651. const char *eol = lr.ptr() + lr.size();
  13652. if (lr.end_with_crlf()) {
  13653. eol -= 2;
  13654. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13655. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13656. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13657. // has to come off here or the check below would reject the line.
  13658. eol -= 1;
  13659. }
  13660. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13661. const char *p = lr.ptr();
  13662. int v = 0;
  13663. if (p == eol || !is_hex(*p, v)) { return -1; }
  13664. size_t chunk_len = 0;
  13665. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13666. for (; p < eol && is_hex(*p, v); ++p) {
  13667. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13668. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13669. }
  13670. while (p < eol && is_space_or_tab(*p)) {
  13671. ++p;
  13672. }
  13673. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13674. // terminator, and it is built from tokens and quoted-strings, so it never
  13675. // holds a CR, LF or any other control character. getline() reads up to the
  13676. // CRLF, so a bare LF left in here would be swallowed as extension text
  13677. // while an intermediary that ends the line on it delimits the chunks
  13678. // differently, and the two disagree on where the body ends (request
  13679. // smuggling).
  13680. if (p < eol && *p != ';') { return -1; }
  13681. for (; p < eol; ++p) {
  13682. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13683. }
  13684. if (chunk_len == 0) {
  13685. chunk_remaining = 0;
  13686. finished = true;
  13687. out_chunk_offset = 0;
  13688. out_chunk_total = 0;
  13689. return 0;
  13690. }
  13691. chunk_remaining = chunk_len;
  13692. last_chunk_total = chunk_remaining;
  13693. last_chunk_offset = 0;
  13694. }
  13695. auto to_read = (std::min)(chunk_remaining, len);
  13696. auto n = strm.read(buf, to_read);
  13697. if (n <= 0) { return -1; }
  13698. auto offset_before = last_chunk_offset;
  13699. last_chunk_offset += static_cast<size_t>(n);
  13700. chunk_remaining -= static_cast<size_t>(n);
  13701. out_chunk_offset = offset_before;
  13702. out_chunk_total = last_chunk_total;
  13703. if (chunk_remaining == 0) {
  13704. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13705. if (!lr.getline()) { return -1; }
  13706. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13707. }
  13708. return n;
  13709. }
  13710. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13711. const Headers &src_headers) {
  13712. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13713. if (!lr.getline()) { return false; }
  13714. return parse_trailers(lr, dest, src_headers);
  13715. }
  13716. // A 3xx without a Location, such as a 304, is a final response
  13717. inline bool is_redirect(const Response &res) {
  13718. return 300 < res.status && res.status < 400 &&
  13719. !res.get_header_value("Location").empty();
  13720. }
  13721. } // namespace detail
  13722. inline void
  13723. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13724. handle.connection_->sock = socket_.sock;
  13725. #ifdef CPPHTTPLIB_SSL_ENABLED
  13726. handle.connection_->session = socket_.ssl;
  13727. socket_.ssl = nullptr;
  13728. #endif
  13729. socket_.sock = INVALID_SOCKET;
  13730. }
  13731. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13732. Response &res, bool close_connection,
  13733. Error &error) {
  13734. if (req.path.empty()) {
  13735. error = Error::Connection;
  13736. output_error_log(error, &req);
  13737. return false;
  13738. }
  13739. auto req_save = req;
  13740. bool ret;
  13741. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13742. auto req2 = req;
  13743. req2.path = "http://" +
  13744. detail::make_host_and_port_string(host_, port_, false) +
  13745. req.path;
  13746. ret = process_request(strm, req2, res, close_connection, error);
  13747. req = std::move(req2);
  13748. req.path = req_save.path;
  13749. } else {
  13750. ret = process_request(strm, req, res, close_connection, error);
  13751. }
  13752. if (!ret) { return false; }
  13753. {
  13754. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13755. // for this to be safe.
  13756. // This is safe to call because handle_request is only called by send_
  13757. // which locks the request mutex during the process. It would be a bug
  13758. // to call it from a different thread since it's a thread-safety issue
  13759. // to do these things to the socket if another thread is using the socket.
  13760. std::lock_guard<std::mutex> guard(socket_mutex_);
  13761. // Also when the request asked for it (e.g. a body that was never sent),
  13762. // so that a redirect or an auth retry below does not reuse the socket.
  13763. if (socket_should_be_closed_when_request_is_done_ ||
  13764. detail::has_header_token(res.headers, "Connection", "close") ||
  13765. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13766. disconnect(/*gracefully=*/true);
  13767. }
  13768. }
  13769. if (follow_location_ && detail::is_redirect(res)) {
  13770. req = std::move(req_save);
  13771. // The client that followed the redirect has answered any challenge it
  13772. // could. Retrying below would sign another host's challenge and send it
  13773. // here.
  13774. return redirect(req, res, error);
  13775. }
  13776. #ifdef CPPHTTPLIB_SSL_ENABLED
  13777. if ((res.status == StatusCode::Unauthorized_401 ||
  13778. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13779. req.authorization_count_ < 5) {
  13780. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13781. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13782. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13783. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13784. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13785. return ret;
  13786. }
  13787. const auto &username =
  13788. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13789. const auto &password =
  13790. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13791. if (!username.empty() && !password.empty()) {
  13792. std::map<std::string, std::string> auth;
  13793. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13794. Request new_req = req;
  13795. new_req.authorization_count_ += 1;
  13796. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13797. : "Authorization");
  13798. new_req.headers.insert(detail::make_digest_authentication_header(
  13799. req, make_request_target(req), auth, new_req.authorization_count_,
  13800. detail::random_string(10), username, password, is_proxy));
  13801. Response new_res;
  13802. ret = send(new_req, new_res, error);
  13803. if (ret) { res = std::move(new_res); }
  13804. }
  13805. }
  13806. }
  13807. #endif
  13808. return ret;
  13809. }
  13810. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13811. if (req.redirect_count_ == 0) {
  13812. error = Error::ExceedRedirectCount;
  13813. output_error_log(error, &req);
  13814. return false;
  13815. }
  13816. auto location = res.get_header_value("location");
  13817. if (location.empty()) { return false; }
  13818. detail::UrlComponents uc;
  13819. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13820. uc)) {
  13821. return false;
  13822. }
  13823. // Only follow http/https redirects
  13824. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13825. return false;
  13826. }
  13827. auto scheme = is_ssl() ? "https" : "http";
  13828. auto next_scheme = std::move(uc.scheme);
  13829. auto next_host = std::move(uc.host);
  13830. auto port_str = std::move(uc.port);
  13831. auto next_path = std::move(uc.path);
  13832. auto next_query = std::move(uc.query);
  13833. auto next_port = port_;
  13834. if (!port_str.empty()) {
  13835. if (!detail::parse_port(port_str, next_port)) { return false; }
  13836. } else if (!next_scheme.empty()) {
  13837. next_port = next_scheme == "https" ? 443 : 80;
  13838. }
  13839. if (next_scheme.empty()) { next_scheme = scheme; }
  13840. if (next_host.empty()) { next_host = host_; }
  13841. if (next_path.empty()) { next_path = "/"; }
  13842. auto path = std::move(next_path) + next_query;
  13843. // Same host redirect - use current client
  13844. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13845. return detail::redirect(*this, req, res, path, location, error);
  13846. }
  13847. // Cross-host/scheme redirect - create new client with robust setup
  13848. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13849. path, location, error);
  13850. }
  13851. // New method for robust redirect client creation
  13852. inline bool ClientImpl::create_redirect_client(
  13853. const std::string &scheme, const std::string &host, int port, Request &req,
  13854. Response &res, const std::string &path, const std::string &location,
  13855. Error &error) {
  13856. // Determine if we need SSL
  13857. auto need_ssl = (scheme == "https");
  13858. // Clean up request headers that are host/client specific
  13859. // Remove headers that should not be carried over to new host
  13860. auto headers_to_remove = std::vector<std::string>{
  13861. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13862. for (const auto &header_name : headers_to_remove) {
  13863. auto it = req.headers.find(header_name);
  13864. while (it != req.headers.end()) {
  13865. it = req.headers.erase(it);
  13866. it = req.headers.find(header_name);
  13867. }
  13868. }
  13869. // Create appropriate client type and handle redirect
  13870. if (need_ssl) {
  13871. #ifdef CPPHTTPLIB_SSL_ENABLED
  13872. // Create SSL client for HTTPS redirect
  13873. SSLClient redirect_client(host, port);
  13874. // Setup basic client configuration first
  13875. setup_redirect_client(redirect_client);
  13876. redirect_client.enable_server_certificate_verification(
  13877. server_certificate_verification_);
  13878. redirect_client.enable_server_hostname_verification(
  13879. server_hostname_verification_);
  13880. redirect_client.system_ca_mode_ = system_ca_mode_;
  13881. // Transfer CA certificate to redirect client
  13882. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13883. if (is_ssl()) {
  13884. auto &self = static_cast<SSLClient &>(*this);
  13885. // A store given to set_ca_cert_store() lives only in this client's
  13886. // context, which then holds all that is trusted.
  13887. if (self.ca_cert_store_set_) {
  13888. std::string pem;
  13889. {
  13890. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  13891. pem = detail::ca_certs_to_pem(self.ctx_);
  13892. }
  13893. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13894. redirect_client.ca_cert_store_set_ = true;
  13895. } else {
  13896. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13897. ca_cert_pem_.size());
  13898. }
  13899. redirect_client.set_session_verifier(self.session_verifier_);
  13900. if (self.server_certificate_verifier_) {
  13901. redirect_client.set_server_certificate_verifier(
  13902. self.server_certificate_verifier_);
  13903. }
  13904. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13905. redirect_client.enable_windows_cert_verification_ =
  13906. self.enable_windows_cert_verification_;
  13907. #endif
  13908. }
  13909. // Client certificates are set through constructor for SSLClient
  13910. // NOTE: SSLClient constructor already takes client_cert_path and
  13911. // client_key_path so we need to create it properly if client certs are
  13912. // needed
  13913. // Execute the redirect
  13914. return detail::redirect(redirect_client, req, res, path, location, error);
  13915. #else
  13916. // SSL not supported - set appropriate error
  13917. error = Error::SSLConnection;
  13918. output_error_log(error, &req);
  13919. return false;
  13920. #endif
  13921. } else {
  13922. // HTTP redirect
  13923. ClientImpl redirect_client(host, port);
  13924. // Setup client with robust configuration
  13925. setup_redirect_client(redirect_client);
  13926. // Execute the redirect
  13927. return detail::redirect(redirect_client, req, res, path, location, error);
  13928. }
  13929. }
  13930. // New method for robust client setup (based on basic_manual_redirect.cpp
  13931. // logic)
  13932. template <typename ClientType>
  13933. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13934. // Copy basic settings first
  13935. client.set_connection_timeout(connection_timeout_sec_,
  13936. connection_timeout_usec_);
  13937. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13938. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13939. client.set_max_timeout(max_timeout_msec_);
  13940. if (has_payload_max_length_) {
  13941. client.set_payload_max_length(payload_max_length_);
  13942. }
  13943. client.set_keep_alive(keep_alive_);
  13944. client.set_follow_location(
  13945. true); // Enable redirects to handle multi-step redirects
  13946. client.set_path_encode(path_encode_);
  13947. client.set_compress(compress_);
  13948. client.set_decompress(decompress_);
  13949. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13950. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13951. // 15.4, credentials must not be forwarded when redirecting to a different
  13952. // host. This function is only called for cross-host redirects; same-host
  13953. // redirects are handled directly in ClientImpl::redirect().
  13954. // Copy the proxy configuration unconditionally; the per-target bypass is
  13955. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13956. // still use the proxy.
  13957. client.no_proxy_entries_ = no_proxy_entries_;
  13958. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13959. client.set_proxy(proxy_host_, proxy_port_);
  13960. if (!proxy_basic_auth_username_.empty() ||
  13961. !proxy_basic_auth_password_.empty()) {
  13962. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13963. proxy_basic_auth_password_);
  13964. }
  13965. if (!proxy_bearer_token_auth_token_.empty()) {
  13966. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13967. }
  13968. #ifdef CPPHTTPLIB_SSL_ENABLED
  13969. if (!proxy_digest_auth_username_.empty()) {
  13970. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13971. proxy_digest_auth_password_);
  13972. }
  13973. #endif
  13974. }
  13975. // Copy network and socket settings
  13976. client.addr_map_ = addr_map_;
  13977. client.set_address_family(address_family_);
  13978. client.set_tcp_nodelay(tcp_nodelay_);
  13979. client.set_ipv6_v6only(ipv6_v6only_);
  13980. if (socket_options_) { client.set_socket_options(socket_options_); }
  13981. if (!interface_.empty()) { client.set_interface(interface_); }
  13982. // Copy logging and headers
  13983. if (logger_) { client.set_logger(logger_); }
  13984. if (error_logger_) { client.set_error_logger(error_logger_); }
  13985. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13986. // Each new client should generate its own headers based on its target host
  13987. }
  13988. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13989. const Request &req,
  13990. Error &error) const {
  13991. auto is_shutting_down = []() { return false; };
  13992. if (req.is_chunked_content_provider_) {
  13993. auto compressor = compress_ ? detail::create_compressor().first
  13994. : std::unique_ptr<detail::compressor>();
  13995. if (!compressor) {
  13996. compressor = detail::make_unique<detail::nocompressor>();
  13997. }
  13998. return detail::write_content_chunked(strm, req.content_provider_,
  13999. is_shutting_down, *compressor, error);
  14000. } else {
  14001. return detail::write_content_with_progress(
  14002. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14003. req.upload_progress, error);
  14004. }
  14005. }
  14006. // What goes on the request line for req: its path, encoded and without the
  14007. // fragment, with `req.params` as the query when the path has none.
  14008. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14009. auto target = detail::encode_request_target(req.path, path_encode_);
  14010. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14011. target = append_query_params(target, req.params);
  14012. }
  14013. return target;
  14014. }
  14015. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14016. bool close_connection, Error &error,
  14017. bool skip_body, bool &rejected_locally) {
  14018. rejected_locally = false;
  14019. // Prepare additional headers
  14020. if (close_connection) {
  14021. if (!req.has_header("Connection")) {
  14022. req.set_header("Connection", "close");
  14023. }
  14024. }
  14025. std::string ct_for_defaults;
  14026. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14027. ct_for_defaults = "text/plain";
  14028. }
  14029. prepare_default_headers(req, false, ct_for_defaults);
  14030. if (req.body.empty()) {
  14031. if (req.content_provider_) {
  14032. if (!req.is_chunked_content_provider_) {
  14033. if (!req.has_header("Content-Length")) {
  14034. auto length = std::to_string(req.content_length_);
  14035. req.set_header("Content-Length", length);
  14036. }
  14037. }
  14038. } else {
  14039. if (req.method == "POST" || req.method == "PUT" ||
  14040. req.method == "PATCH") {
  14041. req.set_header("Content-Length", "0");
  14042. }
  14043. }
  14044. }
  14045. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14046. // it opens is read by the origin. Each credential goes only to its own hop.
  14047. auto is_connect = req.method == "CONNECT";
  14048. if (!is_connect) {
  14049. detail::add_authorization_header(req, basic_auth_username_,
  14050. basic_auth_password_,
  14051. bearer_token_auth_token_, false);
  14052. }
  14053. // Proxy-Authorization is only sent when the proxy reads this message —
  14054. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14055. // would leak proxy credentials to the destination server.
  14056. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14057. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14058. proxy_basic_auth_password_,
  14059. proxy_bearer_token_auth_token_, true);
  14060. }
  14061. // Request line and headers
  14062. {
  14063. detail::BufferStream bstrm;
  14064. auto path_with_query = make_request_target(req);
  14065. // The query already came in through `req.path`; still populate
  14066. // `req.params` for handlers/users who read them.
  14067. auto query_part = detail::query_of(req.path);
  14068. if (!query_part.empty()) {
  14069. detail::parse_query_text(query_part, req.params);
  14070. }
  14071. // Write request line and headers
  14072. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14073. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14074. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14075. // fail the request cleanly instead of emitting a request-line-less,
  14076. // header-injecting request.
  14077. error = Error::Write;
  14078. rejected_locally = true;
  14079. output_error_log(error, &req);
  14080. return false;
  14081. }
  14082. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14083. error)) {
  14084. rejected_locally = true;
  14085. output_error_log(error, &req);
  14086. return false;
  14087. }
  14088. // Flush buffer
  14089. auto &data = bstrm.get_buffer();
  14090. if (!detail::write_data(strm, data.data(), data.size())) {
  14091. error = Error::Write;
  14092. output_error_log(error, &req);
  14093. return false;
  14094. }
  14095. }
  14096. // After sending request line and headers, wait briefly for an early server
  14097. // response (e.g. 4xx) and avoid sending a potentially large request body
  14098. // unnecessarily. This workaround is only enabled on Windows because Unix
  14099. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14100. // buffering can accept large writes even when the peer already responded.
  14101. // Check the stream first (which covers SSL via `is_readable()`), then
  14102. // fall back to select on the socket. Only perform the wait for very large
  14103. // request bodies to avoid interfering with normal small requests and
  14104. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14105. // response. Skip this check when using Expect: 100-continue, as the protocol
  14106. // handles early responses properly.
  14107. #if defined(_WIN32)
  14108. if (!skip_body &&
  14109. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14110. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14111. auto start = std::chrono::high_resolution_clock::now();
  14112. for (;;) {
  14113. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14114. // from SSL internals. If the underlying socket is readable, assume an
  14115. // early response may be present.
  14116. auto sock = strm.socket();
  14117. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14118. return false;
  14119. }
  14120. // Fallback to stream-level check for non-socket streams or when the
  14121. // socket isn't reporting readable. Avoid using `is_readable()` for
  14122. // SSL, since `SSL_pending()` may report buffered records that do not
  14123. // indicate a complete application-level response yet.
  14124. if (!is_ssl() && strm.is_readable()) { return false; }
  14125. auto now = std::chrono::high_resolution_clock::now();
  14126. auto elapsed =
  14127. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14128. .count();
  14129. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14130. break;
  14131. }
  14132. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14133. }
  14134. }
  14135. #endif
  14136. // Body
  14137. if (skip_body) { return true; }
  14138. return write_request_body(strm, req, error);
  14139. }
  14140. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14141. Error &error) {
  14142. if (req.body.empty()) {
  14143. return write_content_with_provider(strm, req, error);
  14144. }
  14145. if (req.upload_progress) {
  14146. auto body_size = req.body.size();
  14147. size_t written = 0;
  14148. auto data = req.body.data();
  14149. while (written < body_size) {
  14150. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14151. if (!detail::write_data(strm, data + written, to_write)) {
  14152. error = Error::Write;
  14153. output_error_log(error, &req);
  14154. return false;
  14155. }
  14156. written += to_write;
  14157. if (!req.upload_progress(written, body_size)) {
  14158. error = Error::Canceled;
  14159. output_error_log(error, &req);
  14160. return false;
  14161. }
  14162. }
  14163. } else {
  14164. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14165. error = Error::Write;
  14166. output_error_log(error, &req);
  14167. return false;
  14168. }
  14169. }
  14170. return true;
  14171. }
  14172. inline std::unique_ptr<Response>
  14173. ClientImpl::send_with_content_provider_and_receiver(
  14174. Request &req, const char *body, size_t content_length,
  14175. ContentProvider content_provider,
  14176. ContentProviderWithoutLength content_provider_without_length,
  14177. const std::string &content_type, ContentReceiver content_receiver,
  14178. Error &error) {
  14179. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14180. auto enc = compress_
  14181. ? detail::create_compressor()
  14182. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14183. nullptr, nullptr);
  14184. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14185. if (enc.first && !content_provider_without_length) {
  14186. auto &compressor = enc.first;
  14187. if (content_provider) {
  14188. auto ok = true;
  14189. auto finished = false;
  14190. size_t offset = 0;
  14191. DataSink data_sink;
  14192. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14193. if (ok) {
  14194. auto last = offset + data_len == content_length;
  14195. auto ret = compressor->compress(
  14196. data, data_len, last,
  14197. [&](const char *compressed_data, size_t compressed_data_len) {
  14198. req.body.append(compressed_data, compressed_data_len);
  14199. return true;
  14200. });
  14201. if (ret) {
  14202. offset += data_len;
  14203. } else {
  14204. ok = false;
  14205. }
  14206. }
  14207. return ok;
  14208. };
  14209. // As in detail::write_content_with_progress(): the body is framed by
  14210. // content_length, so a provider that finishes early has truncated it.
  14211. // Stop and report that instead of calling the provider forever.
  14212. data_sink.done = [&]() { finished = true; };
  14213. while (ok && !finished && offset < content_length) {
  14214. if (!content_provider(offset, content_length - offset, data_sink)) {
  14215. error = Error::Canceled;
  14216. output_error_log(error, &req);
  14217. return nullptr;
  14218. }
  14219. }
  14220. // A short body here means either the provider stopped early or the
  14221. // compressor gave up. The branch below reports a failing compressor as
  14222. // Error::Compression, so keep the two distinguishable.
  14223. if (offset < content_length) {
  14224. error = ok ? Error::Write : Error::Compression;
  14225. output_error_log(error, &req);
  14226. return nullptr;
  14227. }
  14228. } else {
  14229. if (!compressor->compress(body, content_length, true,
  14230. [&](const char *data, size_t data_len) {
  14231. req.body.append(data, data_len);
  14232. return true;
  14233. })) {
  14234. error = Error::Compression;
  14235. output_error_log(error, &req);
  14236. return nullptr;
  14237. }
  14238. }
  14239. } else {
  14240. if (content_provider) {
  14241. req.content_length_ = content_length;
  14242. req.content_provider_ = std::move(content_provider);
  14243. req.is_chunked_content_provider_ = false;
  14244. } else if (content_provider_without_length) {
  14245. req.content_length_ = 0;
  14246. req.content_provider_ = detail::ContentProviderAdapter(
  14247. std::move(content_provider_without_length));
  14248. req.is_chunked_content_provider_ = true;
  14249. req.set_header("Transfer-Encoding", "chunked");
  14250. } else {
  14251. req.body.assign(body, content_length);
  14252. }
  14253. }
  14254. if (content_receiver) {
  14255. req.content_receiver =
  14256. [content_receiver](const char *data, size_t data_length,
  14257. size_t /*offset*/, size_t /*total_length*/) {
  14258. return content_receiver(data, data_length);
  14259. };
  14260. }
  14261. auto res = detail::make_unique<Response>();
  14262. return send(req, *res, error) ? std::move(res) : nullptr;
  14263. }
  14264. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14265. const std::string &method, const std::string &path, const Headers &headers,
  14266. const char *body, size_t content_length, ContentProvider content_provider,
  14267. ContentProviderWithoutLength content_provider_without_length,
  14268. const std::string &content_type, ContentReceiver content_receiver,
  14269. UploadProgress progress) {
  14270. Request req;
  14271. req.method = method;
  14272. req.headers = headers;
  14273. req.path = path;
  14274. req.upload_progress = std::move(progress);
  14275. if (max_timeout_msec_ > 0) {
  14276. req.start_time_ = std::chrono::steady_clock::now();
  14277. }
  14278. auto error = Error::Success;
  14279. #ifdef CPPHTTPLIB_SSL_ENABLED
  14280. // Hold the request lock until the Result has read this request's TLS error
  14281. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14282. #endif
  14283. auto res = send_with_content_provider_and_receiver(
  14284. req, body, content_length, std::move(content_provider),
  14285. std::move(content_provider_without_length), content_type,
  14286. std::move(content_receiver), error);
  14287. #ifdef CPPHTTPLIB_SSL_ENABLED
  14288. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14289. last_backend_error_};
  14290. #else
  14291. return Result{std::move(res), error, std::move(req.headers)};
  14292. #endif
  14293. }
  14294. inline void ClientImpl::output_log(const Request &req,
  14295. const Response &res) const {
  14296. if (logger_) {
  14297. std::lock_guard<std::mutex> guard(logger_mutex_);
  14298. logger_(req, res);
  14299. }
  14300. }
  14301. inline void ClientImpl::output_error_log(const Error &err,
  14302. const Request *req) const {
  14303. if (error_logger_) {
  14304. std::lock_guard<std::mutex> guard(logger_mutex_);
  14305. error_logger_(err, req);
  14306. }
  14307. }
  14308. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14309. Response &res, bool close_connection,
  14310. Error &error) {
  14311. // Auto-add Expect: 100-continue for large bodies
  14312. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14313. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14314. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14315. req.set_header("Expect", "100-continue");
  14316. }
  14317. }
  14318. // Check for Expect: 100-continue
  14319. auto expect_100_continue =
  14320. detail::has_header_token(req.headers, "Expect", "100-continue");
  14321. // Send request (skip body if using Expect: 100-continue)
  14322. auto rejected_locally = false;
  14323. auto write_request_success =
  14324. write_request(strm, req, close_connection, error, expect_100_continue,
  14325. rejected_locally);
  14326. // A failed write normally still reads the response below, since the server
  14327. // may have answered early (e.g. 413/414) and closed while the body was being
  14328. // sent. A request rejected before any byte reached the socket gets no such
  14329. // response, and waiting for one would block until the read timeout.
  14330. if (rejected_locally) { return false; }
  14331. #ifdef CPPHTTPLIB_SSL_ENABLED
  14332. if (is_ssl() && !expect_100_continue) {
  14333. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14334. if (!is_proxy_enabled) {
  14335. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14336. error = Error::SSLPeerCouldBeClosed_;
  14337. output_error_log(error, &req);
  14338. return false;
  14339. }
  14340. }
  14341. }
  14342. #endif
  14343. // Handle Expect: 100-continue.
  14344. //
  14345. // Wait for an interim/early response by attempting to read the status line
  14346. // under a short timeout, instead of trusting raw socket readability. Over
  14347. // TLS, post-handshake records (e.g. session tickets) make the socket
  14348. // readable without any HTTP response being available; relying on
  14349. // `select_read` there caused the body to be withheld forever and the
  14350. // request to fail with `Read` (#2458). If no status line arrives within the
  14351. // timeout, send the body anyway (matching curl's behavior).
  14352. auto status_line_read = false;
  14353. if (expect_100_continue && write_request_success) {
  14354. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14355. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14356. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14357. strm.set_read_timeout(sec, usec);
  14358. status_line_read = read_response_line(strm, req, res, false);
  14359. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14360. }
  14361. if (!status_line_read) {
  14362. // No interim response within the timeout: send the body and handle the
  14363. // response as usual.
  14364. if (!write_request_body(strm, req, error)) { return false; }
  14365. expect_100_continue = false; // Switch to normal response handling
  14366. }
  14367. }
  14368. // Receive response and headers
  14369. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14370. if ((!status_line_read &&
  14371. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14372. !detail::read_headers(strm, res.headers)) {
  14373. if (write_request_success) { error = Error::Read; }
  14374. output_error_log(error, &req);
  14375. return false;
  14376. }
  14377. if (!write_request_success) { return false; }
  14378. // Handle Expect: 100-continue response
  14379. if (expect_100_continue) {
  14380. if (res.status == StatusCode::Continue_100) {
  14381. // Server accepted, send the body
  14382. if (!write_request_body(strm, req, error)) { return false; }
  14383. // Read the actual response
  14384. res.headers.clear();
  14385. res.body.clear();
  14386. if (!read_response_line(strm, req, res) ||
  14387. !detail::read_headers(strm, res.headers)) {
  14388. error = Error::Read;
  14389. output_error_log(error, &req);
  14390. return false;
  14391. }
  14392. } else {
  14393. // A final response came first, so the body this request declared was
  14394. // never sent, and the server may still be waiting for it. The
  14395. // connection cannot carry another request.
  14396. std::lock_guard<std::mutex> guard(socket_mutex_);
  14397. socket_should_be_closed_when_request_is_done_ = true;
  14398. }
  14399. }
  14400. // Body
  14401. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14402. req.method != "CONNECT") {
  14403. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14404. // whose final transfer coding is not chunked is not ambiguous: its body
  14405. // runs until the server closes the connection, so it is not rejected.
  14406. // HEAD/204 are excluded above and a 304 carries no body.
  14407. if (res.status != StatusCode::NotModified_304) {
  14408. if (detail::has_conflicting_content_length(res.headers)) {
  14409. error = Error::Read;
  14410. output_error_log(error, &req);
  14411. return false;
  14412. }
  14413. if (detail::has_faulty_transfer_encoding(res)) {
  14414. std::lock_guard<std::mutex> guard(socket_mutex_);
  14415. socket_should_be_closed_when_request_is_done_ = true;
  14416. }
  14417. }
  14418. auto redirect = follow_location_ && detail::is_redirect(res) &&
  14419. res.status != StatusCode::NotModified_304;
  14420. if (req.response_handler && !redirect) {
  14421. if (!req.response_handler(res)) {
  14422. error = Error::Canceled;
  14423. output_error_log(error, &req);
  14424. return false;
  14425. }
  14426. }
  14427. auto out =
  14428. req.content_receiver
  14429. ? static_cast<ContentReceiverWithProgress>(
  14430. [&](const char *buf, size_t n, size_t off, size_t len) {
  14431. if (redirect) { return true; }
  14432. auto ret = req.content_receiver(buf, n, off, len);
  14433. if (!ret) {
  14434. error = Error::Canceled;
  14435. output_error_log(error, &req);
  14436. }
  14437. return ret;
  14438. })
  14439. : static_cast<ContentReceiverWithProgress>(
  14440. [&](const char *buf, size_t n, size_t /*off*/,
  14441. size_t /*len*/) {
  14442. assert(res.body.size() + n <= res.body.max_size());
  14443. if (payload_max_length_ > 0 &&
  14444. (res.body.size() >= payload_max_length_ ||
  14445. n > payload_max_length_ - res.body.size())) {
  14446. return false;
  14447. }
  14448. res.body.append(buf, n);
  14449. return true;
  14450. });
  14451. auto progress = [&](size_t current, size_t total) {
  14452. if (!req.download_progress || redirect) { return true; }
  14453. auto ret = req.download_progress(current, total);
  14454. if (!ret) {
  14455. error = Error::Canceled;
  14456. output_error_log(error, &req);
  14457. }
  14458. return ret;
  14459. };
  14460. if (res.has_header("Content-Length")) {
  14461. if (!req.content_receiver) {
  14462. auto len = res.get_header_value_u64("Content-Length");
  14463. if (len > res.body.max_size()) {
  14464. error = Error::Read;
  14465. output_error_log(error, &req);
  14466. return false;
  14467. }
  14468. // Content-Length is only the server's claim, so reserve no more than
  14469. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14470. // body has arrived. A longer body grows as it is read.
  14471. auto reserve_len =
  14472. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14473. if (payload_max_length_ > 0) {
  14474. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14475. }
  14476. res.body.reserve(reserve_len);
  14477. }
  14478. }
  14479. if (res.status != StatusCode::NotModified_304) {
  14480. auto content_status = 0;
  14481. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14482. ? (std::numeric_limits<size_t>::max)()
  14483. : payload_max_length_;
  14484. if (!detail::read_content(strm, res, max_length, content_status,
  14485. std::move(progress), std::move(out),
  14486. decompress_)) {
  14487. if (error != Error::Canceled) {
  14488. // Tell the caller apart from a plain read failure when the body could
  14489. // not be decoded because of its Content-Encoding.
  14490. switch (content_status) {
  14491. case StatusCode::UnsupportedMediaType_415:
  14492. error = Error::UnsupportedContentEncoding;
  14493. break;
  14494. case StatusCode::InternalServerError_500:
  14495. error = Error::Compression;
  14496. break;
  14497. default: error = Error::Read; break;
  14498. }
  14499. }
  14500. output_error_log(error, &req);
  14501. return false;
  14502. }
  14503. }
  14504. }
  14505. // Log
  14506. output_log(req, res);
  14507. return true;
  14508. }
  14509. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14510. const std::string &boundary, const UploadFormDataItems &items,
  14511. const FormDataProviderItems &provider_items) const {
  14512. size_t cur_item = 0;
  14513. size_t cur_start = 0;
  14514. // cur_item and cur_start are copied to within the std::function and
  14515. // maintain state between successive calls
  14516. return [&, cur_item, cur_start](size_t offset,
  14517. DataSink &sink) mutable -> bool {
  14518. if (!offset && !items.empty()) {
  14519. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14520. return true;
  14521. } else if (cur_item < provider_items.size()) {
  14522. if (!cur_start) {
  14523. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14524. provider_items[cur_item], boundary);
  14525. offset += begin.size();
  14526. cur_start = offset;
  14527. sink.os << begin;
  14528. }
  14529. DataSink cur_sink;
  14530. auto has_data = true;
  14531. cur_sink.write = sink.write;
  14532. // Forward is_writable so a provider item asking whether it may keep
  14533. // going gets the outer sink's answer rather than the default `true`.
  14534. cur_sink.is_writable = sink.is_writable;
  14535. cur_sink.done = [&]() { has_data = false; };
  14536. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14537. return false;
  14538. }
  14539. if (!has_data) {
  14540. sink.os << detail::serialize_multipart_formdata_item_end();
  14541. cur_item++;
  14542. cur_start = 0;
  14543. }
  14544. return true;
  14545. } else {
  14546. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14547. sink.done();
  14548. return true;
  14549. }
  14550. };
  14551. }
  14552. inline bool ClientImpl::process_socket(
  14553. const Socket &socket,
  14554. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14555. std::function<bool(Stream &strm)> callback) {
  14556. return detail::process_client_socket(
  14557. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14558. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14559. }
  14560. inline bool ClientImpl::is_ssl() const { return false; }
  14561. inline Result ClientImpl::Get(const std::string &path,
  14562. DownloadProgress progress) {
  14563. return Get(path, Headers(), std::move(progress));
  14564. }
  14565. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14566. DownloadProgress progress) {
  14567. return Get(path, params, Headers(), std::move(progress));
  14568. }
  14569. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14570. const Headers &headers,
  14571. DownloadProgress progress) {
  14572. if (params.empty()) { return Get(path, headers); }
  14573. std::string path_with_query = append_query_params(path, params);
  14574. return Get(path_with_query, headers, std::move(progress));
  14575. }
  14576. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14577. DownloadProgress progress) {
  14578. Request req;
  14579. req.method = "GET";
  14580. req.path = path;
  14581. req.headers = headers;
  14582. req.download_progress = std::move(progress);
  14583. if (max_timeout_msec_ > 0) {
  14584. req.start_time_ = std::chrono::steady_clock::now();
  14585. }
  14586. return send_(std::move(req));
  14587. }
  14588. inline Result ClientImpl::Get(const std::string &path,
  14589. ContentReceiver content_receiver,
  14590. DownloadProgress progress) {
  14591. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14592. std::move(progress));
  14593. }
  14594. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14595. ContentReceiver content_receiver,
  14596. DownloadProgress progress) {
  14597. return Get(path, headers, nullptr, std::move(content_receiver),
  14598. std::move(progress));
  14599. }
  14600. inline Result ClientImpl::Get(const std::string &path,
  14601. ResponseHandler response_handler,
  14602. ContentReceiver content_receiver,
  14603. DownloadProgress progress) {
  14604. return Get(path, Headers(), std::move(response_handler),
  14605. std::move(content_receiver), std::move(progress));
  14606. }
  14607. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14608. ResponseHandler response_handler,
  14609. ContentReceiver content_receiver,
  14610. DownloadProgress progress) {
  14611. Request req;
  14612. req.method = "GET";
  14613. req.path = path;
  14614. req.headers = headers;
  14615. req.response_handler = std::move(response_handler);
  14616. req.content_receiver =
  14617. [content_receiver](const char *data, size_t data_length,
  14618. size_t /*offset*/, size_t /*total_length*/) {
  14619. return content_receiver(data, data_length);
  14620. };
  14621. req.download_progress = std::move(progress);
  14622. if (max_timeout_msec_ > 0) {
  14623. req.start_time_ = std::chrono::steady_clock::now();
  14624. }
  14625. return send_(std::move(req));
  14626. }
  14627. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14628. const Headers &headers,
  14629. ContentReceiver content_receiver,
  14630. DownloadProgress progress) {
  14631. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14632. std::move(progress));
  14633. }
  14634. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14635. const Headers &headers,
  14636. ResponseHandler response_handler,
  14637. ContentReceiver content_receiver,
  14638. DownloadProgress progress) {
  14639. if (params.empty()) {
  14640. return Get(path, headers, std::move(response_handler),
  14641. std::move(content_receiver), std::move(progress));
  14642. }
  14643. std::string path_with_query = append_query_params(path, params);
  14644. return Get(path_with_query, headers, std::move(response_handler),
  14645. std::move(content_receiver), std::move(progress));
  14646. }
  14647. inline Result ClientImpl::Head(const std::string &path) {
  14648. return Head(path, Headers());
  14649. }
  14650. inline Result ClientImpl::Head(const std::string &path,
  14651. const Headers &headers) {
  14652. Request req;
  14653. req.method = "HEAD";
  14654. req.headers = headers;
  14655. req.path = path;
  14656. if (max_timeout_msec_ > 0) {
  14657. req.start_time_ = std::chrono::steady_clock::now();
  14658. }
  14659. return send_(std::move(req));
  14660. }
  14661. inline Result ClientImpl::Post(const std::string &path) {
  14662. return Post(path, std::string(), std::string());
  14663. }
  14664. inline Result ClientImpl::Post(const std::string &path,
  14665. const Headers &headers) {
  14666. return Post(path, headers, nullptr, 0, std::string());
  14667. }
  14668. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14669. size_t content_length,
  14670. const std::string &content_type,
  14671. UploadProgress progress) {
  14672. return Post(path, Headers(), body, content_length, content_type, progress);
  14673. }
  14674. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14675. const std::string &content_type,
  14676. UploadProgress progress) {
  14677. return Post(path, Headers(), body, content_type, progress);
  14678. }
  14679. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14680. return Post(path, Headers(), params);
  14681. }
  14682. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14683. ContentProvider content_provider,
  14684. const std::string &content_type,
  14685. UploadProgress progress) {
  14686. return Post(path, Headers(), content_length, std::move(content_provider),
  14687. content_type, progress);
  14688. }
  14689. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14690. ContentProvider content_provider,
  14691. const std::string &content_type,
  14692. ContentReceiver content_receiver,
  14693. UploadProgress progress) {
  14694. return Post(path, Headers(), content_length, std::move(content_provider),
  14695. content_type, std::move(content_receiver), progress);
  14696. }
  14697. inline Result ClientImpl::Post(const std::string &path,
  14698. ContentProviderWithoutLength content_provider,
  14699. const std::string &content_type,
  14700. UploadProgress progress) {
  14701. return Post(path, Headers(), std::move(content_provider), content_type,
  14702. progress);
  14703. }
  14704. inline Result ClientImpl::Post(const std::string &path,
  14705. ContentProviderWithoutLength content_provider,
  14706. const std::string &content_type,
  14707. ContentReceiver content_receiver,
  14708. UploadProgress progress) {
  14709. return Post(path, Headers(), std::move(content_provider), content_type,
  14710. std::move(content_receiver), progress);
  14711. }
  14712. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14713. const Params &params) {
  14714. auto query = detail::params_to_query_str(params);
  14715. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14716. }
  14717. inline Result ClientImpl::Post(const std::string &path,
  14718. const UploadFormDataItems &items,
  14719. UploadProgress progress) {
  14720. return Post(path, Headers(), items, progress);
  14721. }
  14722. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14723. const UploadFormDataItems &items,
  14724. UploadProgress progress) {
  14725. const auto &boundary = detail::make_multipart_data_boundary();
  14726. const auto &content_type =
  14727. detail::serialize_multipart_formdata_get_content_type(boundary);
  14728. auto content_length = detail::get_multipart_content_length(items, boundary);
  14729. return Post(path, headers, content_length,
  14730. detail::make_multipart_content_provider(items, boundary),
  14731. content_type, progress);
  14732. }
  14733. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14734. const UploadFormDataItems &items,
  14735. const std::string &boundary,
  14736. UploadProgress progress) {
  14737. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14738. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14739. }
  14740. const auto &content_type =
  14741. detail::serialize_multipart_formdata_get_content_type(boundary);
  14742. auto content_length = detail::get_multipart_content_length(items, boundary);
  14743. return Post(path, headers, content_length,
  14744. detail::make_multipart_content_provider(items, boundary),
  14745. content_type, progress);
  14746. }
  14747. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14748. const char *body, size_t content_length,
  14749. const std::string &content_type,
  14750. UploadProgress progress) {
  14751. return send_with_content_provider_and_receiver(
  14752. "POST", path, headers, body, content_length, nullptr, nullptr,
  14753. content_type, nullptr, progress);
  14754. }
  14755. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14756. const std::string &body,
  14757. const std::string &content_type,
  14758. UploadProgress progress) {
  14759. return send_with_content_provider_and_receiver(
  14760. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14761. content_type, nullptr, progress);
  14762. }
  14763. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14764. size_t content_length,
  14765. ContentProvider content_provider,
  14766. const std::string &content_type,
  14767. UploadProgress progress) {
  14768. return send_with_content_provider_and_receiver(
  14769. "POST", path, headers, nullptr, content_length,
  14770. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14771. }
  14772. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14773. size_t content_length,
  14774. ContentProvider content_provider,
  14775. const std::string &content_type,
  14776. ContentReceiver content_receiver,
  14777. DownloadProgress progress) {
  14778. return send_with_content_provider_and_receiver(
  14779. "POST", path, headers, nullptr, content_length,
  14780. std::move(content_provider), nullptr, content_type,
  14781. std::move(content_receiver), std::move(progress));
  14782. }
  14783. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14784. ContentProviderWithoutLength content_provider,
  14785. const std::string &content_type,
  14786. UploadProgress progress) {
  14787. return send_with_content_provider_and_receiver(
  14788. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14789. content_type, nullptr, progress);
  14790. }
  14791. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14792. ContentProviderWithoutLength content_provider,
  14793. const std::string &content_type,
  14794. ContentReceiver content_receiver,
  14795. DownloadProgress progress) {
  14796. return send_with_content_provider_and_receiver(
  14797. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14798. content_type, std::move(content_receiver), std::move(progress));
  14799. }
  14800. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14801. const UploadFormDataItems &items,
  14802. const FormDataProviderItems &provider_items,
  14803. UploadProgress progress) {
  14804. const auto &boundary = detail::make_multipart_data_boundary();
  14805. const auto &content_type =
  14806. detail::serialize_multipart_formdata_get_content_type(boundary);
  14807. return send_with_content_provider_and_receiver(
  14808. "POST", path, headers, nullptr, 0, nullptr,
  14809. get_multipart_content_provider(boundary, items, provider_items),
  14810. content_type, nullptr, progress);
  14811. }
  14812. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14813. const std::string &body,
  14814. const std::string &content_type,
  14815. ContentReceiver content_receiver,
  14816. DownloadProgress progress) {
  14817. Request req;
  14818. req.method = "POST";
  14819. req.path = path;
  14820. req.headers = headers;
  14821. req.body = body;
  14822. req.content_receiver =
  14823. [content_receiver](const char *data, size_t data_length,
  14824. size_t /*offset*/, size_t /*total_length*/) {
  14825. return content_receiver(data, data_length);
  14826. };
  14827. req.download_progress = std::move(progress);
  14828. if (max_timeout_msec_ > 0) {
  14829. req.start_time_ = std::chrono::steady_clock::now();
  14830. }
  14831. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14832. return send_(std::move(req));
  14833. }
  14834. inline Result ClientImpl::Put(const std::string &path) {
  14835. return Put(path, std::string(), std::string());
  14836. }
  14837. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14838. return Put(path, headers, nullptr, 0, std::string());
  14839. }
  14840. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14841. size_t content_length,
  14842. const std::string &content_type,
  14843. UploadProgress progress) {
  14844. return Put(path, Headers(), body, content_length, content_type, progress);
  14845. }
  14846. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14847. const std::string &content_type,
  14848. UploadProgress progress) {
  14849. return Put(path, Headers(), body, content_type, progress);
  14850. }
  14851. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14852. return Put(path, Headers(), params);
  14853. }
  14854. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14855. ContentProvider content_provider,
  14856. const std::string &content_type,
  14857. UploadProgress progress) {
  14858. return Put(path, Headers(), content_length, std::move(content_provider),
  14859. content_type, progress);
  14860. }
  14861. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14862. ContentProvider content_provider,
  14863. const std::string &content_type,
  14864. ContentReceiver content_receiver,
  14865. UploadProgress progress) {
  14866. return Put(path, Headers(), content_length, std::move(content_provider),
  14867. content_type, std::move(content_receiver), progress);
  14868. }
  14869. inline Result ClientImpl::Put(const std::string &path,
  14870. ContentProviderWithoutLength content_provider,
  14871. const std::string &content_type,
  14872. UploadProgress progress) {
  14873. return Put(path, Headers(), std::move(content_provider), content_type,
  14874. progress);
  14875. }
  14876. inline Result ClientImpl::Put(const std::string &path,
  14877. ContentProviderWithoutLength content_provider,
  14878. const std::string &content_type,
  14879. ContentReceiver content_receiver,
  14880. UploadProgress progress) {
  14881. return Put(path, Headers(), std::move(content_provider), content_type,
  14882. std::move(content_receiver), progress);
  14883. }
  14884. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14885. const Params &params) {
  14886. auto query = detail::params_to_query_str(params);
  14887. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14888. }
  14889. inline Result ClientImpl::Put(const std::string &path,
  14890. const UploadFormDataItems &items,
  14891. UploadProgress progress) {
  14892. return Put(path, Headers(), items, progress);
  14893. }
  14894. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14895. const UploadFormDataItems &items,
  14896. UploadProgress progress) {
  14897. const auto &boundary = detail::make_multipart_data_boundary();
  14898. const auto &content_type =
  14899. detail::serialize_multipart_formdata_get_content_type(boundary);
  14900. auto content_length = detail::get_multipart_content_length(items, boundary);
  14901. return Put(path, headers, content_length,
  14902. detail::make_multipart_content_provider(items, boundary),
  14903. content_type, progress);
  14904. }
  14905. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14906. const UploadFormDataItems &items,
  14907. const std::string &boundary,
  14908. UploadProgress progress) {
  14909. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14910. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14911. }
  14912. const auto &content_type =
  14913. detail::serialize_multipart_formdata_get_content_type(boundary);
  14914. auto content_length = detail::get_multipart_content_length(items, boundary);
  14915. return Put(path, headers, content_length,
  14916. detail::make_multipart_content_provider(items, boundary),
  14917. content_type, progress);
  14918. }
  14919. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14920. const char *body, size_t content_length,
  14921. const std::string &content_type,
  14922. UploadProgress progress) {
  14923. return send_with_content_provider_and_receiver(
  14924. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14925. content_type, nullptr, progress);
  14926. }
  14927. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14928. const std::string &body,
  14929. const std::string &content_type,
  14930. UploadProgress progress) {
  14931. return send_with_content_provider_and_receiver(
  14932. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14933. content_type, nullptr, progress);
  14934. }
  14935. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14936. size_t content_length,
  14937. ContentProvider content_provider,
  14938. const std::string &content_type,
  14939. UploadProgress progress) {
  14940. return send_with_content_provider_and_receiver(
  14941. "PUT", path, headers, nullptr, content_length,
  14942. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14943. }
  14944. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14945. size_t content_length,
  14946. ContentProvider content_provider,
  14947. const std::string &content_type,
  14948. ContentReceiver content_receiver,
  14949. UploadProgress progress) {
  14950. return send_with_content_provider_and_receiver(
  14951. "PUT", path, headers, nullptr, content_length,
  14952. std::move(content_provider), nullptr, content_type,
  14953. std::move(content_receiver), progress);
  14954. }
  14955. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14956. ContentProviderWithoutLength content_provider,
  14957. const std::string &content_type,
  14958. UploadProgress progress) {
  14959. return send_with_content_provider_and_receiver(
  14960. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14961. content_type, nullptr, progress);
  14962. }
  14963. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14964. ContentProviderWithoutLength content_provider,
  14965. const std::string &content_type,
  14966. ContentReceiver content_receiver,
  14967. UploadProgress progress) {
  14968. return send_with_content_provider_and_receiver(
  14969. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14970. content_type, std::move(content_receiver), progress);
  14971. }
  14972. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14973. const UploadFormDataItems &items,
  14974. const FormDataProviderItems &provider_items,
  14975. UploadProgress progress) {
  14976. const auto &boundary = detail::make_multipart_data_boundary();
  14977. const auto &content_type =
  14978. detail::serialize_multipart_formdata_get_content_type(boundary);
  14979. return send_with_content_provider_and_receiver(
  14980. "PUT", path, headers, nullptr, 0, nullptr,
  14981. get_multipart_content_provider(boundary, items, provider_items),
  14982. content_type, nullptr, progress);
  14983. }
  14984. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14985. const std::string &body,
  14986. const std::string &content_type,
  14987. ContentReceiver content_receiver,
  14988. DownloadProgress progress) {
  14989. Request req;
  14990. req.method = "PUT";
  14991. req.path = path;
  14992. req.headers = headers;
  14993. req.body = body;
  14994. req.content_receiver =
  14995. [content_receiver](const char *data, size_t data_length,
  14996. size_t /*offset*/, size_t /*total_length*/) {
  14997. return content_receiver(data, data_length);
  14998. };
  14999. req.download_progress = std::move(progress);
  15000. if (max_timeout_msec_ > 0) {
  15001. req.start_time_ = std::chrono::steady_clock::now();
  15002. }
  15003. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15004. return send_(std::move(req));
  15005. }
  15006. inline Result ClientImpl::Patch(const std::string &path) {
  15007. return Patch(path, std::string(), std::string());
  15008. }
  15009. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15010. UploadProgress progress) {
  15011. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15012. }
  15013. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15014. size_t content_length,
  15015. const std::string &content_type,
  15016. UploadProgress progress) {
  15017. return Patch(path, Headers(), body, content_length, content_type, progress);
  15018. }
  15019. inline Result ClientImpl::Patch(const std::string &path,
  15020. const std::string &body,
  15021. const std::string &content_type,
  15022. UploadProgress progress) {
  15023. return Patch(path, Headers(), body, content_type, progress);
  15024. }
  15025. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15026. return Patch(path, Headers(), params);
  15027. }
  15028. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15029. ContentProvider content_provider,
  15030. const std::string &content_type,
  15031. UploadProgress progress) {
  15032. return Patch(path, Headers(), content_length, std::move(content_provider),
  15033. content_type, progress);
  15034. }
  15035. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15036. ContentProvider content_provider,
  15037. const std::string &content_type,
  15038. ContentReceiver content_receiver,
  15039. UploadProgress progress) {
  15040. return Patch(path, Headers(), content_length, std::move(content_provider),
  15041. content_type, std::move(content_receiver), progress);
  15042. }
  15043. inline Result ClientImpl::Patch(const std::string &path,
  15044. ContentProviderWithoutLength content_provider,
  15045. const std::string &content_type,
  15046. UploadProgress progress) {
  15047. return Patch(path, Headers(), std::move(content_provider), content_type,
  15048. progress);
  15049. }
  15050. inline Result ClientImpl::Patch(const std::string &path,
  15051. ContentProviderWithoutLength content_provider,
  15052. const std::string &content_type,
  15053. ContentReceiver content_receiver,
  15054. UploadProgress progress) {
  15055. return Patch(path, Headers(), std::move(content_provider), content_type,
  15056. std::move(content_receiver), progress);
  15057. }
  15058. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15059. const Params &params) {
  15060. auto query = detail::params_to_query_str(params);
  15061. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15062. }
  15063. inline Result ClientImpl::Patch(const std::string &path,
  15064. const UploadFormDataItems &items,
  15065. UploadProgress progress) {
  15066. return Patch(path, Headers(), items, progress);
  15067. }
  15068. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15069. const UploadFormDataItems &items,
  15070. UploadProgress progress) {
  15071. const auto &boundary = detail::make_multipart_data_boundary();
  15072. const auto &content_type =
  15073. detail::serialize_multipart_formdata_get_content_type(boundary);
  15074. auto content_length = detail::get_multipart_content_length(items, boundary);
  15075. return Patch(path, headers, content_length,
  15076. detail::make_multipart_content_provider(items, boundary),
  15077. content_type, progress);
  15078. }
  15079. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15080. const UploadFormDataItems &items,
  15081. const std::string &boundary,
  15082. UploadProgress progress) {
  15083. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15084. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15085. }
  15086. const auto &content_type =
  15087. detail::serialize_multipart_formdata_get_content_type(boundary);
  15088. auto content_length = detail::get_multipart_content_length(items, boundary);
  15089. return Patch(path, headers, content_length,
  15090. detail::make_multipart_content_provider(items, boundary),
  15091. content_type, progress);
  15092. }
  15093. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15094. const char *body, size_t content_length,
  15095. const std::string &content_type,
  15096. UploadProgress progress) {
  15097. return send_with_content_provider_and_receiver(
  15098. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15099. content_type, nullptr, progress);
  15100. }
  15101. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15102. const std::string &body,
  15103. const std::string &content_type,
  15104. UploadProgress progress) {
  15105. return send_with_content_provider_and_receiver(
  15106. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15107. content_type, nullptr, progress);
  15108. }
  15109. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15110. size_t content_length,
  15111. ContentProvider content_provider,
  15112. const std::string &content_type,
  15113. UploadProgress progress) {
  15114. return send_with_content_provider_and_receiver(
  15115. "PATCH", path, headers, nullptr, content_length,
  15116. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15117. }
  15118. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15119. size_t content_length,
  15120. ContentProvider content_provider,
  15121. const std::string &content_type,
  15122. ContentReceiver content_receiver,
  15123. UploadProgress progress) {
  15124. return send_with_content_provider_and_receiver(
  15125. "PATCH", path, headers, nullptr, content_length,
  15126. std::move(content_provider), nullptr, content_type,
  15127. std::move(content_receiver), progress);
  15128. }
  15129. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15130. ContentProviderWithoutLength content_provider,
  15131. const std::string &content_type,
  15132. UploadProgress progress) {
  15133. return send_with_content_provider_and_receiver(
  15134. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15135. content_type, nullptr, progress);
  15136. }
  15137. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15138. ContentProviderWithoutLength content_provider,
  15139. const std::string &content_type,
  15140. ContentReceiver content_receiver,
  15141. UploadProgress progress) {
  15142. return send_with_content_provider_and_receiver(
  15143. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15144. content_type, std::move(content_receiver), progress);
  15145. }
  15146. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15147. const UploadFormDataItems &items,
  15148. const FormDataProviderItems &provider_items,
  15149. UploadProgress progress) {
  15150. const auto &boundary = detail::make_multipart_data_boundary();
  15151. const auto &content_type =
  15152. detail::serialize_multipart_formdata_get_content_type(boundary);
  15153. return send_with_content_provider_and_receiver(
  15154. "PATCH", path, headers, nullptr, 0, nullptr,
  15155. get_multipart_content_provider(boundary, items, provider_items),
  15156. content_type, nullptr, progress);
  15157. }
  15158. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15159. const std::string &body,
  15160. const std::string &content_type,
  15161. ContentReceiver content_receiver,
  15162. DownloadProgress progress) {
  15163. Request req;
  15164. req.method = "PATCH";
  15165. req.path = path;
  15166. req.headers = headers;
  15167. req.body = body;
  15168. req.content_receiver =
  15169. [content_receiver](const char *data, size_t data_length,
  15170. size_t /*offset*/, size_t /*total_length*/) {
  15171. return content_receiver(data, data_length);
  15172. };
  15173. req.download_progress = std::move(progress);
  15174. if (max_timeout_msec_ > 0) {
  15175. req.start_time_ = std::chrono::steady_clock::now();
  15176. }
  15177. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15178. return send_(std::move(req));
  15179. }
  15180. inline Result ClientImpl::Delete(const std::string &path,
  15181. DownloadProgress progress) {
  15182. return Delete(path, Headers(), std::string(), std::string(), progress);
  15183. }
  15184. inline Result ClientImpl::Delete(const std::string &path,
  15185. const Headers &headers,
  15186. DownloadProgress progress) {
  15187. return Delete(path, headers, std::string(), std::string(), progress);
  15188. }
  15189. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15190. size_t content_length,
  15191. const std::string &content_type,
  15192. DownloadProgress progress) {
  15193. return Delete(path, Headers(), body, content_length, content_type, progress);
  15194. }
  15195. inline Result ClientImpl::Delete(const std::string &path,
  15196. const std::string &body,
  15197. const std::string &content_type,
  15198. DownloadProgress progress) {
  15199. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15200. progress);
  15201. }
  15202. inline Result ClientImpl::Delete(const std::string &path,
  15203. const Headers &headers,
  15204. const std::string &body,
  15205. const std::string &content_type,
  15206. DownloadProgress progress) {
  15207. return Delete(path, headers, body.data(), body.size(), content_type,
  15208. progress);
  15209. }
  15210. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15211. DownloadProgress progress) {
  15212. return Delete(path, Headers(), params, progress);
  15213. }
  15214. inline Result ClientImpl::Delete(const std::string &path,
  15215. const Headers &headers, const Params &params,
  15216. DownloadProgress progress) {
  15217. auto query = detail::params_to_query_str(params);
  15218. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15219. progress);
  15220. }
  15221. inline Result ClientImpl::Delete(const std::string &path,
  15222. const Headers &headers, const char *body,
  15223. size_t content_length,
  15224. const std::string &content_type,
  15225. DownloadProgress progress) {
  15226. Request req;
  15227. req.method = "DELETE";
  15228. req.headers = headers;
  15229. req.path = path;
  15230. req.download_progress = std::move(progress);
  15231. if (max_timeout_msec_ > 0) {
  15232. req.start_time_ = std::chrono::steady_clock::now();
  15233. }
  15234. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15235. req.body.assign(body, content_length);
  15236. return send_(std::move(req));
  15237. }
  15238. inline Result ClientImpl::Options(const std::string &path) {
  15239. return Options(path, Headers());
  15240. }
  15241. inline Result ClientImpl::Options(const std::string &path,
  15242. const Headers &headers) {
  15243. Request req;
  15244. req.method = "OPTIONS";
  15245. req.headers = headers;
  15246. req.path = path;
  15247. if (max_timeout_msec_ > 0) {
  15248. req.start_time_ = std::chrono::steady_clock::now();
  15249. }
  15250. return send_(std::move(req));
  15251. }
  15252. inline void ClientImpl::stop() {
  15253. std::lock_guard<std::mutex> guard(socket_mutex_);
  15254. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15255. // do is to shutdown_socket, so that threads using this socket suddenly
  15256. // discover they can't read/write any more and error out. Everything else
  15257. // (closing the socket, shutting ssl down) is unsafe because these actions
  15258. // are not thread-safe.
  15259. if (socket_requests_in_flight_ > 0) {
  15260. shutdown_socket(socket_);
  15261. // Aside from that, we set a flag for the socket to be closed when we're
  15262. // done.
  15263. socket_should_be_closed_when_request_is_done_ = true;
  15264. return;
  15265. }
  15266. disconnect(/*gracefully=*/true);
  15267. }
  15268. inline std::string ClientImpl::host() const { return host_; }
  15269. inline int ClientImpl::port() const { return port_; }
  15270. inline size_t ClientImpl::is_socket_open() const {
  15271. std::lock_guard<std::mutex> guard(socket_mutex_);
  15272. return socket_.is_open();
  15273. }
  15274. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15275. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15276. connection_timeout_sec_ = sec;
  15277. connection_timeout_usec_ = usec;
  15278. }
  15279. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15280. read_timeout_sec_ = sec;
  15281. read_timeout_usec_ = usec;
  15282. }
  15283. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15284. write_timeout_sec_ = sec;
  15285. write_timeout_usec_ = usec;
  15286. }
  15287. inline void ClientImpl::set_max_timeout(time_t msec) {
  15288. max_timeout_msec_ = msec;
  15289. }
  15290. inline void ClientImpl::set_basic_auth(const std::string &username,
  15291. const std::string &password) {
  15292. basic_auth_username_ = username;
  15293. basic_auth_password_ = password;
  15294. }
  15295. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15296. bearer_token_auth_token_ = token;
  15297. }
  15298. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15299. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15300. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15301. inline void
  15302. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15303. addr_map_ = std::move(addr_map);
  15304. }
  15305. inline void ClientImpl::set_default_headers(Headers headers) {
  15306. default_headers_ = std::move(headers);
  15307. }
  15308. inline void ClientImpl::set_header_writer(
  15309. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15310. header_writer_ = writer;
  15311. }
  15312. inline void ClientImpl::set_address_family(int family) {
  15313. address_family_ = family;
  15314. }
  15315. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15316. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15317. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15318. socket_options_ = std::move(socket_options);
  15319. }
  15320. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15321. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15322. inline void ClientImpl::set_payload_max_length(size_t length) {
  15323. payload_max_length_ = length;
  15324. has_payload_max_length_ = true;
  15325. }
  15326. inline void ClientImpl::set_interface(const std::string &intf) {
  15327. interface_ = intf;
  15328. }
  15329. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15330. proxy_host_ = host;
  15331. proxy_port_ = port;
  15332. std::lock_guard<std::mutex> guard(socket_mutex_);
  15333. disconnect(/*gracefully=*/true);
  15334. }
  15335. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15336. const std::string &password) {
  15337. proxy_basic_auth_username_ = username;
  15338. proxy_basic_auth_password_ = password;
  15339. }
  15340. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15341. proxy_bearer_token_auth_token_ = token;
  15342. }
  15343. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15344. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15345. std::lock_guard<std::mutex> guard(socket_mutex_);
  15346. disconnect(/*gracefully=*/true);
  15347. }
  15348. #ifdef CPPHTTPLIB_SSL_ENABLED
  15349. inline void ClientImpl::set_digest_auth(const std::string &username,
  15350. const std::string &password) {
  15351. digest_auth_username_ = username;
  15352. digest_auth_password_ = password;
  15353. }
  15354. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15355. const std::string &ca_cert_dir_path) {
  15356. ca_cert_file_path_ = ca_cert_file_path;
  15357. ca_cert_dir_path_ = ca_cert_dir_path;
  15358. }
  15359. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15360. const std::string &password) {
  15361. proxy_digest_auth_username_ = username;
  15362. proxy_digest_auth_password_ = password;
  15363. }
  15364. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15365. server_certificate_verification_ = enabled;
  15366. }
  15367. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15368. server_hostname_verification_ = enabled;
  15369. }
  15370. inline void ClientImpl::enable_system_ca(bool enabled) {
  15371. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15372. }
  15373. #endif
  15374. inline void ClientImpl::set_logger(Logger logger) {
  15375. logger_ = std::move(logger);
  15376. }
  15377. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15378. error_logger_ = std::move(error_logger);
  15379. }
  15380. /*
  15381. * SSL/TLS Common Implementation
  15382. */
  15383. inline ClientConnection::~ClientConnection() {
  15384. #ifdef CPPHTTPLIB_SSL_ENABLED
  15385. if (session) {
  15386. tls::shutdown(session, true);
  15387. tls::free_session(session);
  15388. session = nullptr;
  15389. }
  15390. #endif
  15391. if (sock != INVALID_SOCKET) {
  15392. detail::close_socket(sock);
  15393. sock = INVALID_SOCKET;
  15394. }
  15395. }
  15396. // Universal client implementation
  15397. inline Client::Client(const std::string &scheme_host_port)
  15398. : Client(scheme_host_port, std::string(), std::string()) {}
  15399. inline Client::Client(const std::string &scheme_host_port,
  15400. const std::string &client_cert_path,
  15401. const std::string &client_key_path) {
  15402. detail::UrlComponents uc;
  15403. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15404. auto &scheme = uc.scheme;
  15405. #ifdef CPPHTTPLIB_SSL_ENABLED
  15406. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15407. #else
  15408. if (!scheme.empty() && scheme != "http") {
  15409. #endif
  15410. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15411. std::string msg = "'" + scheme + "' scheme is not supported.";
  15412. throw std::invalid_argument(msg);
  15413. #endif
  15414. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15415. return;
  15416. }
  15417. auto is_ssl = scheme == "https";
  15418. auto host = std::move(uc.host);
  15419. auto port = is_ssl ? 443 : 80;
  15420. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15421. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15422. return;
  15423. }
  15424. if (is_ssl) {
  15425. #ifdef CPPHTTPLIB_SSL_ENABLED
  15426. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15427. client_key_path);
  15428. is_ssl_ = is_ssl;
  15429. #endif
  15430. } else {
  15431. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15432. client_key_path);
  15433. }
  15434. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15435. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15436. // A URL, but not one this client can use, such as one with userinfo. A
  15437. // Unix socket path may have "//" further on.
  15438. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15439. } else {
  15440. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15441. // if port param below changes.
  15442. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15443. client_cert_path, client_key_path);
  15444. }
  15445. }
  15446. inline Client::Client(const std::string &host, int port)
  15447. : Client(host, port, std::string(), std::string()) {}
  15448. inline Client::Client(const std::string &host, int port,
  15449. const std::string &client_cert_path,
  15450. const std::string &client_key_path)
  15451. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15452. client_key_path)) {}
  15453. inline Client::~Client() = default;
  15454. inline bool Client::is_valid() const {
  15455. return cli_ != nullptr && cli_->is_valid();
  15456. }
  15457. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15458. return cli_->Get(path, std::move(progress));
  15459. }
  15460. inline Result Client::Get(const std::string &path, const Headers &headers,
  15461. DownloadProgress progress) {
  15462. return cli_->Get(path, headers, std::move(progress));
  15463. }
  15464. inline Result Client::Get(const std::string &path,
  15465. ContentReceiver content_receiver,
  15466. DownloadProgress progress) {
  15467. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15468. }
  15469. inline Result Client::Get(const std::string &path, const Headers &headers,
  15470. ContentReceiver content_receiver,
  15471. DownloadProgress progress) {
  15472. return cli_->Get(path, headers, std::move(content_receiver),
  15473. std::move(progress));
  15474. }
  15475. inline Result Client::Get(const std::string &path,
  15476. ResponseHandler response_handler,
  15477. ContentReceiver content_receiver,
  15478. DownloadProgress progress) {
  15479. return cli_->Get(path, std::move(response_handler),
  15480. std::move(content_receiver), std::move(progress));
  15481. }
  15482. inline Result Client::Get(const std::string &path, const Headers &headers,
  15483. ResponseHandler response_handler,
  15484. ContentReceiver content_receiver,
  15485. DownloadProgress progress) {
  15486. return cli_->Get(path, headers, std::move(response_handler),
  15487. std::move(content_receiver), std::move(progress));
  15488. }
  15489. inline Result Client::Get(const std::string &path, const Params &params,
  15490. DownloadProgress progress) {
  15491. return cli_->Get(path, params, std::move(progress));
  15492. }
  15493. inline Result Client::Get(const std::string &path, const Params &params,
  15494. const Headers &headers, DownloadProgress progress) {
  15495. return cli_->Get(path, params, headers, std::move(progress));
  15496. }
  15497. inline Result Client::Get(const std::string &path, const Params &params,
  15498. const Headers &headers,
  15499. ContentReceiver content_receiver,
  15500. DownloadProgress progress) {
  15501. return cli_->Get(path, params, headers, std::move(content_receiver),
  15502. std::move(progress));
  15503. }
  15504. inline Result Client::Get(const std::string &path, const Params &params,
  15505. const Headers &headers,
  15506. ResponseHandler response_handler,
  15507. ContentReceiver content_receiver,
  15508. DownloadProgress progress) {
  15509. return cli_->Get(path, params, headers, std::move(response_handler),
  15510. std::move(content_receiver), std::move(progress));
  15511. }
  15512. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15513. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15514. return cli_->Head(path, headers);
  15515. }
  15516. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15517. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15518. return cli_->Post(path, headers);
  15519. }
  15520. inline Result Client::Post(const std::string &path, const char *body,
  15521. size_t content_length,
  15522. const std::string &content_type,
  15523. UploadProgress progress) {
  15524. return cli_->Post(path, body, content_length, content_type, progress);
  15525. }
  15526. inline Result Client::Post(const std::string &path, const Headers &headers,
  15527. const char *body, size_t content_length,
  15528. const std::string &content_type,
  15529. UploadProgress progress) {
  15530. return cli_->Post(path, headers, body, content_length, content_type,
  15531. progress);
  15532. }
  15533. inline Result Client::Post(const std::string &path, const std::string &body,
  15534. const std::string &content_type,
  15535. UploadProgress progress) {
  15536. return cli_->Post(path, body, content_type, progress);
  15537. }
  15538. inline Result Client::Post(const std::string &path, const Headers &headers,
  15539. const std::string &body,
  15540. const std::string &content_type,
  15541. UploadProgress progress) {
  15542. return cli_->Post(path, headers, body, content_type, progress);
  15543. }
  15544. inline Result Client::Post(const std::string &path, size_t content_length,
  15545. ContentProvider content_provider,
  15546. const std::string &content_type,
  15547. UploadProgress progress) {
  15548. return cli_->Post(path, content_length, std::move(content_provider),
  15549. content_type, progress);
  15550. }
  15551. inline Result Client::Post(const std::string &path, size_t content_length,
  15552. ContentProvider content_provider,
  15553. const std::string &content_type,
  15554. ContentReceiver content_receiver,
  15555. UploadProgress progress) {
  15556. return cli_->Post(path, content_length, std::move(content_provider),
  15557. content_type, std::move(content_receiver), progress);
  15558. }
  15559. inline Result Client::Post(const std::string &path,
  15560. ContentProviderWithoutLength content_provider,
  15561. const std::string &content_type,
  15562. UploadProgress progress) {
  15563. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15564. }
  15565. inline Result Client::Post(const std::string &path,
  15566. ContentProviderWithoutLength content_provider,
  15567. const std::string &content_type,
  15568. ContentReceiver content_receiver,
  15569. UploadProgress progress) {
  15570. return cli_->Post(path, std::move(content_provider), content_type,
  15571. std::move(content_receiver), progress);
  15572. }
  15573. inline Result Client::Post(const std::string &path, const Headers &headers,
  15574. size_t content_length,
  15575. ContentProvider content_provider,
  15576. const std::string &content_type,
  15577. UploadProgress progress) {
  15578. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15579. content_type, progress);
  15580. }
  15581. inline Result Client::Post(const std::string &path, const Headers &headers,
  15582. size_t content_length,
  15583. ContentProvider content_provider,
  15584. const std::string &content_type,
  15585. ContentReceiver content_receiver,
  15586. DownloadProgress progress) {
  15587. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15588. content_type, std::move(content_receiver), progress);
  15589. }
  15590. inline Result Client::Post(const std::string &path, const Headers &headers,
  15591. ContentProviderWithoutLength content_provider,
  15592. const std::string &content_type,
  15593. UploadProgress progress) {
  15594. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15595. progress);
  15596. }
  15597. inline Result Client::Post(const std::string &path, const Headers &headers,
  15598. ContentProviderWithoutLength content_provider,
  15599. const std::string &content_type,
  15600. ContentReceiver content_receiver,
  15601. DownloadProgress progress) {
  15602. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15603. std::move(content_receiver), progress);
  15604. }
  15605. inline Result Client::Post(const std::string &path, const Params &params) {
  15606. return cli_->Post(path, params);
  15607. }
  15608. inline Result Client::Post(const std::string &path, const Headers &headers,
  15609. const Params &params) {
  15610. return cli_->Post(path, headers, params);
  15611. }
  15612. inline Result Client::Post(const std::string &path,
  15613. const UploadFormDataItems &items,
  15614. UploadProgress progress) {
  15615. return cli_->Post(path, items, progress);
  15616. }
  15617. inline Result Client::Post(const std::string &path, const Headers &headers,
  15618. const UploadFormDataItems &items,
  15619. UploadProgress progress) {
  15620. return cli_->Post(path, headers, items, progress);
  15621. }
  15622. inline Result Client::Post(const std::string &path, const Headers &headers,
  15623. const UploadFormDataItems &items,
  15624. const std::string &boundary,
  15625. UploadProgress progress) {
  15626. return cli_->Post(path, headers, items, boundary, progress);
  15627. }
  15628. inline Result Client::Post(const std::string &path, const Headers &headers,
  15629. const UploadFormDataItems &items,
  15630. const FormDataProviderItems &provider_items,
  15631. UploadProgress progress) {
  15632. return cli_->Post(path, headers, items, provider_items, progress);
  15633. }
  15634. inline Result Client::Post(const std::string &path, const Headers &headers,
  15635. const std::string &body,
  15636. const std::string &content_type,
  15637. ContentReceiver content_receiver,
  15638. DownloadProgress progress) {
  15639. return cli_->Post(path, headers, body, content_type,
  15640. std::move(content_receiver), progress);
  15641. }
  15642. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15643. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15644. return cli_->Put(path, headers);
  15645. }
  15646. inline Result Client::Put(const std::string &path, const char *body,
  15647. size_t content_length,
  15648. const std::string &content_type,
  15649. UploadProgress progress) {
  15650. return cli_->Put(path, body, content_length, content_type, progress);
  15651. }
  15652. inline Result Client::Put(const std::string &path, const Headers &headers,
  15653. const char *body, size_t content_length,
  15654. const std::string &content_type,
  15655. UploadProgress progress) {
  15656. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15657. }
  15658. inline Result Client::Put(const std::string &path, const std::string &body,
  15659. const std::string &content_type,
  15660. UploadProgress progress) {
  15661. return cli_->Put(path, body, content_type, progress);
  15662. }
  15663. inline Result Client::Put(const std::string &path, const Headers &headers,
  15664. const std::string &body,
  15665. const std::string &content_type,
  15666. UploadProgress progress) {
  15667. return cli_->Put(path, headers, body, content_type, progress);
  15668. }
  15669. inline Result Client::Put(const std::string &path, size_t content_length,
  15670. ContentProvider content_provider,
  15671. const std::string &content_type,
  15672. UploadProgress progress) {
  15673. return cli_->Put(path, content_length, std::move(content_provider),
  15674. content_type, progress);
  15675. }
  15676. inline Result Client::Put(const std::string &path, size_t content_length,
  15677. ContentProvider content_provider,
  15678. const std::string &content_type,
  15679. ContentReceiver content_receiver,
  15680. UploadProgress progress) {
  15681. return cli_->Put(path, content_length, std::move(content_provider),
  15682. content_type, std::move(content_receiver), progress);
  15683. }
  15684. inline Result Client::Put(const std::string &path,
  15685. ContentProviderWithoutLength content_provider,
  15686. const std::string &content_type,
  15687. UploadProgress progress) {
  15688. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15689. }
  15690. inline Result Client::Put(const std::string &path,
  15691. ContentProviderWithoutLength content_provider,
  15692. const std::string &content_type,
  15693. ContentReceiver content_receiver,
  15694. UploadProgress progress) {
  15695. return cli_->Put(path, std::move(content_provider), content_type,
  15696. std::move(content_receiver), progress);
  15697. }
  15698. inline Result Client::Put(const std::string &path, const Headers &headers,
  15699. size_t content_length,
  15700. ContentProvider content_provider,
  15701. const std::string &content_type,
  15702. UploadProgress progress) {
  15703. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15704. content_type, progress);
  15705. }
  15706. inline Result Client::Put(const std::string &path, const Headers &headers,
  15707. size_t content_length,
  15708. ContentProvider content_provider,
  15709. const std::string &content_type,
  15710. ContentReceiver content_receiver,
  15711. UploadProgress progress) {
  15712. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15713. content_type, std::move(content_receiver), progress);
  15714. }
  15715. inline Result Client::Put(const std::string &path, const Headers &headers,
  15716. ContentProviderWithoutLength content_provider,
  15717. const std::string &content_type,
  15718. UploadProgress progress) {
  15719. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15720. progress);
  15721. }
  15722. inline Result Client::Put(const std::string &path, const Headers &headers,
  15723. ContentProviderWithoutLength content_provider,
  15724. const std::string &content_type,
  15725. ContentReceiver content_receiver,
  15726. UploadProgress progress) {
  15727. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15728. std::move(content_receiver), progress);
  15729. }
  15730. inline Result Client::Put(const std::string &path, const Params &params) {
  15731. return cli_->Put(path, params);
  15732. }
  15733. inline Result Client::Put(const std::string &path, const Headers &headers,
  15734. const Params &params) {
  15735. return cli_->Put(path, headers, params);
  15736. }
  15737. inline Result Client::Put(const std::string &path,
  15738. const UploadFormDataItems &items,
  15739. UploadProgress progress) {
  15740. return cli_->Put(path, items, progress);
  15741. }
  15742. inline Result Client::Put(const std::string &path, const Headers &headers,
  15743. const UploadFormDataItems &items,
  15744. UploadProgress progress) {
  15745. return cli_->Put(path, headers, items, progress);
  15746. }
  15747. inline Result Client::Put(const std::string &path, const Headers &headers,
  15748. const UploadFormDataItems &items,
  15749. const std::string &boundary,
  15750. UploadProgress progress) {
  15751. return cli_->Put(path, headers, items, boundary, progress);
  15752. }
  15753. inline Result Client::Put(const std::string &path, const Headers &headers,
  15754. const UploadFormDataItems &items,
  15755. const FormDataProviderItems &provider_items,
  15756. UploadProgress progress) {
  15757. return cli_->Put(path, headers, items, provider_items, progress);
  15758. }
  15759. inline Result Client::Put(const std::string &path, const Headers &headers,
  15760. const std::string &body,
  15761. const std::string &content_type,
  15762. ContentReceiver content_receiver,
  15763. DownloadProgress progress) {
  15764. return cli_->Put(path, headers, body, content_type, content_receiver,
  15765. progress);
  15766. }
  15767. inline Result Client::Patch(const std::string &path) {
  15768. return cli_->Patch(path);
  15769. }
  15770. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15771. return cli_->Patch(path, headers);
  15772. }
  15773. inline Result Client::Patch(const std::string &path, const char *body,
  15774. size_t content_length,
  15775. const std::string &content_type,
  15776. UploadProgress progress) {
  15777. return cli_->Patch(path, body, content_length, content_type, progress);
  15778. }
  15779. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15780. const char *body, size_t content_length,
  15781. const std::string &content_type,
  15782. UploadProgress progress) {
  15783. return cli_->Patch(path, headers, body, content_length, content_type,
  15784. progress);
  15785. }
  15786. inline Result Client::Patch(const std::string &path, const std::string &body,
  15787. const std::string &content_type,
  15788. UploadProgress progress) {
  15789. return cli_->Patch(path, body, content_type, progress);
  15790. }
  15791. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15792. const std::string &body,
  15793. const std::string &content_type,
  15794. UploadProgress progress) {
  15795. return cli_->Patch(path, headers, body, content_type, progress);
  15796. }
  15797. inline Result Client::Patch(const std::string &path, size_t content_length,
  15798. ContentProvider content_provider,
  15799. const std::string &content_type,
  15800. UploadProgress progress) {
  15801. return cli_->Patch(path, content_length, std::move(content_provider),
  15802. content_type, progress);
  15803. }
  15804. inline Result Client::Patch(const std::string &path, size_t content_length,
  15805. ContentProvider content_provider,
  15806. const std::string &content_type,
  15807. ContentReceiver content_receiver,
  15808. UploadProgress progress) {
  15809. return cli_->Patch(path, content_length, std::move(content_provider),
  15810. content_type, std::move(content_receiver), progress);
  15811. }
  15812. inline Result Client::Patch(const std::string &path,
  15813. ContentProviderWithoutLength content_provider,
  15814. const std::string &content_type,
  15815. UploadProgress progress) {
  15816. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15817. }
  15818. inline Result Client::Patch(const std::string &path,
  15819. ContentProviderWithoutLength content_provider,
  15820. const std::string &content_type,
  15821. ContentReceiver content_receiver,
  15822. UploadProgress progress) {
  15823. return cli_->Patch(path, std::move(content_provider), content_type,
  15824. std::move(content_receiver), progress);
  15825. }
  15826. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15827. size_t content_length,
  15828. ContentProvider content_provider,
  15829. const std::string &content_type,
  15830. UploadProgress progress) {
  15831. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15832. content_type, progress);
  15833. }
  15834. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15835. size_t content_length,
  15836. ContentProvider content_provider,
  15837. const std::string &content_type,
  15838. ContentReceiver content_receiver,
  15839. UploadProgress progress) {
  15840. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15841. content_type, std::move(content_receiver), progress);
  15842. }
  15843. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15844. ContentProviderWithoutLength content_provider,
  15845. const std::string &content_type,
  15846. UploadProgress progress) {
  15847. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15848. progress);
  15849. }
  15850. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15851. ContentProviderWithoutLength content_provider,
  15852. const std::string &content_type,
  15853. ContentReceiver content_receiver,
  15854. UploadProgress progress) {
  15855. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15856. std::move(content_receiver), progress);
  15857. }
  15858. inline Result Client::Patch(const std::string &path, const Params &params) {
  15859. return cli_->Patch(path, params);
  15860. }
  15861. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15862. const Params &params) {
  15863. return cli_->Patch(path, headers, params);
  15864. }
  15865. inline Result Client::Patch(const std::string &path,
  15866. const UploadFormDataItems &items,
  15867. UploadProgress progress) {
  15868. return cli_->Patch(path, items, progress);
  15869. }
  15870. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15871. const UploadFormDataItems &items,
  15872. UploadProgress progress) {
  15873. return cli_->Patch(path, headers, items, progress);
  15874. }
  15875. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15876. const UploadFormDataItems &items,
  15877. const std::string &boundary,
  15878. UploadProgress progress) {
  15879. return cli_->Patch(path, headers, items, boundary, progress);
  15880. }
  15881. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15882. const UploadFormDataItems &items,
  15883. const FormDataProviderItems &provider_items,
  15884. UploadProgress progress) {
  15885. return cli_->Patch(path, headers, items, provider_items, progress);
  15886. }
  15887. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15888. const std::string &body,
  15889. const std::string &content_type,
  15890. ContentReceiver content_receiver,
  15891. DownloadProgress progress) {
  15892. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15893. progress);
  15894. }
  15895. inline Result Client::Delete(const std::string &path,
  15896. DownloadProgress progress) {
  15897. return cli_->Delete(path, progress);
  15898. }
  15899. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15900. DownloadProgress progress) {
  15901. return cli_->Delete(path, headers, progress);
  15902. }
  15903. inline Result Client::Delete(const std::string &path, const char *body,
  15904. size_t content_length,
  15905. const std::string &content_type,
  15906. DownloadProgress progress) {
  15907. return cli_->Delete(path, body, content_length, content_type, progress);
  15908. }
  15909. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15910. const char *body, size_t content_length,
  15911. const std::string &content_type,
  15912. DownloadProgress progress) {
  15913. return cli_->Delete(path, headers, body, content_length, content_type,
  15914. progress);
  15915. }
  15916. inline Result Client::Delete(const std::string &path, const std::string &body,
  15917. const std::string &content_type,
  15918. DownloadProgress progress) {
  15919. return cli_->Delete(path, body, content_type, progress);
  15920. }
  15921. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15922. const std::string &body,
  15923. const std::string &content_type,
  15924. DownloadProgress progress) {
  15925. return cli_->Delete(path, headers, body, content_type, progress);
  15926. }
  15927. inline Result Client::Delete(const std::string &path, const Params &params,
  15928. DownloadProgress progress) {
  15929. return cli_->Delete(path, params, progress);
  15930. }
  15931. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15932. const Params &params, DownloadProgress progress) {
  15933. return cli_->Delete(path, headers, params, progress);
  15934. }
  15935. inline Result Client::Options(const std::string &path) {
  15936. return cli_->Options(path);
  15937. }
  15938. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15939. return cli_->Options(path, headers);
  15940. }
  15941. inline ClientImpl::StreamHandle
  15942. Client::open_stream(const std::string &method, const std::string &path,
  15943. const Params &params, const Headers &headers,
  15944. const std::string &body, const std::string &content_type) {
  15945. return cli_->open_stream(method, path, params, headers, body, content_type);
  15946. }
  15947. inline bool Client::send(Request &req, Response &res, Error &error) {
  15948. return cli_->send(req, res, error);
  15949. }
  15950. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15951. inline void Client::stop() { cli_->stop(); }
  15952. inline std::string Client::host() const { return cli_->host(); }
  15953. inline int Client::port() const { return cli_->port(); }
  15954. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15955. inline socket_t Client::socket() const { return cli_->socket(); }
  15956. inline void
  15957. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15958. cli_->set_hostname_addr_map(std::move(addr_map));
  15959. }
  15960. inline void Client::set_default_headers(Headers headers) {
  15961. cli_->set_default_headers(std::move(headers));
  15962. }
  15963. inline void Client::set_header_writer(
  15964. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15965. cli_->set_header_writer(writer);
  15966. }
  15967. inline void Client::set_address_family(int family) {
  15968. cli_->set_address_family(family);
  15969. }
  15970. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15971. inline void Client::set_socket_options(SocketOptions socket_options) {
  15972. cli_->set_socket_options(std::move(socket_options));
  15973. }
  15974. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15975. cli_->set_connection_timeout(sec, usec);
  15976. }
  15977. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15978. cli_->set_read_timeout(sec, usec);
  15979. }
  15980. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15981. cli_->set_write_timeout(sec, usec);
  15982. }
  15983. inline void Client::set_basic_auth(const std::string &username,
  15984. const std::string &password) {
  15985. cli_->set_basic_auth(username, password);
  15986. }
  15987. inline void Client::set_bearer_token_auth(const std::string &token) {
  15988. cli_->set_bearer_token_auth(token);
  15989. }
  15990. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15991. inline void Client::set_follow_location(bool on) {
  15992. cli_->set_follow_location(on);
  15993. }
  15994. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15995. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15996. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15997. inline void Client::set_payload_max_length(size_t length) {
  15998. cli_->set_payload_max_length(length);
  15999. }
  16000. inline void Client::set_interface(const std::string &intf) {
  16001. cli_->set_interface(intf);
  16002. }
  16003. inline void Client::set_proxy(const std::string &host, int port) {
  16004. cli_->set_proxy(host, port);
  16005. }
  16006. inline void Client::set_proxy_basic_auth(const std::string &username,
  16007. const std::string &password) {
  16008. cli_->set_proxy_basic_auth(username, password);
  16009. }
  16010. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16011. cli_->set_proxy_bearer_token_auth(token);
  16012. }
  16013. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16014. cli_->set_no_proxy(patterns);
  16015. }
  16016. inline void Client::set_logger(Logger logger) {
  16017. cli_->set_logger(std::move(logger));
  16018. }
  16019. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16020. cli_->set_error_logger(std::move(error_logger));
  16021. }
  16022. /*
  16023. * Group 6: SSL Server and Client implementation
  16024. */
  16025. #ifdef CPPHTTPLIB_SSL_ENABLED
  16026. // SSL HTTP server implementation
  16027. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16028. const char *client_ca_cert_file_path,
  16029. const char *client_ca_cert_dir_path,
  16030. const char *private_key_password) {
  16031. using namespace tls;
  16032. ctx_ = create_server_context();
  16033. if (!ctx_) { return; }
  16034. // Load server certificate and private key
  16035. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16036. private_key_password)) {
  16037. last_ssl_error_ = static_cast<int>(get_error());
  16038. free_context(ctx_);
  16039. ctx_ = nullptr;
  16040. return;
  16041. }
  16042. // Load client CA certificates for client authentication
  16043. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16044. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16045. client_ca_cert_dir_path)) {
  16046. last_ssl_error_ = static_cast<int>(get_error());
  16047. free_context(ctx_);
  16048. ctx_ = nullptr;
  16049. return;
  16050. }
  16051. // Enable client certificate verification
  16052. set_verify_client(ctx_, true);
  16053. }
  16054. }
  16055. inline SSLServer::SSLServer(const PemMemory &pem) {
  16056. using namespace tls;
  16057. ctx_ = create_server_context();
  16058. if (ctx_) {
  16059. std::string cert_buf, key_buf;
  16060. if (!set_server_cert_pem(
  16061. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16062. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16063. pem.private_key_password)) {
  16064. last_ssl_error_ = static_cast<int>(get_error());
  16065. free_context(ctx_);
  16066. ctx_ = nullptr;
  16067. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  16068. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  16069. last_ssl_error_ = static_cast<int>(get_error());
  16070. free_context(ctx_);
  16071. ctx_ = nullptr;
  16072. } else {
  16073. set_verify_client(ctx_, true);
  16074. }
  16075. }
  16076. }
  16077. }
  16078. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16079. using namespace tls;
  16080. ctx_ = create_server_context();
  16081. if (ctx_) {
  16082. if (!setup_callback(ctx_)) {
  16083. free_context(ctx_);
  16084. ctx_ = nullptr;
  16085. }
  16086. }
  16087. }
  16088. inline SSLServer::~SSLServer() {
  16089. if (ctx_) { tls::free_context(ctx_); }
  16090. }
  16091. inline bool SSLServer::is_valid() const {
  16092. return ctx_ != nullptr && Server::is_valid();
  16093. }
  16094. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16095. using namespace tls;
  16096. session_t session = nullptr;
  16097. {
  16098. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16099. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16100. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16101. if (session) { handshakes_in_progress_++; }
  16102. }
  16103. if (!session) {
  16104. last_ssl_error_ = static_cast<int>(get_error());
  16105. detail::shutdown_socket(sock);
  16106. detail::close_socket(sock);
  16107. return false;
  16108. }
  16109. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16110. bool handshake_done = false;
  16111. bool ret = false;
  16112. bool websocket_upgraded = false;
  16113. auto cleanup = detail::scope_exit([&] {
  16114. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16115. free_session(session);
  16116. detail::shutdown_socket(sock);
  16117. detail::close_socket(sock);
  16118. });
  16119. // Perform TLS accept handshake with timeout
  16120. TlsError tls_err;
  16121. auto accepted = false;
  16122. {
  16123. auto handshake_left = detail::scope_exit([&] {
  16124. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16125. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16126. });
  16127. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16128. read_timeout_usec_, &tls_err);
  16129. }
  16130. if (!accepted) {
  16131. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16132. // Map TlsError to legacy ssl_error for backward compatibility
  16133. if (tls_err.code == ErrorCode::WantRead) {
  16134. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16135. } else if (tls_err.code == ErrorCode::WantWrite) {
  16136. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16137. } else {
  16138. last_ssl_error_ = SSL_ERROR_SSL;
  16139. }
  16140. #else
  16141. last_ssl_error_ = static_cast<int>(get_error());
  16142. #endif
  16143. return false;
  16144. }
  16145. handshake_done = true;
  16146. std::string remote_addr;
  16147. int remote_port = 0;
  16148. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16149. std::string local_addr;
  16150. int local_port = 0;
  16151. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16152. ret = serve_guarded([&]() {
  16153. return detail::process_server_socket_ssl(
  16154. svr_sock_, session, sock, keep_alive_max_count_,
  16155. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16156. write_timeout_sec_, write_timeout_usec_,
  16157. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16158. return process_request(
  16159. strm, remote_addr, remote_port, local_addr, local_port,
  16160. close_connection, connection_closed,
  16161. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16162. });
  16163. });
  16164. return ret;
  16165. }
  16166. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16167. const char *key_pem,
  16168. const char *client_ca_pem,
  16169. const char *password) {
  16170. if (!ctx_) { return false; }
  16171. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16172. updates_pending_++;
  16173. auto se = detail::scope_exit([&] {
  16174. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16175. });
  16176. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16177. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16178. return false;
  16179. }
  16180. if (client_ca_pem) {
  16181. return tls::update_server_client_ca(ctx_, client_ca_pem);
  16182. }
  16183. return true;
  16184. }
  16185. // SSL HTTP client implementation
  16186. inline SSLClient::~SSLClient() {
  16187. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16188. // base function rather than the derived function once we get to the
  16189. // base class destructor, and won't free the SSL (causing a leak).
  16190. // This must happen before the context is freed below: some backends
  16191. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16192. // context, so freeing the context first leaves close_notify reading
  16193. // freed memory.
  16194. shutdown_ssl_impl(socket_, true);
  16195. if (ctx_) {
  16196. tls::free_context(ctx_);
  16197. ctx_ = nullptr;
  16198. }
  16199. }
  16200. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16201. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16202. shutdown_ssl_impl(socket, shutdown_gracefully);
  16203. }
  16204. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16205. bool shutdown_gracefully) {
  16206. if (socket.sock == INVALID_SOCKET) {
  16207. assert(socket.ssl == nullptr);
  16208. return;
  16209. }
  16210. if (socket.ssl) {
  16211. tls::shutdown(socket.ssl, shutdown_gracefully);
  16212. {
  16213. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16214. tls::free_session(socket.ssl);
  16215. }
  16216. socket.ssl = nullptr;
  16217. }
  16218. assert(socket.ssl == nullptr);
  16219. }
  16220. inline bool SSLClient::process_socket(
  16221. const Socket &socket,
  16222. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16223. std::function<bool(Stream &strm)> callback) {
  16224. assert(socket.ssl);
  16225. return detail::process_client_socket_ssl(
  16226. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16227. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16228. [&](detail::SSLSocketStream &strm) {
  16229. auto ret = callback(strm);
  16230. // A request that failed after the handshake reports Error::Read or
  16231. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16232. // from the server, for Result::ssl_error() and ssl_backend_error()
  16233. const auto &tls_error = strm.tls_error();
  16234. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16235. last_ssl_error_ = static_cast<int>(tls_error.code);
  16236. last_backend_error_ = tls_error.backend_code;
  16237. }
  16238. return ret;
  16239. });
  16240. }
  16241. inline bool SSLClient::is_ssl() const { return true; }
  16242. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16243. if (!is_valid()) {
  16244. error = Error::SSLConnection;
  16245. return false;
  16246. }
  16247. return ClientImpl::create_and_connect_socket(socket, error);
  16248. }
  16249. inline bool SSLClient::setup_proxy_connection(
  16250. Socket &socket,
  16251. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16252. Response &res, bool &success, Error &error) {
  16253. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16254. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16255. return false;
  16256. }
  16257. if (!initialize_ssl(socket, error)) {
  16258. success = false;
  16259. return false;
  16260. }
  16261. return true;
  16262. }
  16263. // Assumes that socket_mutex_ is locked and that there are no requests in
  16264. // flight
  16265. inline bool SSLClient::connect_with_proxy(
  16266. Socket &socket,
  16267. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16268. Response &res, bool &success, Error &error) {
  16269. success = true;
  16270. Response proxy_res;
  16271. if (!detail::process_client_socket(
  16272. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16273. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16274. start_time, [&](Stream &strm) {
  16275. Request req2;
  16276. req2.method = "CONNECT";
  16277. req2.path =
  16278. detail::make_host_and_port_string_always_port(host_, port_);
  16279. if (max_timeout_msec_ > 0) {
  16280. req2.start_time_ = std::chrono::steady_clock::now();
  16281. }
  16282. return process_request(strm, req2, proxy_res, false, error);
  16283. })) {
  16284. // Thread-safe to close everything because we are assuming there are no
  16285. // requests in flight
  16286. shutdown_ssl(socket, true);
  16287. shutdown_socket(socket);
  16288. close_socket(socket);
  16289. success = false;
  16290. return false;
  16291. }
  16292. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16293. if (!proxy_digest_auth_username_.empty() &&
  16294. !proxy_digest_auth_password_.empty()) {
  16295. std::map<std::string, std::string> auth;
  16296. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16297. // Close the current socket and create a new one for the authenticated
  16298. // request
  16299. shutdown_ssl(socket, true);
  16300. shutdown_socket(socket);
  16301. close_socket(socket);
  16302. // Create a new socket for the authenticated CONNECT request
  16303. if (!ensure_socket_connection(socket, error)) {
  16304. success = false;
  16305. output_error_log(error, nullptr);
  16306. return false;
  16307. }
  16308. proxy_res = Response();
  16309. if (!detail::process_client_socket(
  16310. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16311. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16312. start_time, [&](Stream &strm) {
  16313. Request req3;
  16314. req3.method = "CONNECT";
  16315. req3.path = detail::make_host_and_port_string_always_port(
  16316. host_, port_);
  16317. req3.headers.insert(detail::make_digest_authentication_header(
  16318. req3, make_request_target(req3), auth, 1,
  16319. detail::random_string(10), proxy_digest_auth_username_,
  16320. proxy_digest_auth_password_, true));
  16321. if (max_timeout_msec_ > 0) {
  16322. req3.start_time_ = std::chrono::steady_clock::now();
  16323. }
  16324. return process_request(strm, req3, proxy_res, false, error);
  16325. })) {
  16326. // Thread-safe to close everything because we are assuming there are
  16327. // no requests in flight
  16328. shutdown_ssl(socket, true);
  16329. shutdown_socket(socket);
  16330. close_socket(socket);
  16331. success = false;
  16332. return false;
  16333. }
  16334. }
  16335. }
  16336. }
  16337. // If status code is not 200, proxy request is failed.
  16338. // Set error to ProxyConnection. A 407 is returned as the response of the
  16339. // request, so the caller sees the proxy asks for credentials; any other
  16340. // status would read as the answer of the origin, which it never reached.
  16341. if (proxy_res.status != StatusCode::OK_200) {
  16342. error = Error::ProxyConnection;
  16343. output_error_log(error, nullptr);
  16344. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16345. res = std::move(proxy_res);
  16346. } else {
  16347. success = false;
  16348. }
  16349. // Thread-safe to close everything because we are assuming there are
  16350. // no requests in flight
  16351. shutdown_ssl(socket, true);
  16352. shutdown_socket(socket);
  16353. close_socket(socket);
  16354. return false;
  16355. }
  16356. return true;
  16357. }
  16358. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16359. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16360. if (is_proxy_enabled_for_host(host_)) { return true; }
  16361. if (!initialize_ssl(socket, error)) {
  16362. shutdown_socket(socket);
  16363. close_socket(socket);
  16364. return false;
  16365. }
  16366. return true;
  16367. }
  16368. // SSL HTTP client implementation
  16369. inline SSLClient::SSLClient(const std::string &host)
  16370. : SSLClient(host, 443, std::string(), std::string()) {}
  16371. inline SSLClient::SSLClient(const std::string &host, int port)
  16372. : SSLClient(host, port, std::string(), std::string()) {}
  16373. inline void SSLClient::init_ctx() {
  16374. ctx_ = tls::create_client_context();
  16375. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16376. }
  16377. inline void SSLClient::reset_ctx_on_error() {
  16378. last_backend_error_ = tls::get_error();
  16379. tls::free_context(ctx_);
  16380. ctx_ = nullptr;
  16381. }
  16382. inline SSLClient::SSLClient(const std::string &host, int port,
  16383. const std::string &client_cert_path,
  16384. const std::string &client_key_path,
  16385. const std::string &private_key_password)
  16386. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16387. init_ctx();
  16388. if (!ctx_) { return; }
  16389. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16390. const char *password =
  16391. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16392. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16393. client_key_path.c_str(), password)) {
  16394. reset_ctx_on_error();
  16395. }
  16396. }
  16397. }
  16398. inline SSLClient::SSLClient(const std::string &host, int port,
  16399. const PemMemory &pem)
  16400. : ClientImpl(host, port) {
  16401. init_ctx();
  16402. if (!ctx_) { return; }
  16403. if (pem.cert_pem && pem.key_pem) {
  16404. std::string cert_buf, key_buf;
  16405. if (!tls::set_client_cert_pem(
  16406. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16407. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16408. pem.private_key_password)) {
  16409. reset_ctx_on_error();
  16410. }
  16411. }
  16412. }
  16413. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16414. if (ca_cert_store && ctx_) {
  16415. // set_ca_store takes ownership of ca_cert_store
  16416. tls::set_ca_store(ctx_, ca_cert_store);
  16417. ca_cert_store_set_ = true;
  16418. } else if (ca_cert_store) {
  16419. tls::free_ca_store(ca_cert_store);
  16420. }
  16421. }
  16422. inline void
  16423. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16424. if (!ctx_) { return; }
  16425. server_certificate_verifier_ = verifier;
  16426. // Under the lock that creating a session from ctx_ takes
  16427. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16428. tls::set_verify_callback(ctx_, std::move(verifier));
  16429. }
  16430. inline void SSLClient::set_session_verifier(
  16431. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16432. session_verifier_ = std::move(verifier);
  16433. }
  16434. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16435. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16436. enable_windows_cert_verification_ = enabled;
  16437. }
  16438. #endif
  16439. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16440. std::size_t size) {
  16441. if (ctx_ && ca_cert && size > 0) {
  16442. // Every PEM loaded, for redirect transfer
  16443. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16444. ca_cert_pem_ += '\n';
  16445. }
  16446. ca_cert_pem_.append(ca_cert, size);
  16447. tls::load_ca_pem(ctx_, ca_cert, size);
  16448. }
  16449. }
  16450. inline bool SSLClient::load_certs() {
  16451. auto ret = true;
  16452. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16453. // one client is shared across concurrent requests here.
  16454. std::call_once(initialize_cert_, [&]() {
  16455. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16456. ret = detail::load_client_ca_config(
  16457. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16458. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16459. last_backend_error_);
  16460. });
  16461. return ret;
  16462. }
  16463. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16464. // Load CA certificates if server verification is enabled
  16465. if (server_certificate_verification_) {
  16466. if (!load_certs()) {
  16467. error = Error::SSLLoadingCerts;
  16468. output_error_log(error, nullptr);
  16469. return false;
  16470. }
  16471. }
  16472. detail::ClientTlsSessionOptions options;
  16473. options.server_hostname_verification = server_hostname_verification_;
  16474. options.session_verifier = session_verifier_;
  16475. options.ctx_mutex = &ctx_mutex_;
  16476. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16477. // Skip Schannel when a custom CA cert is specified, as the Windows
  16478. // certificate store would not know about user-provided CA certificates.
  16479. // Also skip when system CA trust is explicitly disabled.
  16480. options.windows_cert_verification =
  16481. enable_windows_cert_verification_ &&
  16482. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16483. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16484. // Only a verifier set through set_server_certificate_verifier() is seen
  16485. // here, not one installed with tls::set_verify_callback() directly.
  16486. options.server_certificate_verifier_set =
  16487. static_cast<bool>(server_certificate_verifier_);
  16488. #endif
  16489. tls::session_t session = nullptr;
  16490. // Use scope_exit to ensure session is freed on error paths
  16491. bool success = false;
  16492. auto session_guard = detail::scope_exit([&] {
  16493. if (!success) { tls::free_session(session); }
  16494. });
  16495. detail::ClientTlsSessionError tls_error;
  16496. if (!detail::setup_client_tls_session(
  16497. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16498. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16499. options)) {
  16500. error = tls_error.error;
  16501. last_ssl_error_ = tls_error.ssl_error;
  16502. last_backend_error_ = tls_error.backend_error;
  16503. output_error_log(error, nullptr);
  16504. return false;
  16505. }
  16506. success = true;
  16507. socket.ssl = session;
  16508. return true;
  16509. }
  16510. inline void Client::set_digest_auth(const std::string &username,
  16511. const std::string &password) {
  16512. cli_->set_digest_auth(username, password);
  16513. }
  16514. inline void Client::set_proxy_digest_auth(const std::string &username,
  16515. const std::string &password) {
  16516. cli_->set_proxy_digest_auth(username, password);
  16517. }
  16518. inline void Client::enable_server_certificate_verification(bool enabled) {
  16519. cli_->enable_server_certificate_verification(enabled);
  16520. }
  16521. inline void Client::enable_server_hostname_verification(bool enabled) {
  16522. cli_->enable_server_hostname_verification(enabled);
  16523. }
  16524. inline void Client::enable_system_ca(bool enabled) {
  16525. cli_->enable_system_ca(enabled);
  16526. }
  16527. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16528. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16529. if (is_ssl_) {
  16530. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16531. enabled);
  16532. }
  16533. }
  16534. #endif
  16535. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16536. const std::string &ca_cert_dir_path) {
  16537. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16538. }
  16539. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16540. if (is_ssl_) {
  16541. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16542. } else if (ca_cert_store) {
  16543. tls::free_ca_store(ca_cert_store);
  16544. }
  16545. }
  16546. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16547. if (is_ssl_) {
  16548. // Use the PEM-based path so the CA data is retained for redirect transfer
  16549. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16550. }
  16551. }
  16552. inline void
  16553. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16554. if (is_ssl_) {
  16555. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16556. std::move(verifier));
  16557. }
  16558. }
  16559. inline void Client::set_session_verifier(
  16560. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16561. if (is_ssl_) {
  16562. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16563. }
  16564. }
  16565. inline tls::ctx_t Client::tls_context() const {
  16566. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16567. return nullptr;
  16568. }
  16569. #endif // CPPHTTPLIB_SSL_ENABLED
  16570. /*
  16571. * Group 7: TLS abstraction layer - Common API
  16572. */
  16573. #ifdef CPPHTTPLIB_SSL_ENABLED
  16574. namespace tls {
  16575. // Helper for PeerCert construction
  16576. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16577. return PeerCert(get_peer_cert(session));
  16578. }
  16579. namespace impl {
  16580. // set_verify_callback() can replace a callback while handshakes on other
  16581. // threads run it, so they share it, and take their reference under this lock.
  16582. inline std::mutex &verify_callback_mutex() {
  16583. static std::mutex mutex;
  16584. return mutex;
  16585. }
  16586. // The TLS libraries are C, so an exception from a verify callback must not
  16587. // unwind through them. It rejects the certificate instead.
  16588. inline bool run_verify_callback(const VerifyCallback &callback,
  16589. const VerifyContext &ctx) {
  16590. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16591. return callback(ctx);
  16592. #else
  16593. try {
  16594. return callback(ctx);
  16595. } catch (...) { return false; }
  16596. #endif
  16597. }
  16598. // Check if a string is an IPv4 address
  16599. inline bool is_ipv4_address(const std::string &str) {
  16600. int dots = 0;
  16601. for (char c : str) {
  16602. if (c == '.') {
  16603. dots++;
  16604. } else if (!detail::is_ascii_digit(c)) {
  16605. return false;
  16606. }
  16607. }
  16608. return dots == 3;
  16609. }
  16610. // Parse IPv4 address string to bytes
  16611. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16612. const char *p = str.c_str();
  16613. for (int i = 0; i < 4; i++) {
  16614. if (i > 0) {
  16615. if (*p != '.') { return false; }
  16616. p++;
  16617. }
  16618. int val = 0;
  16619. int digits = 0;
  16620. while (detail::is_ascii_digit(*p)) {
  16621. val = val * 10 + (*p - '0');
  16622. if (val > 255) { return false; }
  16623. p++;
  16624. digits++;
  16625. }
  16626. if (digits == 0) { return false; }
  16627. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16628. if (digits > 1 && *(p - digits) == '0') { return false; }
  16629. out[i] = static_cast<unsigned char>(val);
  16630. }
  16631. return *p == '\0';
  16632. }
  16633. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16634. // `out` must have room for at least 16 bytes. Returns the address length
  16635. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16636. // literal. Used to match a host against iPAddress SANs the same way the
  16637. // OpenSSL backend does via X509_check_ip.
  16638. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16639. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16640. struct in6_addr addr6 = {};
  16641. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16642. memcpy(out, &addr6, 16);
  16643. return 16;
  16644. }
  16645. return 0;
  16646. }
  16647. #ifdef _WIN32
  16648. // Enumerate Windows system certificates and call callback with DER data
  16649. template <typename Callback>
  16650. inline bool enumerate_windows_system_certs(Callback cb) {
  16651. bool loaded = false;
  16652. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16653. for (auto store_name : store_names) {
  16654. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16655. if (hStore) {
  16656. PCCERT_CONTEXT pContext = nullptr;
  16657. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16658. nullptr) {
  16659. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16660. loaded = true;
  16661. }
  16662. }
  16663. CertCloseStore(hStore, 0);
  16664. }
  16665. }
  16666. return loaded;
  16667. }
  16668. #endif
  16669. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16670. // Enumerate macOS Keychain certificates and call callback with DER data
  16671. template <typename Callback>
  16672. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16673. bool loaded = false;
  16674. const SecTrustSettingsDomain domains[] = {
  16675. kSecTrustSettingsDomainSystem,
  16676. kSecTrustSettingsDomainAdmin,
  16677. kSecTrustSettingsDomainUser,
  16678. };
  16679. for (auto domain : domains) {
  16680. CFArrayRef certs = nullptr;
  16681. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16682. if (status != errSecSuccess || !certs) {
  16683. if (certs) CFRelease(certs);
  16684. continue;
  16685. }
  16686. CFIndex count = CFArrayGetCount(certs);
  16687. for (CFIndex i = 0; i < count; i++) {
  16688. SecCertificateRef cert =
  16689. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16690. CFDataRef data = SecCertificateCopyData(cert);
  16691. if (data) {
  16692. if (cb(CFDataGetBytePtr(data),
  16693. static_cast<size_t>(CFDataGetLength(data)))) {
  16694. loaded = true;
  16695. }
  16696. CFRelease(data);
  16697. }
  16698. }
  16699. CFRelease(certs);
  16700. }
  16701. return loaded;
  16702. }
  16703. #endif
  16704. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16705. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16706. // Common CA certificate file paths on Linux/Unix
  16707. inline const char **system_ca_paths() {
  16708. static const char *paths[] = {
  16709. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16710. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16711. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16712. "/etc/pki/tls/cacert.pem", // OpenELEC
  16713. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16714. nullptr};
  16715. return paths;
  16716. }
  16717. // Common CA certificate directory paths on Linux/Unix
  16718. inline const char **system_ca_dirs() {
  16719. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16720. "/etc/pki/tls/certs", // RHEL/CentOS
  16721. "/usr/share/ca-certificates", // Other
  16722. nullptr};
  16723. return dirs;
  16724. }
  16725. #endif
  16726. } // namespace impl
  16727. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16728. const char *ca_dir) {
  16729. if (!ctx) { return false; }
  16730. bool success = true;
  16731. if (ca_file && *ca_file) {
  16732. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16733. }
  16734. if (ca_dir && *ca_dir) {
  16735. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16736. }
  16737. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16738. // Set CA list for client certificate request (CertificateRequest message)
  16739. if (ca_file && *ca_file) {
  16740. auto list = SSL_load_client_CA_file(ca_file);
  16741. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16742. }
  16743. #endif
  16744. return success;
  16745. }
  16746. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16747. const char *password) {
  16748. return set_client_cert_pem(ctx, cert, key, password);
  16749. }
  16750. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16751. const char *key_path, const char *password) {
  16752. return set_client_cert_file(ctx, cert_path, key_path, password);
  16753. }
  16754. // PeerCert implementation
  16755. inline PeerCert::PeerCert() = default;
  16756. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16757. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16758. other.cert_ = nullptr;
  16759. }
  16760. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16761. if (this != &other) {
  16762. if (cert_) { free_cert(cert_); }
  16763. cert_ = other.cert_;
  16764. other.cert_ = nullptr;
  16765. }
  16766. return *this;
  16767. }
  16768. inline PeerCert::~PeerCert() {
  16769. if (cert_) { free_cert(cert_); }
  16770. }
  16771. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16772. inline std::string PeerCert::subject_cn() const {
  16773. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16774. }
  16775. inline std::string PeerCert::issuer_name() const {
  16776. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16777. }
  16778. inline bool PeerCert::check_hostname(const char *hostname) const {
  16779. return cert_ ? verify_hostname(cert_, hostname) : false;
  16780. }
  16781. inline std::vector<SanEntry> PeerCert::sans() const {
  16782. std::vector<SanEntry> result;
  16783. if (cert_) { get_cert_sans(cert_, result); }
  16784. return result;
  16785. }
  16786. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16787. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16788. }
  16789. inline std::string PeerCert::serial() const {
  16790. return cert_ ? get_cert_serial(cert_) : std::string();
  16791. }
  16792. // VerifyContext method implementations
  16793. inline std::string VerifyContext::subject_cn() const {
  16794. return cert ? get_cert_subject_cn(cert) : std::string();
  16795. }
  16796. inline std::string VerifyContext::issuer_name() const {
  16797. return cert ? get_cert_issuer_name(cert) : std::string();
  16798. }
  16799. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16800. return cert ? verify_hostname(cert, hostname) : false;
  16801. }
  16802. inline std::vector<SanEntry> VerifyContext::sans() const {
  16803. std::vector<SanEntry> result;
  16804. if (cert) { get_cert_sans(cert, result); }
  16805. return result;
  16806. }
  16807. inline bool VerifyContext::validity(time_t &not_before,
  16808. time_t &not_after) const {
  16809. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16810. }
  16811. inline std::string VerifyContext::serial() const {
  16812. return cert ? get_cert_serial(cert) : std::string();
  16813. }
  16814. // TlsError static method implementation
  16815. inline std::string TlsError::verify_error_to_string(long error_code) {
  16816. return verify_error_string(error_code);
  16817. }
  16818. } // namespace tls
  16819. // Request::peer_cert() implementation
  16820. inline tls::PeerCert Request::peer_cert() const {
  16821. return tls::get_peer_cert_from_session(ssl);
  16822. }
  16823. // Request::sni() implementation
  16824. inline std::string Request::sni() const {
  16825. if (!ssl) { return std::string(); }
  16826. const char *s = tls::get_sni(ssl);
  16827. return s ? std::string(s) : std::string();
  16828. }
  16829. #endif // CPPHTTPLIB_SSL_ENABLED
  16830. /*
  16831. * Group 8: TLS abstraction layer - OpenSSL backend
  16832. */
  16833. /*
  16834. * OpenSSL Backend Implementation
  16835. */
  16836. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16837. namespace tls {
  16838. namespace impl {
  16839. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16840. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16841. switch (ssl_error) {
  16842. case SSL_ERROR_NONE: return ErrorCode::Success;
  16843. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16844. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16845. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16846. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16847. case SSL_ERROR_SSL:
  16848. default: return ErrorCode::Fatal;
  16849. }
  16850. }
  16851. // Helper: Create client CA list from PEM string
  16852. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16853. // Caller takes ownership of returned list
  16854. inline STACK_OF(X509_NAME) *
  16855. create_client_ca_list_from_pem(const char *ca_pem) {
  16856. if (!ca_pem) { return nullptr; }
  16857. auto ca_list = sk_X509_NAME_new_null();
  16858. if (!ca_list) { return nullptr; }
  16859. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16860. if (!bio) {
  16861. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16862. return nullptr;
  16863. }
  16864. X509 *cert = nullptr;
  16865. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16866. nullptr) {
  16867. const X509_NAME *name = X509_get_subject_name(cert);
  16868. if (name) {
  16869. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16870. }
  16871. X509_free(cert);
  16872. }
  16873. BIO_free(bio);
  16874. return ca_list;
  16875. }
  16876. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16877. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16878. long /*argl*/, void * /*argp*/) {
  16879. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  16880. }
  16881. // The SSL_CTX owns its verify callback, so each client or server sees only
  16882. // its own, on whichever thread runs the handshake.
  16883. inline int verify_callback_index() {
  16884. static const auto index = SSL_CTX_get_ex_new_index(
  16885. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16886. return index;
  16887. }
  16888. // OpenSSL verify callback wrapper
  16889. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16890. // Get SSL object from X509_STORE_CTX
  16891. auto ssl = static_cast<SSL *>(
  16892. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16893. if (!ssl) { return preverify_ok; }
  16894. std::shared_ptr<VerifyCallback> callback;
  16895. {
  16896. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  16897. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  16898. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16899. if (stored) { callback = *stored; }
  16900. }
  16901. if (!callback) { return preverify_ok; }
  16902. // Get current certificate and depth
  16903. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16904. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16905. int error = X509_STORE_CTX_get_error(ctx);
  16906. // Build context
  16907. VerifyContext verify_ctx;
  16908. verify_ctx.session = static_cast<session_t>(ssl);
  16909. verify_ctx.cert = static_cast<cert_t>(cert);
  16910. verify_ctx.depth = depth;
  16911. verify_ctx.preverify_ok = (preverify_ok != 0);
  16912. verify_ctx.error_code = error;
  16913. verify_ctx.error_string =
  16914. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16915. return run_verify_callback(*callback, verify_ctx) ? 1 : 0;
  16916. }
  16917. // Sets the verify mode from whether the peer's certificate is required and
  16918. // whether a verify callback is set.
  16919. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  16920. auto has_callback =
  16921. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  16922. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16923. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  16924. SSL_CTX_set_verify(ssl_ctx, mode,
  16925. has_callback ? openssl_verify_callback : nullptr);
  16926. }
  16927. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16928. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16929. // that must be released with release_store_objects
  16930. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16931. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16932. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16933. #endif
  16934. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16935. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16936. return X509_STORE_get1_objects(store);
  16937. #else
  16938. return X509_STORE_get0_objects(store);
  16939. #endif
  16940. }
  16941. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16942. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16943. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16944. #else
  16945. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16946. #endif
  16947. }
  16948. } // namespace impl
  16949. inline ctx_t create_client_context() {
  16950. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16951. if (ctx) {
  16952. // Disable auto-retry to properly handle non-blocking I/O
  16953. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16954. // Set minimum TLS version
  16955. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16956. }
  16957. return static_cast<ctx_t>(ctx);
  16958. }
  16959. inline void free_context(ctx_t ctx) {
  16960. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16961. }
  16962. inline bool set_min_version(ctx_t ctx, Version version) {
  16963. if (!ctx) return false;
  16964. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16965. static_cast<uint16_t>(version)) == 1;
  16966. }
  16967. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16968. if (!ctx || !pem || len == 0) return false;
  16969. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16970. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16971. if (!store) return false;
  16972. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16973. if (!bio) return false;
  16974. bool ok = true;
  16975. X509 *cert = nullptr;
  16976. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16977. nullptr) {
  16978. if (X509_STORE_add_cert(store, cert) != 1) {
  16979. // Ignore duplicate errors
  16980. auto err = ERR_peek_last_error();
  16981. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16982. ok = false;
  16983. }
  16984. }
  16985. X509_free(cert);
  16986. if (!ok) break;
  16987. }
  16988. BIO_free(bio);
  16989. // Clear any "no more certificates" errors
  16990. ERR_clear_error();
  16991. return ok;
  16992. }
  16993. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16994. if (!ctx || !file_path) return false;
  16995. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16996. nullptr) == 1;
  16997. }
  16998. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16999. if (!ctx || !dir_path) return false;
  17000. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17001. dir_path) == 1;
  17002. }
  17003. inline bool load_system_certs(ctx_t ctx) {
  17004. if (!ctx) return false;
  17005. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17006. #ifdef _WIN32
  17007. // Windows: Load from system certificate store (ROOT and CA)
  17008. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17009. if (!store) return false;
  17010. bool loaded_any = false;
  17011. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17012. for (auto store_name : store_names) {
  17013. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17014. if (!hStore) continue;
  17015. PCCERT_CONTEXT pContext = nullptr;
  17016. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17017. nullptr) {
  17018. const unsigned char *data = pContext->pbCertEncoded;
  17019. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17020. if (x509) {
  17021. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17022. X509_free(x509);
  17023. }
  17024. }
  17025. CertCloseStore(hStore, 0);
  17026. }
  17027. return loaded_any;
  17028. #elif defined(__APPLE__)
  17029. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17030. // macOS: Load from Keychain
  17031. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17032. if (!store) return false;
  17033. bool loaded_any = false;
  17034. const SecTrustSettingsDomain domains[] = {
  17035. kSecTrustSettingsDomainSystem,
  17036. kSecTrustSettingsDomainAdmin,
  17037. kSecTrustSettingsDomainUser,
  17038. };
  17039. for (auto domain : domains) {
  17040. CFArrayRef certs = nullptr;
  17041. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  17042. !certs) {
  17043. if (certs) CFRelease(certs);
  17044. continue;
  17045. }
  17046. auto count = CFArrayGetCount(certs);
  17047. for (CFIndex i = 0; i < count; i++) {
  17048. auto cert = reinterpret_cast<SecCertificateRef>(
  17049. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  17050. CFDataRef der = SecCertificateCopyData(cert);
  17051. if (der) {
  17052. const unsigned char *data = CFDataGetBytePtr(der);
  17053. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  17054. if (x509) {
  17055. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17056. X509_free(x509);
  17057. }
  17058. CFRelease(der);
  17059. }
  17060. }
  17061. CFRelease(certs);
  17062. }
  17063. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17064. #else
  17065. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17066. #endif
  17067. #else
  17068. // Other Unix: use default verify paths
  17069. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17070. #endif
  17071. }
  17072. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17073. const char *password) {
  17074. if (!ctx || !cert || !key) return false;
  17075. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17076. // Load certificate
  17077. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17078. if (!cert_bio) return false;
  17079. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17080. BIO_free(cert_bio);
  17081. if (!x509) return false;
  17082. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17083. X509_free(x509);
  17084. if (!cert_ok) return false;
  17085. // Load private key
  17086. auto key_bio = BIO_new_mem_buf(key, -1);
  17087. if (!key_bio) return false;
  17088. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17089. password ? const_cast<char *>(password)
  17090. : nullptr);
  17091. BIO_free(key_bio);
  17092. if (!pkey) return false;
  17093. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17094. EVP_PKEY_free(pkey);
  17095. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17096. }
  17097. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17098. const char *key_path, const char *password) {
  17099. if (!ctx || !cert_path || !key_path) return false;
  17100. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17101. if (password && password[0] != '\0') {
  17102. SSL_CTX_set_default_passwd_cb_userdata(
  17103. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17104. }
  17105. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17106. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17107. }
  17108. inline ctx_t create_server_context() {
  17109. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17110. if (ctx) {
  17111. // No renegotiation, as on the other backends: it would run a handshake
  17112. // that SSLServer::update_certs_pem() does not wait for
  17113. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17114. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17115. SSL_OP_NO_RENEGOTIATION);
  17116. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17117. // Without one, a client resuming its session is sent a fatal alert once
  17118. // client certificates are verified.
  17119. static const unsigned char sid_ctx[] = "cpp-httplib";
  17120. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17121. }
  17122. return static_cast<ctx_t>(ctx);
  17123. }
  17124. inline void set_verify_client(ctx_t ctx, bool require) {
  17125. if (!ctx) return;
  17126. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17127. }
  17128. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17129. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17130. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17131. SSL *ssl = SSL_new(ssl_ctx);
  17132. if (!ssl) return nullptr;
  17133. // Disable auto-retry for proper non-blocking I/O handling
  17134. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17135. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17136. if (!bio) {
  17137. SSL_free(ssl);
  17138. return nullptr;
  17139. }
  17140. SSL_set_bio(ssl, bio, bio);
  17141. return static_cast<session_t>(ssl);
  17142. }
  17143. inline void free_session(session_t session) {
  17144. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17145. }
  17146. inline bool set_sni(session_t session, const char *hostname,
  17147. bool /*verify_hostname*/) {
  17148. if (!session || !hostname) return false;
  17149. auto ssl = static_cast<SSL *>(session);
  17150. // Set SNI (Server Name Indication) only - does not enable verification.
  17151. // OpenSSL never binds identity checking to SNI (that happens post-
  17152. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  17153. #if defined(OPENSSL_IS_BORINGSSL)
  17154. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17155. #else
  17156. // Direct call instead of macro to suppress -Wold-style-cast warning
  17157. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17158. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17159. #endif
  17160. }
  17161. inline TlsError connect(session_t session) {
  17162. if (!session) { return TlsError(); }
  17163. auto ssl = static_cast<SSL *>(session);
  17164. auto ret = SSL_connect(ssl);
  17165. TlsError err;
  17166. if (ret == 1) {
  17167. err.code = ErrorCode::Success;
  17168. } else {
  17169. auto ssl_err = SSL_get_error(ssl, ret);
  17170. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17171. err.backend_code = ERR_get_error();
  17172. }
  17173. return err;
  17174. }
  17175. inline TlsError accept(session_t session) {
  17176. if (!session) { return TlsError(); }
  17177. auto ssl = static_cast<SSL *>(session);
  17178. auto ret = SSL_accept(ssl);
  17179. TlsError err;
  17180. if (ret == 1) {
  17181. err.code = ErrorCode::Success;
  17182. } else {
  17183. auto ssl_err = SSL_get_error(ssl, ret);
  17184. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17185. err.backend_code = ERR_get_error();
  17186. }
  17187. return err;
  17188. }
  17189. inline bool connect_nonblocking(session_t session, socket_t sock,
  17190. time_t timeout_sec, time_t timeout_usec,
  17191. TlsError *err) {
  17192. if (!session) {
  17193. if (err) { err->code = ErrorCode::Fatal; }
  17194. return false;
  17195. }
  17196. auto ssl = static_cast<SSL *>(session);
  17197. auto bio = SSL_get_rbio(ssl);
  17198. // Set non-blocking mode for handshake
  17199. detail::set_nonblocking(sock, true);
  17200. if (bio) { BIO_set_nbio(bio, 1); }
  17201. auto cleanup = detail::scope_exit([&]() {
  17202. // Restore blocking mode after handshake
  17203. if (bio) { BIO_set_nbio(bio, 0); }
  17204. detail::set_nonblocking(sock, false);
  17205. });
  17206. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17207. auto res = 0;
  17208. while ((res = SSL_connect(ssl)) != 1) {
  17209. auto ssl_err = SSL_get_error(ssl, res);
  17210. switch (ssl_err) {
  17211. case SSL_ERROR_WANT_READ:
  17212. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17213. break;
  17214. case SSL_ERROR_WANT_WRITE:
  17215. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17216. break;
  17217. default: break;
  17218. }
  17219. if (err) {
  17220. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17221. err->backend_code = ERR_get_error();
  17222. }
  17223. return false;
  17224. }
  17225. if (err) { err->code = ErrorCode::Success; }
  17226. return true;
  17227. }
  17228. inline bool accept_nonblocking(session_t session, socket_t sock,
  17229. time_t timeout_sec, time_t timeout_usec,
  17230. TlsError *err) {
  17231. if (!session) {
  17232. if (err) { err->code = ErrorCode::Fatal; }
  17233. return false;
  17234. }
  17235. auto ssl = static_cast<SSL *>(session);
  17236. auto bio = SSL_get_rbio(ssl);
  17237. // Set non-blocking mode for handshake
  17238. detail::set_nonblocking(sock, true);
  17239. if (bio) { BIO_set_nbio(bio, 1); }
  17240. auto cleanup = detail::scope_exit([&]() {
  17241. // Restore blocking mode after handshake
  17242. if (bio) { BIO_set_nbio(bio, 0); }
  17243. detail::set_nonblocking(sock, false);
  17244. });
  17245. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17246. auto res = 0;
  17247. while ((res = SSL_accept(ssl)) != 1) {
  17248. auto ssl_err = SSL_get_error(ssl, res);
  17249. switch (ssl_err) {
  17250. case SSL_ERROR_WANT_READ:
  17251. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17252. break;
  17253. case SSL_ERROR_WANT_WRITE:
  17254. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17255. break;
  17256. default: break;
  17257. }
  17258. if (err) {
  17259. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17260. err->backend_code = ERR_get_error();
  17261. }
  17262. return false;
  17263. }
  17264. if (err) { err->code = ErrorCode::Success; }
  17265. return true;
  17266. }
  17267. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17268. if (!session || !buf) {
  17269. err.code = ErrorCode::Fatal;
  17270. return -1;
  17271. }
  17272. auto ssl = static_cast<SSL *>(session);
  17273. constexpr auto max_len =
  17274. static_cast<size_t>((std::numeric_limits<int>::max)());
  17275. if (len > max_len) { len = max_len; }
  17276. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17277. if (ret > 0) {
  17278. err.code = ErrorCode::Success;
  17279. return ret;
  17280. }
  17281. auto ssl_err = SSL_get_error(ssl, ret);
  17282. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17283. if (err.code == ErrorCode::PeerClosed) {
  17284. return 0;
  17285. } // Gracefully handle the peer closed state.
  17286. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17287. return -1;
  17288. }
  17289. inline ssize_t write(session_t session, const void *buf, size_t len,
  17290. TlsError &err) {
  17291. if (!session || !buf) {
  17292. err.code = ErrorCode::Fatal;
  17293. return -1;
  17294. }
  17295. auto ssl = static_cast<SSL *>(session);
  17296. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17297. if (ret > 0) {
  17298. err.code = ErrorCode::Success;
  17299. return ret;
  17300. }
  17301. auto ssl_err = SSL_get_error(ssl, ret);
  17302. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17303. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17304. return -1;
  17305. }
  17306. inline int pending(const_session_t session) {
  17307. if (!session) return 0;
  17308. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17309. }
  17310. inline void shutdown(session_t session, bool graceful) {
  17311. if (!session) return;
  17312. auto ssl = static_cast<SSL *>(session);
  17313. if (graceful) {
  17314. // Send close_notify without waiting for the peer's. The connection is
  17315. // closed right after this, so a unidirectional shutdown is enough, and an
  17316. // idle peer that never answers would otherwise hold this thread until the
  17317. // read timeout. The other backends do not wait either.
  17318. SSL_shutdown(ssl);
  17319. }
  17320. }
  17321. inline bool is_peer_closed(session_t session, socket_t sock) {
  17322. if (!session) return true;
  17323. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17324. detail::set_nonblocking(sock, true);
  17325. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17326. auto ssl = static_cast<SSL *>(session);
  17327. char buf;
  17328. auto ret = SSL_peek(ssl, &buf, 1);
  17329. if (ret > 0) return false;
  17330. auto err = SSL_get_error(ssl, ret);
  17331. return err == SSL_ERROR_ZERO_RETURN;
  17332. }
  17333. inline cert_t get_peer_cert(const_session_t session) {
  17334. if (!session) return nullptr;
  17335. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17336. static_cast<SSL *>(const_cast<void *>(session))));
  17337. }
  17338. inline size_t get_peer_certs(const_session_t session,
  17339. std::vector<cert_t> &certs) {
  17340. certs.clear();
  17341. if (!session) { return 0; }
  17342. auto ssl = static_cast<const SSL *>(session);
  17343. // On the server side, the chain leaves out the peer's own certificate
  17344. if (SSL_is_server(ssl)) {
  17345. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17346. }
  17347. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17348. auto count = sk_X509_num(sk);
  17349. for (decltype(count) i = 0; i < count; i++) {
  17350. auto x509 = sk_X509_value(sk, i);
  17351. X509_up_ref(x509);
  17352. certs.push_back(static_cast<cert_t>(x509));
  17353. }
  17354. }
  17355. return certs.size();
  17356. }
  17357. inline void free_cert(cert_t cert) {
  17358. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17359. }
  17360. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17361. if (!cert || !hostname) return false;
  17362. auto x509 = static_cast<X509 *>(cert);
  17363. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17364. if (detail::is_ip_address(hostname)) {
  17365. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17366. }
  17367. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17368. }
  17369. inline uint64_t hostname_mismatch_code() {
  17370. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17371. }
  17372. inline long get_verify_result(const_session_t session) {
  17373. if (!session) return X509_V_ERR_UNSPECIFIED;
  17374. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17375. }
  17376. inline std::string get_cert_subject_cn(cert_t cert) {
  17377. if (!cert) return "";
  17378. auto x509 = static_cast<X509 *>(cert);
  17379. auto subject_name = X509_get_subject_name(x509);
  17380. if (!subject_name) return "";
  17381. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17382. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17383. if (idx < 0) return "";
  17384. auto entry = X509_NAME_get_entry(subject_name, idx);
  17385. if (!entry) return "";
  17386. auto data = X509_NAME_ENTRY_get_data(entry);
  17387. if (!data) return "";
  17388. return std::string(
  17389. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17390. static_cast<size_t>(ASN1_STRING_length(data)));
  17391. }
  17392. inline std::string get_cert_issuer_name(cert_t cert) {
  17393. if (!cert) return "";
  17394. auto x509 = static_cast<X509 *>(cert);
  17395. auto issuer_name = X509_get_issuer_name(x509);
  17396. if (!issuer_name) return "";
  17397. char buf[256];
  17398. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17399. return std::string(buf);
  17400. }
  17401. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17402. sans.clear();
  17403. if (!cert) return false;
  17404. auto x509 = static_cast<X509 *>(cert);
  17405. auto names = static_cast<GENERAL_NAMES *>(
  17406. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17407. if (!names) return true; // No SANs is valid
  17408. auto count = sk_GENERAL_NAME_num(names);
  17409. for (decltype(count) i = 0; i < count; i++) {
  17410. auto gen = sk_GENERAL_NAME_value(names, i);
  17411. if (!gen) continue;
  17412. SanEntry entry;
  17413. switch (gen->type) {
  17414. case GEN_DNS:
  17415. entry.type = SanType::DNS;
  17416. if (gen->d.dNSName) {
  17417. entry.value = std::string(
  17418. reinterpret_cast<const char *>(
  17419. ASN1_STRING_get0_data(gen->d.dNSName)),
  17420. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17421. }
  17422. break;
  17423. case GEN_IPADD:
  17424. entry.type = SanType::IP;
  17425. if (gen->d.iPAddress) {
  17426. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17427. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17428. if (len == 4) {
  17429. // IPv4
  17430. char buf[INET_ADDRSTRLEN];
  17431. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17432. entry.value = buf;
  17433. } else if (len == 16) {
  17434. // IPv6
  17435. char buf[INET6_ADDRSTRLEN];
  17436. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17437. entry.value = buf;
  17438. }
  17439. }
  17440. break;
  17441. case GEN_EMAIL:
  17442. entry.type = SanType::EMAIL;
  17443. if (gen->d.rfc822Name) {
  17444. entry.value = std::string(
  17445. reinterpret_cast<const char *>(
  17446. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17447. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17448. }
  17449. break;
  17450. case GEN_URI:
  17451. entry.type = SanType::URI;
  17452. if (gen->d.uniformResourceIdentifier) {
  17453. entry.value = std::string(
  17454. reinterpret_cast<const char *>(
  17455. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17456. static_cast<size_t>(
  17457. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17458. }
  17459. break;
  17460. default: entry.type = SanType::OTHER; break;
  17461. }
  17462. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17463. }
  17464. GENERAL_NAMES_free(names);
  17465. return true;
  17466. }
  17467. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17468. time_t &not_after) {
  17469. if (!cert) return false;
  17470. auto x509 = static_cast<X509 *>(cert);
  17471. auto nb = X509_get0_notBefore(x509);
  17472. auto na = X509_get0_notAfter(x509);
  17473. if (!nb || !na) return false;
  17474. ASN1_TIME *epoch = ASN1_TIME_new();
  17475. if (!epoch) return false;
  17476. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17477. if (!ASN1_TIME_set(epoch, 0)) return false;
  17478. int pday, psec;
  17479. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17480. not_before = 86400 * (time_t)pday + psec;
  17481. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17482. not_after = 86400 * (time_t)pday + psec;
  17483. return true;
  17484. }
  17485. inline std::string get_cert_serial(cert_t cert) {
  17486. if (!cert) return "";
  17487. auto x509 = static_cast<X509 *>(cert);
  17488. auto serial = X509_get_serialNumber(x509);
  17489. if (!serial) return "";
  17490. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17491. if (!bn) return "";
  17492. auto hex = BN_bn2hex(bn);
  17493. BN_free(bn);
  17494. if (!hex) return "";
  17495. std::string result(hex);
  17496. OPENSSL_free(hex);
  17497. return result;
  17498. }
  17499. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17500. if (!cert) return false;
  17501. auto x509 = static_cast<X509 *>(cert);
  17502. auto len = i2d_X509(x509, nullptr);
  17503. if (len < 0) return false;
  17504. der.resize(static_cast<size_t>(len));
  17505. auto p = der.data();
  17506. i2d_X509(x509, &p);
  17507. return true;
  17508. }
  17509. inline const char *get_sni(const_session_t session) {
  17510. if (!session) return nullptr;
  17511. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17512. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17513. }
  17514. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17515. inline uint64_t get_error() { return ERR_get_error(); }
  17516. inline std::string error_string(uint64_t code) {
  17517. char buf[256];
  17518. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17519. sizeof(buf));
  17520. return std::string(buf);
  17521. }
  17522. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17523. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17524. if (!mem) { return nullptr; }
  17525. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17526. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17527. if (!inf) { return nullptr; }
  17528. auto store = X509_STORE_new();
  17529. if (store) {
  17530. auto count = sk_X509_INFO_num(inf);
  17531. for (decltype(count) i = 0; i < count; i++) {
  17532. auto itmp = sk_X509_INFO_value(inf, i);
  17533. if (!itmp) { continue; }
  17534. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17535. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17536. }
  17537. }
  17538. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17539. return static_cast<ca_store_t>(store);
  17540. }
  17541. inline void free_ca_store(ca_store_t store) {
  17542. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17543. }
  17544. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17545. if (!ctx || !store) { return false; }
  17546. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17547. auto x509_store = static_cast<X509_STORE *>(store);
  17548. // Check if same store is already set
  17549. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17550. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17551. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17552. return true;
  17553. }
  17554. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17555. certs.clear();
  17556. if (!ctx) { return 0; }
  17557. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17558. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17559. if (!store) { return 0; }
  17560. auto objs = impl::get_store_objects(store);
  17561. if (!objs) { return 0; }
  17562. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17563. auto count = sk_X509_OBJECT_num(objs);
  17564. for (decltype(count) i = 0; i < count; i++) {
  17565. auto obj = sk_X509_OBJECT_value(objs, i);
  17566. if (!obj) { continue; }
  17567. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17568. auto x509 = X509_OBJECT_get0_X509(obj);
  17569. if (x509) {
  17570. // Increment reference count so caller can free it
  17571. X509_up_ref(x509);
  17572. certs.push_back(static_cast<cert_t>(x509));
  17573. }
  17574. }
  17575. }
  17576. return certs.size();
  17577. }
  17578. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17579. std::vector<std::string> names;
  17580. if (!ctx) { return names; }
  17581. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17582. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17583. if (!store) { return names; }
  17584. auto objs = impl::get_store_objects(store);
  17585. if (!objs) { return names; }
  17586. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17587. auto count = sk_X509_OBJECT_num(objs);
  17588. for (decltype(count) i = 0; i < count; i++) {
  17589. auto obj = sk_X509_OBJECT_value(objs, i);
  17590. if (!obj) { continue; }
  17591. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17592. auto x509 = X509_OBJECT_get0_X509(obj);
  17593. if (x509) {
  17594. auto subject = X509_get_subject_name(x509);
  17595. if (subject) {
  17596. char buf[512];
  17597. X509_NAME_oneline(subject, buf, sizeof(buf));
  17598. names.push_back(buf);
  17599. }
  17600. }
  17601. }
  17602. }
  17603. return names;
  17604. }
  17605. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17606. const char *key_pem, const char *password) {
  17607. if (!ctx || !cert_pem || !key_pem) { return false; }
  17608. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17609. // Load certificate from PEM
  17610. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17611. if (!cert_bio) { return false; }
  17612. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17613. BIO_free(cert_bio);
  17614. if (!cert) { return false; }
  17615. // Load private key from PEM
  17616. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17617. if (!key_bio) {
  17618. X509_free(cert);
  17619. return false;
  17620. }
  17621. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17622. password ? const_cast<char *>(password)
  17623. : nullptr);
  17624. BIO_free(key_bio);
  17625. if (!key) {
  17626. X509_free(cert);
  17627. return false;
  17628. }
  17629. // Update certificate and key
  17630. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17631. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17632. X509_free(cert);
  17633. EVP_PKEY_free(key);
  17634. return ret;
  17635. }
  17636. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17637. if (!ctx || !ca_pem) { return false; }
  17638. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17639. // Create new X509_STORE from PEM
  17640. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17641. if (!store) { return false; }
  17642. // A resumed session is not verified again, so the ticket keys from before
  17643. // go, or a client verified under the old CAs could go on resuming.
  17644. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17645. unsigned char ticket_keys[48];
  17646. #else
  17647. unsigned char ticket_keys[80];
  17648. #endif
  17649. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17650. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17651. sizeof(ticket_keys)) != 1) {
  17652. free_ca_store(store);
  17653. return false;
  17654. }
  17655. // SSL_CTX_set_cert_store takes ownership
  17656. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17657. // Set client CA list for client certificate request
  17658. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17659. if (ca_list) {
  17660. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17661. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17662. }
  17663. // The cached sessions go for the same reason.
  17664. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17665. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17666. #else
  17667. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17668. #endif
  17669. return true;
  17670. }
  17671. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17672. if (!ctx) { return false; }
  17673. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17674. auto index = impl::verify_callback_index();
  17675. if (index < 0) { return false; }
  17676. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17677. if (callback) {
  17678. stored = new std::shared_ptr<VerifyCallback>(
  17679. std::make_shared<VerifyCallback>(std::move(callback)));
  17680. }
  17681. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17682. {
  17683. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17684. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17685. SSL_CTX_get_ex_data(ssl_ctx, index));
  17686. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17687. delete stored;
  17688. return false;
  17689. }
  17690. }
  17691. // A handshake running the previous callback keeps it until it returns.
  17692. delete previous;
  17693. // A resumed handshake shows no certificate to run the callback on.
  17694. if (stored) {
  17695. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17696. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17697. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17698. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17699. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17700. #endif
  17701. }
  17702. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17703. auto require =
  17704. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17705. impl::apply_verify_mode(ssl_ctx, require);
  17706. return true;
  17707. }
  17708. inline long get_verify_error(const_session_t session) {
  17709. if (!session) { return -1; }
  17710. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17711. return SSL_get_verify_result(ssl);
  17712. }
  17713. inline std::string verify_error_string(long error_code) {
  17714. if (error_code == X509_V_OK) { return ""; }
  17715. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17716. return str ? str : "unknown error";
  17717. }
  17718. } // namespace tls
  17719. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17720. /*
  17721. * Group 9: TLS abstraction layer - Mbed TLS backend
  17722. */
  17723. /*
  17724. * Mbed TLS Backend Implementation
  17725. */
  17726. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17727. namespace tls {
  17728. namespace impl {
  17729. // Mbed TLS session wrapper
  17730. struct MbedTlsSession {
  17731. mbedtls_ssl_context ssl;
  17732. socket_t sock = INVALID_SOCKET;
  17733. std::string hostname; // For client: set via set_sni
  17734. std::string sni_hostname; // For server: received from client via SNI callback
  17735. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17736. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17737. // (e.g. a response that arrived while this side was still in its post-write
  17738. // check), the byte is pushed back here and served by the next read().
  17739. unsigned char peeked_byte = 0;
  17740. bool has_peeked_byte = false;
  17741. // Set by set_sni() when the caller disabled hostname verification, so the
  17742. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17743. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17744. // OpenSSL and wolfSSL keep them independent).
  17745. bool suppress_hostname_mismatch = false;
  17746. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17747. // ever runs the callback of its own context.
  17748. VerifyCallback verify_callback;
  17749. bool is_server = false;
  17750. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17751. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17752. MbedTlsSession(const MbedTlsSession &) = delete;
  17753. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17754. };
  17755. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17756. // queue)
  17757. inline int &mbedtls_last_error() {
  17758. static thread_local int err = 0;
  17759. return err;
  17760. }
  17761. // Helper to map Mbed TLS error to ErrorCode
  17762. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17763. uint32_t verify_flags) {
  17764. if (ret == 0) { return ErrorCode::Success; }
  17765. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17766. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17767. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17768. return ErrorCode::PeerClosed;
  17769. }
  17770. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17771. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17772. out_errno = errno;
  17773. return ErrorCode::SyscallError;
  17774. }
  17775. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17776. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17777. // the handshake's chain verification (see set_sni()); a mismatch there
  17778. // is reported the same way as any other verify_flags bit. Report it as
  17779. // HostnameMismatch, matching the other backends and the post-handshake
  17780. // identity check below, but only when naming is the sole problem -
  17781. // if the chain itself is also untrusted/expired/etc., that takes
  17782. // priority over the naming detail.
  17783. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17784. return ErrorCode::HostnameMismatch;
  17785. }
  17786. return ErrorCode::CertVerifyFailed;
  17787. }
  17788. return ErrorCode::Fatal;
  17789. }
  17790. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17791. // return value, including the verify-flags-dependent HostnameMismatch
  17792. // mapping; shared by connect() and connect_nonblocking() so the
  17793. // backend_code policy for that mapping only lives in one place.
  17794. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17795. int ret) {
  17796. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17797. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17798. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17799. ? static_cast<uint64_t>(verify_flags)
  17800. : static_cast<uint64_t>(-ret);
  17801. }
  17802. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17803. // non-fatal notification delivered between records, not an error and not
  17804. // application data, so I/O calls that see it should just be retried. Kept in
  17805. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17806. // splitting the closing brace across an #if.
  17807. inline bool mbedtls_is_session_ticket(int ret) {
  17808. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17809. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17810. #else
  17811. (void)ret;
  17812. return false;
  17813. #endif
  17814. }
  17815. // BIO-like send callback for Mbed TLS
  17816. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17817. size_t len) {
  17818. auto sock = *static_cast<socket_t *>(ctx);
  17819. #ifdef _WIN32
  17820. auto ret =
  17821. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17822. if (ret == SOCKET_ERROR) {
  17823. int err = WSAGetLastError();
  17824. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17825. return MBEDTLS_ERR_NET_SEND_FAILED;
  17826. }
  17827. #else
  17828. auto ret = send(sock, buf, len, 0);
  17829. if (ret < 0) {
  17830. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17831. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17832. }
  17833. return MBEDTLS_ERR_NET_SEND_FAILED;
  17834. }
  17835. #endif
  17836. return static_cast<int>(ret);
  17837. }
  17838. // BIO-like recv callback for Mbed TLS
  17839. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17840. auto sock = *static_cast<socket_t *>(ctx);
  17841. #ifdef _WIN32
  17842. auto ret =
  17843. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17844. if (ret == SOCKET_ERROR) {
  17845. int err = WSAGetLastError();
  17846. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17847. return MBEDTLS_ERR_NET_RECV_FAILED;
  17848. }
  17849. #else
  17850. auto ret = recv(sock, buf, len, 0);
  17851. if (ret < 0) {
  17852. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17853. return MBEDTLS_ERR_SSL_WANT_READ;
  17854. }
  17855. return MBEDTLS_ERR_NET_RECV_FAILED;
  17856. }
  17857. #endif
  17858. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17859. return static_cast<int>(ret);
  17860. }
  17861. // MbedTlsContext constructor/destructor implementations
  17862. inline MbedTlsContext::MbedTlsContext() {
  17863. mbedtls_ssl_config_init(&conf);
  17864. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17865. mbedtls_entropy_init(&entropy);
  17866. mbedtls_ctr_drbg_init(&ctr_drbg);
  17867. #endif
  17868. mbedtls_x509_crt_init(&ca_chain);
  17869. mbedtls_x509_crt_init(&own_cert);
  17870. mbedtls_pk_init(&own_key);
  17871. }
  17872. inline MbedTlsContext::~MbedTlsContext() {
  17873. mbedtls_pk_free(&own_key);
  17874. mbedtls_x509_crt_free(&own_cert);
  17875. mbedtls_x509_crt_free(&ca_chain);
  17876. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17877. mbedtls_ctr_drbg_free(&ctr_drbg);
  17878. mbedtls_entropy_free(&entropy);
  17879. #endif
  17880. mbedtls_ssl_config_free(&conf);
  17881. }
  17882. // Thread-local storage for SNI captured during handshake
  17883. // This is needed because the SNI callback doesn't have a way to pass
  17884. // session-specific data before the session is fully set up
  17885. inline std::string &mbedpending_sni() {
  17886. static thread_local std::string sni;
  17887. return sni;
  17888. }
  17889. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17890. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17891. const unsigned char *name, size_t name_len) {
  17892. (void)p_ctx;
  17893. (void)ssl;
  17894. // Store SNI name in thread-local storage
  17895. // It will be retrieved and stored in the session after handshake
  17896. if (name && name_len > 0) {
  17897. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17898. } else {
  17899. mbedpending_sni().clear();
  17900. }
  17901. return 0; // Accept any SNI
  17902. }
  17903. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17904. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17905. }
  17906. // MbedTLS verify callback wrapper
  17907. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17908. int cert_depth, uint32_t *flags) {
  17909. // data points to the MbedTlsSession
  17910. auto *session = static_cast<MbedTlsSession *>(data);
  17911. // set_sni() disabled hostname verification for this session: ignore the
  17912. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  17913. // pass/fail decision still comes from the remaining flags (and, below, from
  17914. // the user's own verify callback).
  17915. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17916. const auto &callback = session->verify_callback;
  17917. if (!callback) { return 0; } // Continue with default verification
  17918. // Build context
  17919. VerifyContext verify_ctx;
  17920. verify_ctx.session = static_cast<session_t>(session);
  17921. verify_ctx.cert = static_cast<cert_t>(crt);
  17922. verify_ctx.depth = cert_depth;
  17923. verify_ctx.preverify_ok = (*flags == 0);
  17924. verify_ctx.error_code = static_cast<long>(*flags);
  17925. // Convert Mbed TLS flags to error string
  17926. static thread_local char error_buf[256];
  17927. if (*flags != 0) {
  17928. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17929. verify_ctx.error_string = error_buf;
  17930. } else {
  17931. verify_ctx.error_string = nullptr;
  17932. }
  17933. bool accepted = run_verify_callback(callback, verify_ctx);
  17934. if (accepted) {
  17935. // Overrides the built-in verification only on a server, as on OpenSSL and
  17936. // wolfSSL, whose clients check the verify result after the handshake
  17937. if (session->is_server) { *flags = 0; }
  17938. return 0;
  17939. }
  17940. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17941. }
  17942. // Sets the authentication mode from whether the peer's certificate is required
  17943. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  17944. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  17945. inline void apply_verify_mode(MbedTlsContext &mctx) {
  17946. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  17947. if (mctx.verify_client) {
  17948. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  17949. } else if (mctx.verify_callback) {
  17950. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  17951. }
  17952. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  17953. }
  17954. } // namespace impl
  17955. inline ctx_t create_client_context() {
  17956. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17957. if (!ctx) { return nullptr; }
  17958. ctx->is_server = false;
  17959. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17960. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17961. if (!detail::ensure_mbedtls_psa_crypto()) {
  17962. delete ctx;
  17963. return nullptr;
  17964. }
  17965. int ret;
  17966. #else
  17967. // Seed the random number generator
  17968. const char *pers = "httplib_client";
  17969. int ret = mbedtls_ctr_drbg_seed(
  17970. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17971. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17972. if (ret != 0) {
  17973. impl::mbedtls_last_error() = ret;
  17974. delete ctx;
  17975. return nullptr;
  17976. }
  17977. #endif
  17978. // Set up SSL config for client
  17979. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17980. MBEDTLS_SSL_TRANSPORT_STREAM,
  17981. MBEDTLS_SSL_PRESET_DEFAULT);
  17982. if (ret != 0) {
  17983. impl::mbedtls_last_error() = ret;
  17984. delete ctx;
  17985. return nullptr;
  17986. }
  17987. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17988. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17989. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17990. #endif
  17991. // Default: verify peer certificate
  17992. ctx->verify_client = true;
  17993. impl::apply_verify_mode(*ctx);
  17994. // Set minimum TLS version to 1.2
  17995. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17996. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17997. #else
  17998. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17999. MBEDTLS_SSL_MINOR_VERSION_3);
  18000. #endif
  18001. return static_cast<ctx_t>(ctx);
  18002. }
  18003. inline ctx_t create_server_context() {
  18004. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18005. if (!ctx) { return nullptr; }
  18006. ctx->is_server = true;
  18007. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18008. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18009. if (!detail::ensure_mbedtls_psa_crypto()) {
  18010. delete ctx;
  18011. return nullptr;
  18012. }
  18013. int ret;
  18014. #else
  18015. // Seed the random number generator
  18016. const char *pers = "httplib_server";
  18017. int ret = mbedtls_ctr_drbg_seed(
  18018. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18019. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18020. if (ret != 0) {
  18021. impl::mbedtls_last_error() = ret;
  18022. delete ctx;
  18023. return nullptr;
  18024. }
  18025. #endif
  18026. // Set up SSL config for server
  18027. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18028. MBEDTLS_SSL_TRANSPORT_STREAM,
  18029. MBEDTLS_SSL_PRESET_DEFAULT);
  18030. if (ret != 0) {
  18031. impl::mbedtls_last_error() = ret;
  18032. delete ctx;
  18033. return nullptr;
  18034. }
  18035. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18036. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18037. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18038. #endif
  18039. // Default: don't verify client
  18040. impl::apply_verify_mode(*ctx);
  18041. // Set minimum TLS version to 1.2
  18042. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18043. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18044. #else
  18045. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18046. MBEDTLS_SSL_MINOR_VERSION_3);
  18047. #endif
  18048. // Set SNI callback to capture client's SNI hostname
  18049. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18050. return static_cast<ctx_t>(ctx);
  18051. }
  18052. inline void free_context(ctx_t ctx) {
  18053. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18054. }
  18055. inline bool set_min_version(ctx_t ctx, Version version) {
  18056. if (!ctx) { return false; }
  18057. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18058. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18059. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18060. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18061. if (version >= Version::TLS1_3) {
  18062. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18063. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18064. #endif
  18065. }
  18066. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18067. #else
  18068. // Mbed TLS 2.x uses major/minor version numbers
  18069. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18070. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18071. if (version >= Version::TLS1_3) {
  18072. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18073. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18074. #else
  18075. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18076. #endif
  18077. }
  18078. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18079. #endif
  18080. return true;
  18081. }
  18082. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18083. if (!ctx || !pem) { return false; }
  18084. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18085. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18086. // Add null terminator if not present
  18087. std::string pem_str(pem, len);
  18088. int ret = mbedtls_x509_crt_parse(
  18089. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18090. pem_str.size() + 1);
  18091. if (ret != 0) {
  18092. impl::mbedtls_last_error() = ret;
  18093. return false;
  18094. }
  18095. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18096. return true;
  18097. }
  18098. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18099. if (!ctx || !file_path) { return false; }
  18100. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18101. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18102. if (ret != 0) {
  18103. impl::mbedtls_last_error() = ret;
  18104. return false;
  18105. }
  18106. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18107. return true;
  18108. }
  18109. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18110. if (!ctx || !dir_path) { return false; }
  18111. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18112. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18113. if (ret < 0) { // Returns number of certs on success, negative on error
  18114. impl::mbedtls_last_error() = ret;
  18115. return false;
  18116. }
  18117. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18118. return true;
  18119. }
  18120. inline bool load_system_certs(ctx_t ctx) {
  18121. if (!ctx) { return false; }
  18122. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18123. bool loaded = false;
  18124. #ifdef _WIN32
  18125. loaded = impl::enumerate_windows_system_certs(
  18126. [&](const unsigned char *data, size_t len) {
  18127. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18128. });
  18129. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18130. loaded = impl::enumerate_macos_keychain_certs(
  18131. [&](const unsigned char *data, size_t len) {
  18132. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18133. });
  18134. #else
  18135. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18136. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18137. loaded = true;
  18138. break;
  18139. }
  18140. }
  18141. if (!loaded) {
  18142. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18143. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18144. loaded = true;
  18145. break;
  18146. }
  18147. }
  18148. }
  18149. #endif
  18150. if (loaded) {
  18151. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18152. }
  18153. return loaded;
  18154. }
  18155. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18156. const char *password) {
  18157. if (!ctx || !cert || !key) { return false; }
  18158. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18159. // Parse certificate
  18160. std::string cert_str(cert);
  18161. int ret = mbedtls_x509_crt_parse(
  18162. &mctx->own_cert,
  18163. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18164. cert_str.size() + 1);
  18165. if (ret != 0) {
  18166. impl::mbedtls_last_error() = ret;
  18167. return false;
  18168. }
  18169. // Parse private key
  18170. std::string key_str(key);
  18171. const unsigned char *pwd =
  18172. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18173. size_t pwd_len = password ? strlen(password) : 0;
  18174. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18175. ret = mbedtls_pk_parse_key(
  18176. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18177. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18178. &mctx->ctr_drbg);
  18179. #else
  18180. ret = mbedtls_pk_parse_key(
  18181. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18182. key_str.size() + 1, pwd, pwd_len);
  18183. #endif
  18184. if (ret != 0) {
  18185. impl::mbedtls_last_error() = ret;
  18186. return false;
  18187. }
  18188. // Verify that the certificate and private key match.
  18189. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18190. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18191. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18192. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18193. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18194. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18195. #else
  18196. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18197. #endif
  18198. if (ret != 0) {
  18199. impl::mbedtls_last_error() = ret;
  18200. return false;
  18201. }
  18202. #endif
  18203. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18204. if (ret != 0) {
  18205. impl::mbedtls_last_error() = ret;
  18206. return false;
  18207. }
  18208. return true;
  18209. }
  18210. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18211. const char *key_path, const char *password) {
  18212. if (!ctx || !cert_path || !key_path) { return false; }
  18213. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18214. // Parse certificate file
  18215. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18216. if (ret != 0) {
  18217. impl::mbedtls_last_error() = ret;
  18218. return false;
  18219. }
  18220. // Parse private key file
  18221. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18222. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18223. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18224. #else
  18225. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18226. #endif
  18227. if (ret != 0) {
  18228. impl::mbedtls_last_error() = ret;
  18229. return false;
  18230. }
  18231. // Verify that the certificate and private key match.
  18232. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18233. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18234. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18235. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18236. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18237. #else
  18238. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18239. #endif
  18240. if (ret != 0) {
  18241. impl::mbedtls_last_error() = ret;
  18242. return false;
  18243. }
  18244. #endif
  18245. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18246. if (ret != 0) {
  18247. impl::mbedtls_last_error() = ret;
  18248. return false;
  18249. }
  18250. return true;
  18251. }
  18252. inline void set_verify_client(ctx_t ctx, bool require) {
  18253. if (!ctx) { return; }
  18254. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18255. mctx->verify_client = require;
  18256. impl::apply_verify_mode(*mctx);
  18257. }
  18258. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18259. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18260. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18261. auto session = new (std::nothrow) impl::MbedTlsSession();
  18262. if (!session) { return nullptr; }
  18263. session->sock = sock;
  18264. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18265. if (ret != 0) {
  18266. impl::mbedtls_last_error() = ret;
  18267. delete session;
  18268. return nullptr;
  18269. }
  18270. // Explicitly opt out of in-handshake hostname verification by default;
  18271. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18272. // fails outright when no hostname was set. set_sni() installs the real
  18273. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18274. // caller verifies the certificate identity post-handshake via
  18275. // verify_hostname().
  18276. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18277. // Set BIO callbacks
  18278. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18279. impl::mbedtls_net_recv_cb, nullptr);
  18280. // Installed always, as it also masks the hostname mismatch that set_sni()
  18281. // may ask for. The session runs its own copy of the user's callback, which
  18282. // set_verify_callback() cannot replace under a handshake.
  18283. session->verify_callback = mctx->verify_callback;
  18284. session->is_server = mctx->is_server;
  18285. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18286. return static_cast<session_t>(session);
  18287. }
  18288. inline void free_session(session_t session) {
  18289. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18290. }
  18291. inline bool set_sni(session_t session, const char *hostname,
  18292. bool verify_hostname) {
  18293. if (!session || !hostname) { return false; }
  18294. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18295. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18296. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18297. // independently, so a disabled hostname check is handled below by masking
  18298. // the resulting mismatch flag instead of skipping this call.
  18299. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18300. if (ret != 0) {
  18301. impl::mbedtls_last_error() = ret;
  18302. return false;
  18303. }
  18304. msession->hostname = hostname;
  18305. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18306. return true;
  18307. }
  18308. inline TlsError connect(session_t session) {
  18309. TlsError err;
  18310. if (!session) {
  18311. err.code = ErrorCode::Fatal;
  18312. return err;
  18313. }
  18314. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18315. int ret;
  18316. do {
  18317. ret = mbedtls_ssl_handshake(&msession->ssl);
  18318. } while (impl::mbedtls_is_session_ticket(ret));
  18319. if (ret == 0) {
  18320. err.code = ErrorCode::Success;
  18321. } else {
  18322. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18323. impl::mbedtls_last_error() = ret;
  18324. }
  18325. return err;
  18326. }
  18327. inline TlsError accept(session_t session) {
  18328. // Same as connect for Mbed TLS - handshake works for both client and server
  18329. auto result = connect(session);
  18330. // After successful handshake, capture SNI from thread-local storage
  18331. if (result.code == ErrorCode::Success && session) {
  18332. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18333. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18334. impl::mbedpending_sni().clear();
  18335. }
  18336. return result;
  18337. }
  18338. inline bool connect_nonblocking(session_t session, socket_t sock,
  18339. time_t timeout_sec, time_t timeout_usec,
  18340. TlsError *err) {
  18341. if (!session) {
  18342. if (err) { err->code = ErrorCode::Fatal; }
  18343. return false;
  18344. }
  18345. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18346. // Set socket to non-blocking mode
  18347. detail::set_nonblocking(sock, true);
  18348. auto cleanup =
  18349. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18350. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18351. int ret;
  18352. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18353. // Non-fatal TLS 1.3 ticket; retry immediately.
  18354. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18355. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18356. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18357. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18358. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18359. }
  18360. // TlsError or timeout
  18361. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18362. impl::mbedtls_last_error() = ret;
  18363. return false;
  18364. }
  18365. if (err) { err->code = ErrorCode::Success; }
  18366. return true;
  18367. }
  18368. inline bool accept_nonblocking(session_t session, socket_t sock,
  18369. time_t timeout_sec, time_t timeout_usec,
  18370. TlsError *err) {
  18371. // Same implementation as connect for Mbed TLS
  18372. bool result =
  18373. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18374. // After successful handshake, capture SNI from thread-local storage
  18375. if (result && session) {
  18376. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18377. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18378. impl::mbedpending_sni().clear();
  18379. }
  18380. return result;
  18381. }
  18382. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18383. if (!session || !buf) {
  18384. err.code = ErrorCode::Fatal;
  18385. return -1;
  18386. }
  18387. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18388. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18389. if (msession->has_peeked_byte) {
  18390. if (len == 0) { return 0; }
  18391. auto p = static_cast<unsigned char *>(buf);
  18392. p[0] = msession->peeked_byte;
  18393. msession->has_peeked_byte = false;
  18394. size_t n = 1;
  18395. // Top up with any already-decrypted bytes without risking a block.
  18396. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18397. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18398. if (extra > 0) { n += static_cast<size_t>(extra); }
  18399. }
  18400. err.code = ErrorCode::Success;
  18401. return static_cast<ssize_t>(n);
  18402. }
  18403. int ret;
  18404. do {
  18405. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18406. len);
  18407. } while (impl::mbedtls_is_session_ticket(ret));
  18408. if (ret > 0) {
  18409. err.code = ErrorCode::Success;
  18410. return static_cast<ssize_t>(ret);
  18411. }
  18412. if (ret == 0) {
  18413. err.code = ErrorCode::PeerClosed;
  18414. return 0;
  18415. }
  18416. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18417. err.backend_code = static_cast<uint64_t>(-ret);
  18418. impl::mbedtls_last_error() = ret;
  18419. // mbedTLS signals a clean close_notify via a negative error code rather
  18420. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18421. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18422. return -1;
  18423. }
  18424. inline ssize_t write(session_t session, const void *buf, size_t len,
  18425. TlsError &err) {
  18426. if (!session || !buf) {
  18427. err.code = ErrorCode::Fatal;
  18428. return -1;
  18429. }
  18430. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18431. int ret;
  18432. do {
  18433. ret = mbedtls_ssl_write(&msession->ssl,
  18434. static_cast<const unsigned char *>(buf), len);
  18435. } while (impl::mbedtls_is_session_ticket(ret));
  18436. if (ret > 0) {
  18437. err.code = ErrorCode::Success;
  18438. return static_cast<ssize_t>(ret);
  18439. }
  18440. if (ret == 0) {
  18441. err.code = ErrorCode::PeerClosed;
  18442. return 0;
  18443. }
  18444. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18445. err.backend_code = static_cast<uint64_t>(-ret);
  18446. impl::mbedtls_last_error() = ret;
  18447. return -1;
  18448. }
  18449. inline int pending(const_session_t session) {
  18450. if (!session) { return 0; }
  18451. auto msession =
  18452. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18453. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18454. (msession->has_peeked_byte ? 1 : 0);
  18455. }
  18456. inline void shutdown(session_t session, bool graceful) {
  18457. if (!session) { return; }
  18458. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18459. if (graceful) {
  18460. // Try to send close_notify, but don't block forever
  18461. int ret;
  18462. int attempts = 0;
  18463. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18464. attempts < 3) {
  18465. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18466. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18467. break;
  18468. }
  18469. attempts++;
  18470. }
  18471. }
  18472. }
  18473. inline bool is_peer_closed(session_t session, socket_t sock) {
  18474. if (!session || sock == INVALID_SOCKET) { return true; }
  18475. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18476. // Check if there's already decrypted or pushed-back data available.
  18477. // If so, the connection is definitely alive.
  18478. if (msession->has_peeked_byte ||
  18479. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18480. return false;
  18481. }
  18482. // Set socket to non-blocking to avoid blocking on read
  18483. detail::set_nonblocking(sock, true);
  18484. auto cleanup =
  18485. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18486. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18487. // on application data — e.g. a response that already arrived — push the
  18488. // byte back so the next read() delivers it instead of losing it.
  18489. unsigned char buf;
  18490. int ret;
  18491. do {
  18492. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18493. } while (impl::mbedtls_is_session_ticket(ret));
  18494. // If we got data or WANT_READ (would block), connection is alive
  18495. if (ret > 0) {
  18496. msession->peeked_byte = buf;
  18497. msession->has_peeked_byte = true;
  18498. return false;
  18499. }
  18500. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18501. // If we get a peer close notify or a connection reset, the peer is closed
  18502. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18503. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18504. }
  18505. inline cert_t get_peer_cert(const_session_t session) {
  18506. if (!session) { return nullptr; }
  18507. auto msession =
  18508. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18509. // Mbed TLS returns a pointer to the internal peer cert chain.
  18510. // WARNING: This pointer is only valid while the session is active.
  18511. // Do not use the certificate after calling free_session().
  18512. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18513. return const_cast<mbedtls_x509_crt *>(cert);
  18514. }
  18515. inline size_t get_peer_certs(const_session_t session,
  18516. std::vector<cert_t> &certs) {
  18517. certs.clear();
  18518. // Mbed TLS parses the whole received chain into a list headed by the peer
  18519. // certificate, owned by the session like get_peer_cert()'s result
  18520. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18521. crt && crt->raw.len > 0; crt = crt->next) {
  18522. certs.push_back(static_cast<cert_t>(crt));
  18523. }
  18524. return certs.size();
  18525. }
  18526. inline void free_cert(cert_t cert) {
  18527. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18528. // chain, so there is nothing to free. Callers still call this for the other
  18529. // backends.
  18530. (void)cert;
  18531. }
  18532. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18533. if (!cert || !hostname) { return false; }
  18534. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18535. std::string host_str(hostname);
  18536. // Check if hostname is an IP address (IPv4 or IPv6)
  18537. unsigned char ip_bytes[16];
  18538. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18539. auto is_ip = ip_len > 0;
  18540. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18541. // in buf.tag and the raw value in buf.p / buf.len.
  18542. auto has_dns_san = false;
  18543. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18544. if (!san->buf.p || san->buf.len == 0) { continue; }
  18545. const unsigned char *p = san->buf.p;
  18546. size_t len = san->buf.len;
  18547. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18548. if (is_ip) {
  18549. // For an IP host, only a matching iPAddress SAN of the same family
  18550. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18551. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18552. memcmp(p, ip_bytes, ip_len) == 0) {
  18553. return true;
  18554. }
  18555. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18556. has_dns_san = true;
  18557. std::string san_name(reinterpret_cast<const char *>(p), len);
  18558. if (detail::match_hostname(san_name, host_str)) { return true; }
  18559. }
  18560. }
  18561. // Fallback: the Common Names (CN) in the subject, as X509_check_host does it:
  18562. // never for an IP host, which only an iPAddress SAN names, and never next to
  18563. // a DNS SAN (RFC 6125 6.4.4).
  18564. if (is_ip || has_dns_san) { return false; }
  18565. for (auto name = &mcert->subject; name; name = name->next) {
  18566. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18567. std::string cn(reinterpret_cast<const char *>(name->val.p),
  18568. name->val.len);
  18569. if (detail::match_hostname(cn, host_str)) { return true; }
  18570. }
  18571. }
  18572. return false;
  18573. }
  18574. inline uint64_t hostname_mismatch_code() {
  18575. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18576. }
  18577. inline long get_verify_result(const_session_t session) {
  18578. if (!session) { return -1; }
  18579. auto msession =
  18580. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18581. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18582. // Return 0 (X509_V_OK equivalent) if verification passed
  18583. return flags == 0 ? 0 : static_cast<long>(flags);
  18584. }
  18585. inline std::string get_cert_subject_cn(cert_t cert) {
  18586. if (!cert) return "";
  18587. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18588. // Find the CN in the subject
  18589. const mbedtls_x509_name *name = &x509->subject;
  18590. while (name != nullptr) {
  18591. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18592. return std::string(reinterpret_cast<const char *>(name->val.p),
  18593. name->val.len);
  18594. }
  18595. name = name->next;
  18596. }
  18597. return "";
  18598. }
  18599. inline std::string get_cert_issuer_name(cert_t cert) {
  18600. if (!cert) return "";
  18601. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18602. // Build a human-readable issuer name string
  18603. char buf[512];
  18604. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18605. if (ret < 0) return "";
  18606. return std::string(buf);
  18607. }
  18608. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18609. sans.clear();
  18610. if (!cert) return false;
  18611. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18612. // Parse the Subject Alternative Name extension
  18613. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18614. while (cur != nullptr) {
  18615. if (cur->buf.len > 0) {
  18616. const unsigned char *p = cur->buf.p;
  18617. size_t value_len = cur->buf.len;
  18618. SanEntry entry;
  18619. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18620. case MBEDTLS_X509_SAN_DNS_NAME:
  18621. entry.type = SanType::DNS;
  18622. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18623. break;
  18624. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18625. entry.type = SanType::IP;
  18626. if (value_len == 4) {
  18627. // IPv4
  18628. char buf[16];
  18629. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18630. entry.value = buf;
  18631. } else if (value_len == 16) {
  18632. // IPv6
  18633. char buf[64];
  18634. snprintf(buf, sizeof(buf),
  18635. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18636. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18637. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18638. p[10], p[11], p[12], p[13], p[14], p[15]);
  18639. entry.value = buf;
  18640. }
  18641. break;
  18642. case MBEDTLS_X509_SAN_RFC822_NAME:
  18643. entry.type = SanType::EMAIL;
  18644. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18645. break;
  18646. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18647. entry.type = SanType::URI;
  18648. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18649. break;
  18650. default: entry.type = SanType::OTHER; break;
  18651. }
  18652. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18653. }
  18654. cur = cur->next;
  18655. }
  18656. return true;
  18657. }
  18658. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18659. time_t &not_after) {
  18660. if (!cert) return false;
  18661. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18662. // Convert mbedtls_x509_time to time_t
  18663. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18664. struct tm tm_time = {};
  18665. tm_time.tm_year = t.year - 1900;
  18666. tm_time.tm_mon = t.mon - 1;
  18667. tm_time.tm_mday = t.day;
  18668. tm_time.tm_hour = t.hour;
  18669. tm_time.tm_min = t.min;
  18670. tm_time.tm_sec = t.sec;
  18671. #ifdef _WIN32
  18672. return _mkgmtime(&tm_time);
  18673. #else
  18674. return timegm(&tm_time);
  18675. #endif
  18676. };
  18677. not_before = to_time_t(x509->valid_from);
  18678. not_after = to_time_t(x509->valid_to);
  18679. return true;
  18680. }
  18681. inline std::string get_cert_serial(cert_t cert) {
  18682. if (!cert) return "";
  18683. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18684. // Convert serial number to hex string
  18685. std::string result;
  18686. result.reserve(x509->serial.len * 2);
  18687. for (size_t i = 0; i < x509->serial.len; i++) {
  18688. char hex[3];
  18689. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18690. result += hex;
  18691. }
  18692. return result;
  18693. }
  18694. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18695. if (!cert) return false;
  18696. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18697. if (!crt->raw.p || crt->raw.len == 0) return false;
  18698. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18699. return true;
  18700. }
  18701. inline const char *get_sni(const_session_t session) {
  18702. if (!session) return nullptr;
  18703. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18704. // For server: return SNI received from client during handshake
  18705. if (!msession->sni_hostname.empty()) {
  18706. return msession->sni_hostname.c_str();
  18707. }
  18708. // For client: return the hostname set via set_sni
  18709. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18710. return nullptr;
  18711. }
  18712. inline uint64_t peek_error() {
  18713. // Mbed TLS doesn't have an error queue, return the last error
  18714. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18715. }
  18716. inline uint64_t get_error() {
  18717. // Mbed TLS doesn't have an error queue, return and clear the last error
  18718. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18719. impl::mbedtls_last_error() = 0;
  18720. return err;
  18721. }
  18722. inline std::string error_string(uint64_t code) {
  18723. char buf[256];
  18724. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18725. return std::string(buf);
  18726. }
  18727. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18728. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18729. if (!ca_chain) { return nullptr; }
  18730. mbedtls_x509_crt_init(ca_chain);
  18731. // mbedtls_x509_crt_parse expects null-terminated PEM
  18732. int ret = mbedtls_x509_crt_parse(ca_chain,
  18733. reinterpret_cast<const unsigned char *>(pem),
  18734. len + 1); // +1 for null terminator
  18735. if (ret != 0) {
  18736. // Try without +1 in case PEM is already null-terminated
  18737. ret = mbedtls_x509_crt_parse(
  18738. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18739. if (ret != 0) {
  18740. mbedtls_x509_crt_free(ca_chain);
  18741. delete ca_chain;
  18742. return nullptr;
  18743. }
  18744. }
  18745. return static_cast<ca_store_t>(ca_chain);
  18746. }
  18747. inline void free_ca_store(ca_store_t store) {
  18748. if (store) {
  18749. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18750. mbedtls_x509_crt_free(ca_chain);
  18751. delete ca_chain;
  18752. }
  18753. }
  18754. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18755. if (!ctx || !store) { return false; }
  18756. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18757. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18758. // Free existing CA chain
  18759. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18760. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18761. // Copy the CA chain (deep copy)
  18762. // Parse from the raw data of the source cert
  18763. mbedtls_x509_crt *src = ca_chain;
  18764. while (src != nullptr) {
  18765. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18766. src->raw.len);
  18767. if (ret != 0) {
  18768. free_ca_store(store);
  18769. return false;
  18770. }
  18771. src = src->next;
  18772. }
  18773. // This function takes ownership of the store; the chain was deep-copied
  18774. // above, so release the source
  18775. free_ca_store(store);
  18776. // Update the SSL config to use the new CA chain
  18777. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18778. return true;
  18779. }
  18780. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18781. certs.clear();
  18782. if (!ctx) { return 0; }
  18783. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18784. // Owned by the context; see free_cert()
  18785. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18786. cert = cert->next) {
  18787. certs.push_back(static_cast<cert_t>(cert));
  18788. }
  18789. return certs.size();
  18790. }
  18791. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18792. std::vector<std::string> names;
  18793. if (!ctx) { return names; }
  18794. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18795. // Iterate through the CA chain
  18796. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18797. while (cert != nullptr && cert->raw.len > 0) {
  18798. char buf[512];
  18799. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18800. if (ret > 0) { names.push_back(buf); }
  18801. cert = cert->next;
  18802. }
  18803. return names;
  18804. }
  18805. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18806. const char *key_pem, const char *password) {
  18807. if (!ctx || !cert_pem || !key_pem) { return false; }
  18808. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18809. // Parse into new objects first, so that a bad pair leaves the old one in
  18810. // place, and swap them in after; the old ones are freed on the way out.
  18811. mbedtls_x509_crt cert;
  18812. mbedtls_pk_context key;
  18813. mbedtls_x509_crt_init(&cert);
  18814. mbedtls_pk_init(&key);
  18815. auto se = detail::scope_exit([&] {
  18816. mbedtls_x509_crt_free(&cert);
  18817. mbedtls_pk_free(&key);
  18818. });
  18819. // Parse certificate PEM
  18820. int ret = mbedtls_x509_crt_parse(
  18821. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18822. strlen(cert_pem) + 1);
  18823. if (ret != 0) {
  18824. impl::mbedtls_last_error() = ret;
  18825. return false;
  18826. }
  18827. // Parse private key PEM
  18828. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18829. ret = mbedtls_pk_parse_key(
  18830. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18831. strlen(key_pem) + 1,
  18832. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18833. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18834. &mbed_ctx->ctr_drbg);
  18835. #else
  18836. ret = mbedtls_pk_parse_key(
  18837. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18838. strlen(key_pem) + 1,
  18839. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18840. password ? strlen(password) : 0);
  18841. #endif
  18842. if (ret != 0) {
  18843. impl::mbedtls_last_error() = ret;
  18844. return false;
  18845. }
  18846. std::swap(mbed_ctx->own_cert, cert);
  18847. std::swap(mbed_ctx->own_key, key);
  18848. // Configure SSL to use the new certificate and key
  18849. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18850. &mbed_ctx->own_key);
  18851. if (ret != 0) {
  18852. impl::mbedtls_last_error() = ret;
  18853. return false;
  18854. }
  18855. return true;
  18856. }
  18857. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18858. if (!ctx || !ca_pem) { return false; }
  18859. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18860. // Parse into a new chain first, so that a bad one leaves the old in place
  18861. mbedtls_x509_crt chain;
  18862. mbedtls_x509_crt_init(&chain);
  18863. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18864. // Parse CA PEM
  18865. int ret = mbedtls_x509_crt_parse(
  18866. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18867. strlen(ca_pem) + 1);
  18868. if (ret != 0) {
  18869. impl::mbedtls_last_error() = ret;
  18870. return false;
  18871. }
  18872. std::swap(mbed_ctx->ca_chain, chain);
  18873. // Update SSL config to use new CA chain
  18874. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18875. return true;
  18876. }
  18877. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18878. if (!ctx) { return false; }
  18879. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18880. // create_session() hands each session its own copy to run.
  18881. mbed_ctx->verify_callback = std::move(callback);
  18882. impl::apply_verify_mode(*mbed_ctx);
  18883. return true;
  18884. }
  18885. inline long get_verify_error(const_session_t session) {
  18886. if (!session) { return -1; }
  18887. auto *msession =
  18888. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18889. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18890. }
  18891. inline std::string verify_error_string(long error_code) {
  18892. if (error_code == 0) { return ""; }
  18893. char buf[256];
  18894. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18895. static_cast<uint32_t>(error_code));
  18896. // Remove trailing newline if present
  18897. std::string result(buf);
  18898. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18899. result.pop_back();
  18900. }
  18901. return result;
  18902. }
  18903. } // namespace tls
  18904. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18905. /*
  18906. * Group 10: TLS abstraction layer - wolfSSL backend
  18907. */
  18908. /*
  18909. * wolfSSL Backend Implementation
  18910. */
  18911. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18912. namespace tls {
  18913. namespace impl {
  18914. // wolfSSL session wrapper
  18915. struct WolfSSLSession {
  18916. WOLFSSL *ssl = nullptr;
  18917. socket_t sock = INVALID_SOCKET;
  18918. std::string hostname; // For client: set via set_sni
  18919. std::string sni_hostname; // For server: received from client via SNI callback
  18920. WolfSSLSession() = default;
  18921. ~WolfSSLSession() {
  18922. if (ssl) { wolfSSL_free(ssl); }
  18923. }
  18924. WolfSSLSession(const WolfSSLSession &) = delete;
  18925. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18926. };
  18927. // Thread-local error code accessor for wolfSSL
  18928. inline uint64_t &wolfssl_last_error() {
  18929. static thread_local uint64_t err = 0;
  18930. return err;
  18931. }
  18932. // Helper to map wolfSSL error to ErrorCode.
  18933. // ssl_error is the value from wolfSSL_get_error().
  18934. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18935. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18936. int &out_errno) {
  18937. switch (ssl_error) {
  18938. case SSL_ERROR_NONE: return ErrorCode::Success;
  18939. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18940. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18941. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18942. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18943. default:
  18944. if (ssl) {
  18945. // wolfSSL stores the low-level error code as a negative value.
  18946. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18947. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18948. if (low_err == DOMAIN_NAME_MISMATCH) {
  18949. return ErrorCode::HostnameMismatch;
  18950. }
  18951. // Check verify result to distinguish cert verification from generic SSL
  18952. // errors.
  18953. long vr = wolfSSL_get_verify_result(ssl);
  18954. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18955. }
  18956. return ErrorCode::Fatal;
  18957. }
  18958. }
  18959. // WolfSSLContext constructor/destructor implementations
  18960. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18961. inline WolfSSLContext::~WolfSSLContext() {
  18962. if (ctx) { wolfSSL_CTX_free(ctx); }
  18963. }
  18964. // Thread-local storage for SNI captured during handshake
  18965. inline std::string &wolfssl_pending_sni() {
  18966. static thread_local std::string sni;
  18967. return sni;
  18968. }
  18969. // SNI callback for wolfSSL server to capture client's SNI hostname
  18970. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18971. (void)ret;
  18972. (void)exArg;
  18973. void *name_data = nullptr;
  18974. unsigned short name_len =
  18975. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18976. if (name_data && name_len > 0) {
  18977. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18978. name_len);
  18979. } else {
  18980. wolfssl_pending_sni().clear();
  18981. }
  18982. return 0; // Continue regardless
  18983. }
  18984. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18985. // runs the verify callback of its own context.
  18986. inline int context_ex_data_index() {
  18987. static const auto index =
  18988. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18989. return index;
  18990. }
  18991. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18992. // other tls:: function takes.
  18993. inline int session_ex_data_index() {
  18994. static const auto index =
  18995. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18996. return index;
  18997. }
  18998. // A resumed session skips the client's certificate, so a server that checks
  18999. // one would let in a certificate checked against another server's CA, as
  19000. // wolfSSL shares its session cache between contexts, or against a CA since
  19001. // replaced by update_server_client_ca().
  19002. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19003. if (!wctx->is_server) { return; }
  19004. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19005. #ifdef HAVE_SESSION_TICKET
  19006. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19007. #endif
  19008. }
  19009. // wolfSSL verify callback wrapper
  19010. inline int wolfssl_verify_callback(int preverify_ok,
  19011. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19012. // Get the WOLFSSL object from the X509_STORE_CTX
  19013. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19014. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19015. if (!ssl) { return preverify_ok; }
  19016. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19017. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19018. if (!wctx) { return preverify_ok; }
  19019. std::shared_ptr<VerifyCallback> callback;
  19020. {
  19021. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19022. callback = wctx->verify_callback;
  19023. }
  19024. if (!callback) { return preverify_ok; }
  19025. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19026. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19027. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19028. VerifyContext verify_ctx;
  19029. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19030. verify_ctx.cert = static_cast<cert_t>(cert);
  19031. verify_ctx.depth = depth;
  19032. verify_ctx.preverify_ok = (preverify_ok != 0);
  19033. verify_ctx.error_code = static_cast<long>(err);
  19034. if (err != 0) {
  19035. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19036. } else {
  19037. verify_ctx.error_string = nullptr;
  19038. }
  19039. bool accepted = run_verify_callback(*callback, verify_ctx);
  19040. return accepted ? 1 : 0;
  19041. }
  19042. // Sets the verify mode from whether the peer's certificate is required and
  19043. // whether a verify callback is set.
  19044. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19045. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19046. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19047. auto mode = wctx.verify_client
  19048. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19049. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19050. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19051. has_callback ? wolfssl_verify_callback : nullptr);
  19052. }
  19053. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19054. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19055. wolfSSL_CTX_set_default_passwd_cb(
  19056. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19057. auto *pwd = static_cast<const char *>(userdata);
  19058. if (!pwd) return 0;
  19059. auto len = static_cast<int>(strlen(pwd));
  19060. if (len > size) len = size;
  19061. memcpy(buf, pwd, static_cast<size_t>(len));
  19062. return len;
  19063. });
  19064. }
  19065. } // namespace impl
  19066. inline ctx_t create_client_context() {
  19067. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19068. if (!ctx) { return nullptr; }
  19069. ctx->is_server = false;
  19070. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19071. if (!method) {
  19072. delete ctx;
  19073. return nullptr;
  19074. }
  19075. ctx->ctx = wolfSSL_CTX_new(method);
  19076. if (!ctx->ctx ||
  19077. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19078. WOLFSSL_SUCCESS) {
  19079. delete ctx;
  19080. return nullptr;
  19081. }
  19082. // Default: verify peer certificate
  19083. ctx->verify_client = true;
  19084. impl::apply_verify_mode(*ctx);
  19085. return static_cast<ctx_t>(ctx);
  19086. }
  19087. inline ctx_t create_server_context() {
  19088. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19089. if (!ctx) { return nullptr; }
  19090. ctx->is_server = true;
  19091. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19092. if (!method) {
  19093. delete ctx;
  19094. return nullptr;
  19095. }
  19096. ctx->ctx = wolfSSL_CTX_new(method);
  19097. if (!ctx->ctx ||
  19098. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19099. WOLFSSL_SUCCESS) {
  19100. delete ctx;
  19101. return nullptr;
  19102. }
  19103. // Default: don't verify client
  19104. impl::apply_verify_mode(*ctx);
  19105. // Enable SNI on server
  19106. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19107. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19108. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19109. return static_cast<ctx_t>(ctx);
  19110. }
  19111. inline void free_context(ctx_t ctx) {
  19112. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19113. }
  19114. inline bool set_min_version(ctx_t ctx, Version version) {
  19115. if (!ctx) { return false; }
  19116. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19117. int min_ver = WOLFSSL_TLSV1_2;
  19118. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19119. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19120. }
  19121. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19122. if (!ctx || !pem) { return false; }
  19123. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19124. int ret = wolfSSL_CTX_load_verify_buffer(
  19125. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19126. static_cast<long>(len), SSL_FILETYPE_PEM);
  19127. if (ret != SSL_SUCCESS) {
  19128. impl::wolfssl_last_error() =
  19129. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19130. return false;
  19131. }
  19132. wctx->ca_pem_data_.append(pem, len);
  19133. return true;
  19134. }
  19135. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19136. if (!ctx || !file_path) { return false; }
  19137. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19138. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19139. if (ret != SSL_SUCCESS) {
  19140. impl::wolfssl_last_error() =
  19141. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19142. return false;
  19143. }
  19144. return true;
  19145. }
  19146. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19147. if (!ctx || !dir_path) { return false; }
  19148. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19149. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19150. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19151. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19152. // immediately. Return true even on failure since the CA file may have
  19153. // already been loaded, matching OpenSSL's lenient behavior.
  19154. (void)ret;
  19155. return true;
  19156. }
  19157. inline bool load_system_certs(ctx_t ctx) {
  19158. if (!ctx) { return false; }
  19159. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19160. bool loaded = false;
  19161. #ifdef _WIN32
  19162. loaded = impl::enumerate_windows_system_certs(
  19163. [&](const unsigned char *data, size_t len) {
  19164. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19165. static_cast<long>(len),
  19166. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19167. });
  19168. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19169. loaded = impl::enumerate_macos_keychain_certs(
  19170. [&](const unsigned char *data, size_t len) {
  19171. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19172. static_cast<long>(len),
  19173. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19174. });
  19175. #else
  19176. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19177. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19178. SSL_SUCCESS) {
  19179. loaded = true;
  19180. break;
  19181. }
  19182. }
  19183. if (!loaded) {
  19184. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19185. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19186. SSL_SUCCESS) {
  19187. loaded = true;
  19188. break;
  19189. }
  19190. }
  19191. }
  19192. #endif
  19193. return loaded;
  19194. }
  19195. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19196. const char *password) {
  19197. if (!ctx || !cert || !key) { return false; }
  19198. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19199. // Load certificate
  19200. int ret = wolfSSL_CTX_use_certificate_buffer(
  19201. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19202. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19203. if (ret != SSL_SUCCESS) {
  19204. impl::wolfssl_last_error() =
  19205. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19206. return false;
  19207. }
  19208. // Set password callback if password is provided
  19209. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19210. // Load private key
  19211. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19212. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19213. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19214. if (ret != SSL_SUCCESS) {
  19215. impl::wolfssl_last_error() =
  19216. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19217. return false;
  19218. }
  19219. // Verify that the certificate and private key match
  19220. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19221. }
  19222. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19223. const char *key_path, const char *password) {
  19224. if (!ctx || !cert_path || !key_path) { return false; }
  19225. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19226. // Load certificate file
  19227. int ret =
  19228. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19229. if (ret != SSL_SUCCESS) {
  19230. impl::wolfssl_last_error() =
  19231. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19232. return false;
  19233. }
  19234. // Set password callback if password is provided
  19235. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19236. // Load private key file
  19237. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19238. if (ret != SSL_SUCCESS) {
  19239. impl::wolfssl_last_error() =
  19240. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19241. return false;
  19242. }
  19243. // Verify that the certificate and private key match
  19244. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19245. }
  19246. inline void set_verify_client(ctx_t ctx, bool require) {
  19247. if (!ctx) { return; }
  19248. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19249. wctx->verify_client = require;
  19250. impl::apply_verify_mode(*wctx);
  19251. }
  19252. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19253. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19254. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19255. auto session = new (std::nothrow) impl::WolfSSLSession();
  19256. if (!session) { return nullptr; }
  19257. session->sock = sock;
  19258. session->ssl = wolfSSL_new(wctx->ctx);
  19259. if (!session->ssl) {
  19260. impl::wolfssl_last_error() =
  19261. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19262. delete session;
  19263. return nullptr;
  19264. }
  19265. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19266. session) != WOLFSSL_SUCCESS) {
  19267. delete session;
  19268. return nullptr;
  19269. }
  19270. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19271. return static_cast<session_t>(session);
  19272. }
  19273. inline void free_session(session_t session) {
  19274. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19275. }
  19276. inline bool set_sni(session_t session, const char *hostname,
  19277. bool verify_hostname) {
  19278. if (!session || !hostname) { return false; }
  19279. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19280. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19281. static_cast<word16>(strlen(hostname)));
  19282. if (ret != WOLFSSL_SUCCESS) {
  19283. impl::wolfssl_last_error() =
  19284. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19285. return false;
  19286. }
  19287. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19288. // separately from the SNI extension sent above; skip it when hostname
  19289. // verification is disabled so only the chain is checked, matching OpenSSL.
  19290. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19291. wsession->hostname = hostname;
  19292. return true;
  19293. }
  19294. inline TlsError connect(session_t session) {
  19295. TlsError err;
  19296. if (!session) {
  19297. err.code = ErrorCode::Fatal;
  19298. return err;
  19299. }
  19300. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19301. int ret = wolfSSL_connect(wsession->ssl);
  19302. if (ret == SSL_SUCCESS) {
  19303. err.code = ErrorCode::Success;
  19304. } else {
  19305. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19306. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19307. err.backend_code = static_cast<uint64_t>(ssl_error);
  19308. impl::wolfssl_last_error() = err.backend_code;
  19309. }
  19310. return err;
  19311. }
  19312. inline TlsError accept(session_t session) {
  19313. TlsError err;
  19314. if (!session) {
  19315. err.code = ErrorCode::Fatal;
  19316. return err;
  19317. }
  19318. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19319. int ret = wolfSSL_accept(wsession->ssl);
  19320. if (ret == SSL_SUCCESS) {
  19321. err.code = ErrorCode::Success;
  19322. // Capture SNI from thread-local storage after successful handshake
  19323. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19324. impl::wolfssl_pending_sni().clear();
  19325. } else {
  19326. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19327. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19328. err.backend_code = static_cast<uint64_t>(ssl_error);
  19329. impl::wolfssl_last_error() = err.backend_code;
  19330. }
  19331. return err;
  19332. }
  19333. inline bool connect_nonblocking(session_t session, socket_t sock,
  19334. time_t timeout_sec, time_t timeout_usec,
  19335. TlsError *err) {
  19336. if (!session) {
  19337. if (err) { err->code = ErrorCode::Fatal; }
  19338. return false;
  19339. }
  19340. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19341. // Set socket to non-blocking mode
  19342. detail::set_nonblocking(sock, true);
  19343. auto cleanup =
  19344. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19345. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19346. int ret;
  19347. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19348. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19349. if (ssl_error == SSL_ERROR_WANT_READ) {
  19350. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19351. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19352. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19353. }
  19354. // Error or timeout
  19355. if (err) {
  19356. err->code =
  19357. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19358. err->backend_code = static_cast<uint64_t>(ssl_error);
  19359. }
  19360. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19361. return false;
  19362. }
  19363. if (err) { err->code = ErrorCode::Success; }
  19364. return true;
  19365. }
  19366. inline bool accept_nonblocking(session_t session, socket_t sock,
  19367. time_t timeout_sec, time_t timeout_usec,
  19368. TlsError *err) {
  19369. if (!session) {
  19370. if (err) { err->code = ErrorCode::Fatal; }
  19371. return false;
  19372. }
  19373. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19374. // Set socket to non-blocking mode
  19375. detail::set_nonblocking(sock, true);
  19376. auto cleanup =
  19377. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19378. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19379. int ret;
  19380. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19381. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19382. if (ssl_error == SSL_ERROR_WANT_READ) {
  19383. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19384. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19385. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19386. }
  19387. // Error or timeout
  19388. if (err) {
  19389. err->code =
  19390. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19391. err->backend_code = static_cast<uint64_t>(ssl_error);
  19392. }
  19393. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19394. return false;
  19395. }
  19396. if (err) { err->code = ErrorCode::Success; }
  19397. // Capture SNI from thread-local storage after successful handshake
  19398. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19399. impl::wolfssl_pending_sni().clear();
  19400. return true;
  19401. }
  19402. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19403. if (!session || !buf) {
  19404. err.code = ErrorCode::Fatal;
  19405. return -1;
  19406. }
  19407. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19408. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19409. if (ret > 0) {
  19410. err.code = ErrorCode::Success;
  19411. return static_cast<ssize_t>(ret);
  19412. }
  19413. if (ret == 0) {
  19414. err.code = ErrorCode::PeerClosed;
  19415. return 0;
  19416. }
  19417. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19418. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19419. err.backend_code = static_cast<uint64_t>(ssl_error);
  19420. impl::wolfssl_last_error() = err.backend_code;
  19421. return -1;
  19422. }
  19423. inline ssize_t write(session_t session, const void *buf, size_t len,
  19424. TlsError &err) {
  19425. if (!session || !buf) {
  19426. err.code = ErrorCode::Fatal;
  19427. return -1;
  19428. }
  19429. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19430. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19431. if (ret > 0) {
  19432. err.code = ErrorCode::Success;
  19433. return static_cast<ssize_t>(ret);
  19434. }
  19435. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19436. // Treat this as an error (return -1) so callers don't spin in a
  19437. // write loop adding zero to the offset.
  19438. if (ret == 0) {
  19439. err.code = ErrorCode::PeerClosed;
  19440. return -1;
  19441. }
  19442. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19443. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19444. err.backend_code = static_cast<uint64_t>(ssl_error);
  19445. impl::wolfssl_last_error() = err.backend_code;
  19446. return -1;
  19447. }
  19448. inline int pending(const_session_t session) {
  19449. if (!session) { return 0; }
  19450. auto wsession =
  19451. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19452. return wolfSSL_pending(wsession->ssl);
  19453. }
  19454. inline void shutdown(session_t session, bool graceful) {
  19455. if (!session) { return; }
  19456. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19457. if (graceful) {
  19458. int ret;
  19459. int attempts = 0;
  19460. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19461. attempts < 3) {
  19462. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19463. if (ssl_error != SSL_ERROR_WANT_READ &&
  19464. ssl_error != SSL_ERROR_WANT_WRITE) {
  19465. break;
  19466. }
  19467. attempts++;
  19468. }
  19469. } else {
  19470. wolfSSL_shutdown(wsession->ssl);
  19471. }
  19472. }
  19473. inline bool is_peer_closed(session_t session, socket_t sock) {
  19474. if (!session || sock == INVALID_SOCKET) { return true; }
  19475. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19476. // Check if there's already decrypted data available
  19477. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19478. // Set socket to non-blocking to avoid blocking on read
  19479. detail::set_nonblocking(sock, true);
  19480. auto cleanup =
  19481. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19482. // Peek 1 byte to check connection status without consuming data
  19483. unsigned char buf;
  19484. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19485. // If we got data or WANT_READ (would block), connection is alive
  19486. if (ret > 0) { return false; }
  19487. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19488. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19489. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19490. ret == 0;
  19491. }
  19492. inline cert_t get_peer_cert(const_session_t session) {
  19493. if (!session) { return nullptr; }
  19494. auto wsession =
  19495. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19496. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19497. return static_cast<cert_t>(cert);
  19498. }
  19499. inline size_t get_peer_certs(const_session_t session,
  19500. std::vector<cert_t> &certs) {
  19501. certs.clear();
  19502. if (!session) { return 0; }
  19503. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19504. #ifdef SESSION_CERTS
  19505. auto wsession =
  19506. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19507. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19508. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19509. for (int i = 0; i < count; i++) {
  19510. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19511. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19512. }
  19513. #endif
  19514. return certs.size();
  19515. }
  19516. inline void free_cert(cert_t cert) {
  19517. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19518. }
  19519. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19520. if (!cert || !hostname) { return false; }
  19521. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19522. std::string host_str(hostname);
  19523. // Check if hostname is an IP address (IPv4 or IPv6)
  19524. unsigned char ip_bytes[16];
  19525. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19526. auto is_ip = ip_len > 0;
  19527. // Check Subject Alternative Names
  19528. auto has_dns_san = false;
  19529. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19530. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19531. if (san_names) {
  19532. int san_count = wolfSSL_sk_num(san_names);
  19533. for (int i = 0; i < san_count; i++) {
  19534. auto *names =
  19535. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19536. if (!names) continue;
  19537. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19538. // DNS name
  19539. has_dns_san = true;
  19540. unsigned char *dns_name = nullptr;
  19541. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19542. if (dns_name && dns_len > 0) {
  19543. std::string san_name(reinterpret_cast<char *>(dns_name),
  19544. static_cast<size_t>(dns_len));
  19545. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19546. if (detail::match_hostname(san_name, host_str)) {
  19547. wolfSSL_sk_free(san_names);
  19548. return true;
  19549. }
  19550. }
  19551. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19552. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19553. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19554. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19555. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19556. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19557. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19558. wolfSSL_sk_free(san_names);
  19559. return true;
  19560. }
  19561. }
  19562. }
  19563. wolfSSL_sk_free(san_names);
  19564. }
  19565. // Fallback: the Common Name (CN) in the subject, as X509_check_host does it:
  19566. // never for an IP host, which only an iPAddress SAN names, and never next to
  19567. // a DNS SAN (RFC 6125 6.4.4).
  19568. if (is_ip || has_dns_san) { return false; }
  19569. auto cn = get_cert_subject_cn(cert);
  19570. return !cn.empty() && detail::match_hostname(cn, host_str);
  19571. }
  19572. inline uint64_t hostname_mismatch_code() {
  19573. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19574. }
  19575. inline long get_verify_result(const_session_t session) {
  19576. if (!session) { return -1; }
  19577. auto wsession =
  19578. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19579. long result = wolfSSL_get_verify_result(wsession->ssl);
  19580. return result;
  19581. }
  19582. inline std::string get_cert_subject_cn(cert_t cert) {
  19583. if (!cert) return "";
  19584. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19585. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19586. if (!subject) return "";
  19587. char cn[256] = {};
  19588. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19589. sizeof(cn));
  19590. if (cn_len <= 0) return "";
  19591. return std::string(cn, static_cast<size_t>(cn_len));
  19592. }
  19593. inline std::string get_cert_issuer_name(cert_t cert) {
  19594. if (!cert) return "";
  19595. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19596. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19597. if (!issuer) return "";
  19598. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19599. if (!name_str) return "";
  19600. std::string result(name_str);
  19601. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19602. return result;
  19603. }
  19604. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19605. sans.clear();
  19606. if (!cert) return false;
  19607. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19608. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19609. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19610. if (!san_names) return true; // No SANs is not an error
  19611. int count = wolfSSL_sk_num(san_names);
  19612. for (int i = 0; i < count; i++) {
  19613. auto *name =
  19614. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19615. if (!name) continue;
  19616. SanEntry entry;
  19617. switch (name->type) {
  19618. case WOLFSSL_GEN_DNS: {
  19619. entry.type = SanType::DNS;
  19620. unsigned char *dns_name = nullptr;
  19621. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19622. if (dns_name && dns_len > 0) {
  19623. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19624. static_cast<size_t>(dns_len));
  19625. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19626. }
  19627. break;
  19628. }
  19629. case WOLFSSL_GEN_IPADD: {
  19630. entry.type = SanType::IP;
  19631. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19632. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19633. if (ip_data && ip_len == 4) {
  19634. char buf[16];
  19635. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19636. ip_data[2], ip_data[3]);
  19637. entry.value = buf;
  19638. } else if (ip_data && ip_len == 16) {
  19639. char buf[64];
  19640. snprintf(buf, sizeof(buf),
  19641. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19642. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19643. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19644. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19645. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19646. ip_data[14], ip_data[15]);
  19647. entry.value = buf;
  19648. }
  19649. break;
  19650. }
  19651. case WOLFSSL_GEN_EMAIL:
  19652. entry.type = SanType::EMAIL;
  19653. {
  19654. unsigned char *email = nullptr;
  19655. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19656. if (email && email_len > 0) {
  19657. entry.value = std::string(reinterpret_cast<char *>(email),
  19658. static_cast<size_t>(email_len));
  19659. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19660. }
  19661. }
  19662. break;
  19663. case WOLFSSL_GEN_URI:
  19664. entry.type = SanType::URI;
  19665. {
  19666. unsigned char *uri = nullptr;
  19667. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19668. &uri, name->d.uniformResourceIdentifier);
  19669. if (uri && uri_len > 0) {
  19670. entry.value = std::string(reinterpret_cast<char *>(uri),
  19671. static_cast<size_t>(uri_len));
  19672. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19673. }
  19674. }
  19675. break;
  19676. default: entry.type = SanType::OTHER; break;
  19677. }
  19678. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19679. }
  19680. wolfSSL_sk_free(san_names);
  19681. return true;
  19682. }
  19683. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19684. time_t &not_after) {
  19685. if (!cert) return false;
  19686. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19687. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19688. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19689. if (!nb || !na) return false;
  19690. // wolfSSL_ASN1_TIME_to_tm is available
  19691. struct tm tm_nb = {}, tm_na = {};
  19692. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19693. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19694. #ifdef _WIN32
  19695. not_before = _mkgmtime(&tm_nb);
  19696. not_after = _mkgmtime(&tm_na);
  19697. #else
  19698. not_before = timegm(&tm_nb);
  19699. not_after = timegm(&tm_na);
  19700. #endif
  19701. return true;
  19702. }
  19703. inline std::string get_cert_serial(cert_t cert) {
  19704. if (!cert) return "";
  19705. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19706. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19707. if (!serial_asn1) return "";
  19708. // Get the serial number data
  19709. int len = serial_asn1->length;
  19710. unsigned char *data = serial_asn1->data;
  19711. if (!data || len <= 0) return "";
  19712. std::string result;
  19713. result.reserve(static_cast<size_t>(len) * 2);
  19714. for (int i = 0; i < len; i++) {
  19715. char hex[3];
  19716. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19717. result += hex;
  19718. }
  19719. return result;
  19720. }
  19721. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19722. if (!cert) return false;
  19723. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19724. int der_len = 0;
  19725. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19726. if (!der_data || der_len <= 0) return false;
  19727. der.assign(der_data, der_data + der_len);
  19728. return true;
  19729. }
  19730. inline const char *get_sni(const_session_t session) {
  19731. if (!session) return nullptr;
  19732. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19733. // For server: return SNI received from client during handshake
  19734. if (!wsession->sni_hostname.empty()) {
  19735. return wsession->sni_hostname.c_str();
  19736. }
  19737. // For client: return the hostname set via set_sni
  19738. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19739. return nullptr;
  19740. }
  19741. inline uint64_t peek_error() {
  19742. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19743. }
  19744. inline uint64_t get_error() {
  19745. uint64_t err = impl::wolfssl_last_error();
  19746. impl::wolfssl_last_error() = 0;
  19747. return err;
  19748. }
  19749. inline std::string error_string(uint64_t code) {
  19750. char buf[256];
  19751. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19752. return std::string(buf);
  19753. }
  19754. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19755. if (!pem || len == 0) { return nullptr; }
  19756. // Validate by attempting to load into a temporary ctx
  19757. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19758. if (!tmp_ctx) { return nullptr; }
  19759. int ret = wolfSSL_CTX_load_verify_buffer(
  19760. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19761. static_cast<long>(len), SSL_FILETYPE_PEM);
  19762. wolfSSL_CTX_free(tmp_ctx);
  19763. if (ret != SSL_SUCCESS) { return nullptr; }
  19764. return static_cast<ca_store_t>(
  19765. new impl::WolfSSLCAStore{std::string(pem, len)});
  19766. }
  19767. inline void free_ca_store(ca_store_t store) {
  19768. delete static_cast<impl::WolfSSLCAStore *>(store);
  19769. }
  19770. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19771. if (!ctx || !store) { return false; }
  19772. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19773. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19774. int ret = wolfSSL_CTX_load_verify_buffer(
  19775. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19776. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19777. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19778. // This function takes ownership of the store; the PEM data was copied into
  19779. // the context, so release the source
  19780. free_ca_store(store);
  19781. return ret == SSL_SUCCESS;
  19782. }
  19783. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19784. certs.clear();
  19785. if (!ctx) { return 0; }
  19786. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19787. if (wctx->ca_pem_data_.empty()) { return 0; }
  19788. const std::string &pem = wctx->ca_pem_data_;
  19789. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19790. const std::string end_marker = "-----END CERTIFICATE-----";
  19791. size_t pos = 0;
  19792. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19793. size_t end_pos = pem.find(end_marker, pos);
  19794. if (end_pos == std::string::npos) { break; }
  19795. end_pos += end_marker.size();
  19796. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19797. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19798. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19799. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19800. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19801. pos = end_pos;
  19802. }
  19803. return certs.size();
  19804. }
  19805. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19806. std::vector<std::string> names;
  19807. if (!ctx) { return names; }
  19808. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19809. if (wctx->ca_pem_data_.empty()) { return names; }
  19810. const std::string &pem = wctx->ca_pem_data_;
  19811. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19812. const std::string end_marker = "-----END CERTIFICATE-----";
  19813. size_t pos = 0;
  19814. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19815. size_t end_pos = pem.find(end_marker, pos);
  19816. if (end_pos == std::string::npos) { break; }
  19817. end_pos += end_marker.size();
  19818. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19819. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19820. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19821. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19822. if (x509) {
  19823. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19824. if (subject) {
  19825. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19826. if (name_str) {
  19827. names.push_back(name_str);
  19828. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19829. }
  19830. }
  19831. wolfSSL_X509_free(x509);
  19832. }
  19833. pos = end_pos;
  19834. }
  19835. return names;
  19836. }
  19837. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19838. const char *key_pem, const char *password) {
  19839. if (!ctx || !cert_pem || !key_pem) { return false; }
  19840. // Try the pair on a scratch context first, so that a bad one leaves the
  19841. // server's certificate and key as they were
  19842. auto tmp = create_server_context();
  19843. if (!tmp) { return false; }
  19844. auto se = detail::scope_exit([&] { free_context(tmp); });
  19845. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19846. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19847. }
  19848. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19849. if (!ctx || !ca_pem) { return false; }
  19850. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19851. // Replace the CAs rather than add to them, as the other backends do, once
  19852. // the new ones are known to load
  19853. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19854. if (!store) { return false; }
  19855. free_ca_store(store);
  19856. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19857. wctx->ca_pem_data_.clear();
  19858. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19859. }
  19860. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19861. if (!ctx) { return false; }
  19862. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19863. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  19864. : nullptr;
  19865. {
  19866. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  19867. // A handshake running the previous callback keeps it until it returns.
  19868. wctx->verify_callback.swap(stored);
  19869. }
  19870. impl::apply_verify_mode(*wctx);
  19871. return true;
  19872. }
  19873. inline long get_verify_error(const_session_t session) {
  19874. if (!session) { return -1; }
  19875. auto *wsession =
  19876. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19877. return wolfSSL_get_verify_result(wsession->ssl);
  19878. }
  19879. inline std::string verify_error_string(long error_code) {
  19880. if (error_code == 0) { return ""; }
  19881. const char *str =
  19882. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19883. return str ? std::string(str) : std::string();
  19884. }
  19885. } // namespace tls
  19886. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19887. // WebSocket implementation
  19888. namespace ws {
  19889. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19890. bool fin) {
  19891. std::lock_guard<std::mutex> lock(write_mutex_);
  19892. if (closed_) { return false; }
  19893. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19894. }
  19895. inline ReadResult WebSocket::read(std::string &msg) {
  19896. // Answers a control frame; any other opcode here is a protocol error.
  19897. // Returns false when the connection is done.
  19898. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  19899. switch (op) {
  19900. case Opcode::Ping: {
  19901. std::lock_guard<std::mutex> lock(write_mutex_);
  19902. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19903. payload.size(), true, !is_server_);
  19904. return true;
  19905. }
  19906. case Opcode::Pong: {
  19907. std::lock_guard<std::mutex> lock(ping_mutex_);
  19908. unacked_pings_ = 0;
  19909. return true;
  19910. }
  19911. case Opcode::Close: {
  19912. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  19913. // malformed, which is answered with a protocol error instead.
  19914. if (closed_.exchange(true)) { return false; }
  19915. auto reply = payload;
  19916. if (!impl::is_valid_close_payload(payload)) {
  19917. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19918. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19919. }
  19920. std::lock_guard<std::mutex> lock(write_mutex_);
  19921. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19922. reply.size(), true, !is_server_);
  19923. return false;
  19924. }
  19925. default: closed_ = true; return false;
  19926. }
  19927. };
  19928. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19929. while (!closed_) {
  19930. Opcode opcode;
  19931. std::string payload;
  19932. bool fin;
  19933. impl::FrameRead r =
  19934. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19935. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19936. // A timeout landed on a frame boundary: the connection is untouched and
  19937. // still usable, so hand control back without closing it. That is only
  19938. // useful to a caller who asked for the timeout; the compile-time default
  19939. // is a backstop against a peer gone quiet, and elapsing it closes the
  19940. // connection so a plain `while (ws.read(msg))` loop ends.
  19941. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19942. if (r != impl::FrameRead::Ok) {
  19943. closed_ = true;
  19944. return Fail;
  19945. }
  19946. switch (opcode) {
  19947. case Opcode::Text:
  19948. case Opcode::Binary: {
  19949. auto result = opcode == Opcode::Text ? Text : Binary;
  19950. msg = std::move(payload);
  19951. // Handle fragmentation
  19952. if (!fin) {
  19953. while (true) {
  19954. Opcode cont_opcode;
  19955. std::string cont_payload;
  19956. bool cont_fin;
  19957. // Only what is left of the limit, but room for a control frame,
  19958. // which may come between the fragments.
  19959. auto max_len =
  19960. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19961. ? size_t(0)
  19962. : (std::max)(size_t(125),
  19963. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19964. msg.size());
  19965. // A timeout is not reportable here: half of a fragmented message is
  19966. // already in `msg` and read() has no way to resume it, so it is a
  19967. // failure like any other. Timeouts are only ever seen on a message
  19968. // boundary.
  19969. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19970. cont_fin, is_server_,
  19971. max_len) != impl::FrameRead::Ok) {
  19972. closed_ = true;
  19973. return Fail;
  19974. }
  19975. // RFC 6455 5.4: the fragments are continuation frames, with only
  19976. // control frames between them.
  19977. if (cont_opcode != Opcode::Continuation) {
  19978. if (handle_control(cont_opcode, cont_payload)) { continue; }
  19979. return Fail;
  19980. }
  19981. msg += cont_payload;
  19982. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19983. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19984. closed_ = true;
  19985. return Fail;
  19986. }
  19987. if (cont_fin) { break; }
  19988. }
  19989. }
  19990. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19991. if (result == Text && !impl::is_valid_utf8(msg)) {
  19992. // close() takes the read lock to wait for the peer's Close reply, so
  19993. // it must not run while this thread still holds it.
  19994. read_lock.unlock();
  19995. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19996. return Fail;
  19997. }
  19998. return result;
  19999. }
  20000. default:
  20001. if (handle_control(opcode, payload)) { continue; }
  20002. return Fail;
  20003. }
  20004. }
  20005. return Fail;
  20006. }
  20007. inline bool WebSocket::send(const std::string &data) {
  20008. return send_frame(Opcode::Text, data.data(), data.size());
  20009. }
  20010. inline bool WebSocket::send(const char *data, size_t len) {
  20011. return send_frame(Opcode::Binary, data, len);
  20012. }
  20013. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20014. if (closed_.exchange(true)) { return; }
  20015. ping_cv_.notify_all();
  20016. std::string payload;
  20017. auto code = static_cast<uint16_t>(status);
  20018. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20019. payload.push_back(static_cast<char>(code & 0xFF));
  20020. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20021. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20022. // cut back to a whole UTF-8 character
  20023. auto short_reason = reason.substr(0, 123);
  20024. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20025. short_reason.pop_back();
  20026. }
  20027. payload += short_reason;
  20028. // A code that may not be sent, such as NoStatus, goes without a payload
  20029. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20030. {
  20031. std::lock_guard<std::mutex> lock(write_mutex_);
  20032. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20033. payload.size(), true, !is_server_);
  20034. }
  20035. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20036. // Close response before closing the TCP connection.
  20037. //
  20038. // Wait only when no other thread is parsing frames. When one is, it is the
  20039. // thread positioned to see the peer's reply, and reading here would take
  20040. // bytes out of the message it is assembling. Bailing out also leaves the
  20041. // stream, including its read timeout, entirely to that thread.
  20042. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20043. if (!read_lock.owns_lock()) { return; }
  20044. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20045. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20046. Opcode op;
  20047. std::string resp;
  20048. bool fin;
  20049. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20050. impl::FrameRead::Ok) {
  20051. if (op == Opcode::Close) { break; }
  20052. }
  20053. }
  20054. inline WebSocket::~WebSocket() {
  20055. {
  20056. std::lock_guard<std::mutex> lock(ping_mutex_);
  20057. closed_ = true;
  20058. }
  20059. ping_cv_.notify_all();
  20060. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20061. }
  20062. inline void WebSocket::start_heartbeat() {
  20063. if (ping_interval_sec_ <= 0) { return; }
  20064. ping_thread_ = std::thread([this]() {
  20065. std::unique_lock<std::mutex> lock(ping_mutex_);
  20066. // The predicate keeps a spurious wakeup from sending a ping early
  20067. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20068. [this]() { return closed_.load(); })) {
  20069. // If the peer has failed to respond to the previous pings, give up.
  20070. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20071. // opt-in liveness check controlled by max_missed_pongs_.
  20072. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20073. lock.unlock();
  20074. close(CloseStatus::GoingAway, "pong timeout");
  20075. // Wake a read() blocked on the unresponsive peer. Only the read side
  20076. // is shut down: a TLS backend answers the EOF with an alert, and
  20077. // writing it to a socket closed for writing raises SIGPIPE.
  20078. #ifdef _WIN32
  20079. shutdown(strm_.socket(), SD_RECEIVE);
  20080. #else
  20081. shutdown(strm_.socket(), SHUT_RD);
  20082. #endif
  20083. return;
  20084. }
  20085. lock.unlock();
  20086. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20087. lock.lock();
  20088. closed_ = true;
  20089. break;
  20090. }
  20091. lock.lock();
  20092. unacked_pings_++;
  20093. }
  20094. });
  20095. }
  20096. inline const Request &WebSocket::request() const { return req_; }
  20097. inline bool WebSocket::is_open() const { return !closed_; }
  20098. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20099. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20100. // poll(), where 0 would instead mean "return immediately", so hand it the
  20101. // negative poll uses for an unbounded wait.
  20102. if (sec == 0 && usec == 0) { sec = -1; }
  20103. strm_.set_read_timeout(sec, usec);
  20104. read_timeout_set_ = true;
  20105. }
  20106. // WebSocketClient implementation
  20107. inline WebSocketClient::WebSocketClient(
  20108. const std::string &scheme_host_port_path, const Headers &headers)
  20109. : headers_(headers) {
  20110. detail::UrlComponents uc;
  20111. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20112. !uc.host.empty() && !uc.path.empty()) {
  20113. auto &scheme = uc.scheme;
  20114. #ifdef CPPHTTPLIB_SSL_ENABLED
  20115. if (scheme != "ws" && scheme != "wss") {
  20116. #else
  20117. if (scheme != "ws") {
  20118. #endif
  20119. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20120. std::string msg = "'" + scheme + "' scheme is not supported.";
  20121. throw std::invalid_argument(msg);
  20122. #endif
  20123. return;
  20124. }
  20125. auto is_ssl = scheme == "wss";
  20126. host_ = std::move(uc.host);
  20127. port_ = is_ssl ? 443 : 80;
  20128. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20129. path_ = std::move(uc.path);
  20130. if (!uc.query.empty()) { path_ += uc.query; }
  20131. #ifdef CPPHTTPLIB_SSL_ENABLED
  20132. is_ssl_ = is_ssl;
  20133. if (is_ssl_) {
  20134. // The context lives as long as the client so that CA configuration
  20135. // survives reconnects; sessions are created per connection.
  20136. tls_ctx_ = tls::create_client_context();
  20137. if (!tls_ctx_) { return; }
  20138. }
  20139. #else
  20140. if (is_ssl) { return; }
  20141. #endif
  20142. is_valid_ = true;
  20143. }
  20144. }
  20145. #ifdef CPPHTTPLIB_SSL_ENABLED
  20146. inline WebSocketClient::WebSocketClient(
  20147. const std::string &scheme_host_port_path, const PemMemory &pem,
  20148. const Headers &headers)
  20149. : WebSocketClient(scheme_host_port_path, headers) {
  20150. // For ws:// URLs the client certificate is silently ignored, consistent
  20151. // with the TLS-only setters such as set_ca_cert_path().
  20152. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20153. std::string cert_buf, key_buf;
  20154. if (!tls::set_client_cert_pem(
  20155. tls_ctx_,
  20156. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20157. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20158. pem.private_key_password)) {
  20159. tls::free_context(tls_ctx_);
  20160. tls_ctx_ = nullptr;
  20161. is_valid_ = false;
  20162. }
  20163. }
  20164. }
  20165. #endif
  20166. inline WebSocketClient::~WebSocketClient() {
  20167. shutdown_and_close();
  20168. #ifdef CPPHTTPLIB_SSL_ENABLED
  20169. if (tls_ctx_) {
  20170. tls::free_context(tls_ctx_);
  20171. tls_ctx_ = nullptr;
  20172. }
  20173. #endif
  20174. }
  20175. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20176. inline void WebSocketClient::shutdown_and_close() {
  20177. // Send the close frame while the TLS session is still alive: ws_ holds an
  20178. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20179. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20180. if (ws_ && ws_->is_open()) { ws_->close(); }
  20181. ws_.reset();
  20182. #ifdef CPPHTTPLIB_SSL_ENABLED
  20183. if (is_ssl_) {
  20184. if (tls_session_) {
  20185. tls::shutdown(tls_session_, true);
  20186. tls::free_session(tls_session_);
  20187. tls_session_ = nullptr;
  20188. }
  20189. }
  20190. #endif
  20191. if (sock_ != INVALID_SOCKET) {
  20192. detail::shutdown_socket(sock_);
  20193. detail::close_socket(sock_);
  20194. sock_ = INVALID_SOCKET;
  20195. }
  20196. }
  20197. // The handshakes belong to establishing the connection, so an unset read
  20198. // timeout leaves them bounded by the connection timeout instead of forever.
  20199. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20200. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20201. return {connection_timeout_sec_, connection_timeout_usec_};
  20202. }
  20203. return {read_timeout_sec_, read_timeout_usec_};
  20204. }
  20205. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20206. Error &error, int &ssl_error,
  20207. uint64_t &ssl_backend_error) {
  20208. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20209. // The streams wait with poll(), where 0 instead means "return immediately",
  20210. // so they are given the negative poll uses for an unbounded wait.
  20211. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20212. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20213. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20214. #ifdef CPPHTTPLIB_SSL_ENABLED
  20215. if (is_ssl_) {
  20216. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20217. // is not safe to call concurrently on one client to begin with, since
  20218. // nothing else here is guarded either.
  20219. if (server_certificate_verification_ && !certs_loaded_) {
  20220. uint64_t backend_error = 0;
  20221. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20222. ca_cert_dir_path_, custom_ca_loaded_,
  20223. system_ca_mode_, backend_error);
  20224. certs_loaded_ = true;
  20225. }
  20226. detail::ClientTlsSessionOptions options;
  20227. options.server_hostname_verification = server_hostname_verification_;
  20228. options.session_verifier = session_verifier_;
  20229. auto timeout = handshake_timeout();
  20230. detail::ClientTlsSessionError tls_error;
  20231. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20232. server_certificate_verification_,
  20233. timeout.first, timeout.second,
  20234. &tls_error, options)) {
  20235. error = tls_error.error;
  20236. ssl_error = tls_error.ssl_error;
  20237. ssl_backend_error = tls_error.backend_error;
  20238. return false;
  20239. }
  20240. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20241. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20242. write_timeout_usec_));
  20243. return true;
  20244. }
  20245. #else
  20246. (void)error;
  20247. (void)ssl_error;
  20248. (void)ssl_backend_error;
  20249. #endif
  20250. strm = std::unique_ptr<Stream>(
  20251. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20252. write_timeout_sec_, write_timeout_usec_));
  20253. return true;
  20254. }
  20255. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20256. #ifdef CPPHTTPLIB_SSL_ENABLED
  20257. auto is_ssl = is_ssl_;
  20258. #else
  20259. auto is_ssl = false;
  20260. #endif
  20261. if (!req.has_header("Host")) {
  20262. req.headers.emplace("Host", detail::make_default_host_header_value(
  20263. host_, port_, is_ssl, address_family_));
  20264. }
  20265. detail::add_default_user_agent_header(req);
  20266. }
  20267. inline Result WebSocketClient::connect() {
  20268. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20269. shutdown_and_close();
  20270. auto error = Error::Success;
  20271. if (!create_and_connect_socket(error)) {
  20272. return Result{error, -1, Headers{}};
  20273. }
  20274. if (is_proxy_enabled()) {
  20275. Response proxy_res;
  20276. if (!connect_with_proxy(proxy_res, error)) {
  20277. shutdown_and_close();
  20278. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20279. }
  20280. }
  20281. std::unique_ptr<Stream> strm;
  20282. auto stream_error = Error::SSLConnection;
  20283. int ssl_error = 0;
  20284. uint64_t ssl_backend_error = 0;
  20285. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20286. shutdown_and_close();
  20287. #ifdef CPPHTTPLIB_SSL_ENABLED
  20288. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20289. #else
  20290. return Result{stream_error, -1, Headers{}};
  20291. #endif
  20292. }
  20293. Request req;
  20294. req.method = "GET";
  20295. req.path = path_;
  20296. req.headers = headers_;
  20297. prepare_default_headers(req);
  20298. detail::WebSocketUpgradeResponse upgrade;
  20299. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20300. shutdown_and_close();
  20301. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20302. }
  20303. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20304. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20305. websocket_ping_interval_sec_,
  20306. websocket_max_missed_pongs_));
  20307. // The stream was created with the timeout already; tell the WebSocket
  20308. // whether it came from the caller, so read() knows to report it as Timeout.
  20309. ws_->read_timeout_set_ = read_timeout_set_;
  20310. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20311. }
  20312. inline ReadResult WebSocketClient::read(std::string &msg) {
  20313. if (!ws_) { return Fail; }
  20314. return ws_->read(msg);
  20315. }
  20316. inline bool WebSocketClient::send(const std::string &data) {
  20317. if (!ws_) { return false; }
  20318. return ws_->send(data);
  20319. }
  20320. inline bool WebSocketClient::send(const char *data, size_t len) {
  20321. if (!ws_) { return false; }
  20322. return ws_->send(data, len);
  20323. }
  20324. inline void WebSocketClient::close(CloseStatus status,
  20325. const std::string &reason) {
  20326. if (ws_) { ws_->close(status, reason); }
  20327. }
  20328. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20329. inline const std::string &WebSocketClient::subprotocol() const {
  20330. return subprotocol_;
  20331. }
  20332. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20333. read_timeout_sec_ = sec;
  20334. read_timeout_usec_ = usec;
  20335. read_timeout_set_ = true;
  20336. // The members above only seed the next connect(); read() consults the
  20337. // stream, so an already-open connection has to be told directly.
  20338. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20339. }
  20340. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20341. write_timeout_sec_ = sec;
  20342. write_timeout_usec_ = usec;
  20343. }
  20344. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20345. websocket_ping_interval_sec_ = sec;
  20346. }
  20347. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20348. websocket_max_missed_pongs_ = count;
  20349. }
  20350. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20351. inline void WebSocketClient::set_address_family(int family) {
  20352. address_family_ = family;
  20353. }
  20354. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20355. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20356. socket_options_ = std::move(socket_options);
  20357. }
  20358. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20359. connection_timeout_sec_ = sec;
  20360. connection_timeout_usec_ = usec;
  20361. }
  20362. inline void WebSocketClient::set_interface(const std::string &intf) {
  20363. interface_ = intf;
  20364. }
  20365. inline void WebSocketClient::set_hostname_addr_map(
  20366. std::map<std::string, std::string> addr_map) {
  20367. addr_map_ = std::move(addr_map);
  20368. }
  20369. inline bool WebSocketClient::is_proxy_enabled() const {
  20370. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20371. if (no_proxy_entries_.empty()) { return true; }
  20372. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20373. no_proxy_entries_);
  20374. }
  20375. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20376. std::string connect_host;
  20377. std::string ip;
  20378. auto port = port_;
  20379. if (is_proxy_enabled()) {
  20380. connect_host = proxy_host_;
  20381. port = proxy_port_;
  20382. } else {
  20383. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20384. }
  20385. sock_ = detail::create_client_socket(
  20386. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20387. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20388. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20389. write_timeout_usec_, interface_, error);
  20390. if (sock_ != INVALID_SOCKET) { return true; }
  20391. if (error == Error::Success) { error = Error::Connection; }
  20392. return false;
  20393. }
  20394. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20395. Response &proxy_res,
  20396. Error &error) {
  20397. auto timeout = handshake_timeout();
  20398. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20399. write_timeout_sec_, write_timeout_usec_);
  20400. if (!detail::write_request_head(strm, req, error)) { return false; }
  20401. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20402. error = Error::Read;
  20403. return false;
  20404. }
  20405. return true;
  20406. }
  20407. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20408. // forward an Upgrade request.
  20409. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20410. Error &error) {
  20411. Request req;
  20412. req.method = "CONNECT";
  20413. req.path = detail::make_host_and_port_string_always_port(host_, port_);
  20414. req.headers.emplace("Host", req.path);
  20415. detail::add_default_user_agent_header(req);
  20416. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20417. proxy_basic_auth_password_,
  20418. proxy_bearer_token_auth_token_, true);
  20419. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20420. #ifdef CPPHTTPLIB_SSL_ENABLED
  20421. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20422. std::map<std::string, std::string> auth;
  20423. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20424. !proxy_digest_auth_username_.empty() &&
  20425. !proxy_digest_auth_password_.empty() &&
  20426. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20427. proxy_res = Response();
  20428. shutdown_and_close();
  20429. if (!create_and_connect_socket(error)) { return false; }
  20430. req.headers.erase("Proxy-Authorization");
  20431. req.headers.insert(detail::make_digest_authentication_header(
  20432. req, req.path, auth, 1, detail::random_string(10),
  20433. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20434. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20435. }
  20436. #endif
  20437. if (proxy_res.status != StatusCode::OK_200) {
  20438. error = Error::ProxyConnection;
  20439. return false;
  20440. }
  20441. return true;
  20442. }
  20443. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20444. proxy_host_ = host;
  20445. proxy_port_ = port;
  20446. }
  20447. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20448. const std::string &password) {
  20449. proxy_basic_auth_username_ = username;
  20450. proxy_basic_auth_password_ = password;
  20451. }
  20452. inline void
  20453. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20454. proxy_bearer_token_auth_token_ = token;
  20455. }
  20456. inline void
  20457. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20458. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20459. }
  20460. #ifdef CPPHTTPLIB_SSL_ENABLED
  20461. inline void
  20462. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20463. const std::string &ca_cert_dir_path) {
  20464. ca_cert_file_path_ = ca_cert_file_path;
  20465. ca_cert_dir_path_ = ca_cert_dir_path;
  20466. }
  20467. inline void
  20468. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20469. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20470. }
  20471. inline void WebSocketClient::set_session_verifier(
  20472. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20473. session_verifier_ = std::move(verifier);
  20474. }
  20475. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20476. if (store && tls_ctx_) {
  20477. // set_ca_store takes ownership of store
  20478. tls::set_ca_store(tls_ctx_, store);
  20479. custom_ca_loaded_ = true;
  20480. } else if (store) {
  20481. tls::free_ca_store(store);
  20482. }
  20483. }
  20484. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20485. std::size_t size) {
  20486. if (tls_ctx_ && ca_cert && size > 0) {
  20487. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20488. custom_ca_loaded_ = true;
  20489. }
  20490. }
  20491. inline void
  20492. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20493. server_certificate_verification_ = enabled;
  20494. }
  20495. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20496. server_hostname_verification_ = enabled;
  20497. }
  20498. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20499. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20500. }
  20501. inline void
  20502. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20503. const std::string &password) {
  20504. proxy_digest_auth_username_ = username;
  20505. proxy_digest_auth_password_ = password;
  20506. }
  20507. #endif // CPPHTTPLIB_SSL_ENABLED
  20508. } // namespace ws
  20509. // ----------------------------------------------------------------------------
  20510. } // namespace httplib
  20511. #endif // CPPHTTPLIB_HTTPLIB_H