1
0

httplib.h 830 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081
  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.63.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003f00"
  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. // How many send() calls are running on this client, guarded by
  2505. // request_mutex_
  2506. size_t send_depth_ = 0;
  2507. // These are all protected under socket_mutex
  2508. size_t socket_requests_in_flight_ = 0;
  2509. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2510. bool socket_should_be_closed_when_request_is_done_ = false;
  2511. // Hostname to connection target map. The value is an IP literal or another
  2512. // hostname; only the connection target changes, never the identity.
  2513. std::map<std::string, std::string> addr_map_;
  2514. // Default headers
  2515. Headers default_headers_;
  2516. // Header writer
  2517. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2518. detail::write_headers;
  2519. // Settings
  2520. std::string client_cert_path_;
  2521. std::string client_key_path_;
  2522. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2523. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2524. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2525. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2526. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2527. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2528. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2529. std::string basic_auth_username_;
  2530. std::string basic_auth_password_;
  2531. std::string bearer_token_auth_token_;
  2532. bool keep_alive_ = false;
  2533. bool follow_location_ = false;
  2534. bool path_encode_ = true;
  2535. int address_family_ = AF_UNSPEC;
  2536. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2537. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2538. SocketOptions socket_options_ = nullptr;
  2539. bool compress_ = false;
  2540. bool decompress_ = true;
  2541. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2542. bool has_payload_max_length_ = false;
  2543. std::string interface_;
  2544. std::string proxy_host_;
  2545. int proxy_port_ = -1;
  2546. std::string proxy_basic_auth_username_;
  2547. std::string proxy_basic_auth_password_;
  2548. std::string proxy_bearer_token_auth_token_;
  2549. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2550. mutable detail::NormalizedTarget host_normalized_;
  2551. mutable bool host_normalized_valid_ = false;
  2552. mutable std::mutex logger_mutex_;
  2553. Logger logger_;
  2554. ErrorLogger error_logger_;
  2555. private:
  2556. bool send_(Request &req, Response &res, Error &error);
  2557. Result send_(Request &&req);
  2558. socket_t create_client_socket(Error &error) const;
  2559. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2560. bool skip_100_continue = true) const;
  2561. bool write_request(Stream &strm, Request &req, bool close_connection,
  2562. Error &error, bool skip_body, bool &rejected_locally);
  2563. bool write_request_body(Stream &strm, Request &req, Error &error);
  2564. void prepare_default_headers(Request &r, bool for_stream,
  2565. const std::string &ct);
  2566. bool redirect(Request &req, Response &res, Error &error);
  2567. bool create_redirect_client(const std::string &scheme,
  2568. const std::string &host, int port, Request &req,
  2569. Response &res, const std::string &path,
  2570. const std::string &location, Error &error);
  2571. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2572. bool handle_request(Stream &strm, Request &req, Response &res,
  2573. bool close_connection, Error &error);
  2574. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2575. Request &req, const char *body, size_t content_length,
  2576. ContentProvider content_provider,
  2577. ContentProviderWithoutLength content_provider_without_length,
  2578. const std::string &content_type, ContentReceiver content_receiver,
  2579. Error &error);
  2580. Result send_with_content_provider_and_receiver(
  2581. const std::string &method, const std::string &path,
  2582. const Headers &headers, const char *body, size_t content_length,
  2583. ContentProvider content_provider,
  2584. ContentProviderWithoutLength content_provider_without_length,
  2585. const std::string &content_type, ContentReceiver content_receiver,
  2586. UploadProgress progress);
  2587. ContentProviderWithoutLength get_multipart_content_provider(
  2588. const std::string &boundary, const UploadFormDataItems &items,
  2589. const FormDataProviderItems &provider_items) const;
  2590. virtual bool
  2591. process_socket(const Socket &socket,
  2592. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2593. std::function<bool(Stream &strm)> callback);
  2594. virtual bool is_ssl() const;
  2595. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2596. StreamHandle open_stream_(Request &req);
  2597. void add_credential_headers(Request &req);
  2598. std::string proxy_target_prefix() const;
  2599. #ifdef CPPHTTPLIB_SSL_ENABLED
  2600. public:
  2601. void set_digest_auth(const std::string &username,
  2602. const std::string &password);
  2603. void set_proxy_digest_auth(const std::string &username,
  2604. const std::string &password);
  2605. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2606. const std::string &ca_cert_dir_path = std::string());
  2607. void enable_server_certificate_verification(bool enabled);
  2608. void enable_server_hostname_verification(bool enabled);
  2609. void enable_system_ca(bool enabled);
  2610. protected:
  2611. std::string digest_auth_username_;
  2612. std::string digest_auth_password_;
  2613. std::string proxy_digest_auth_username_;
  2614. std::string proxy_digest_auth_password_;
  2615. std::string ca_cert_file_path_;
  2616. std::string ca_cert_dir_path_;
  2617. bool server_certificate_verification_ = true;
  2618. bool server_hostname_verification_ = true;
  2619. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2620. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2621. int last_ssl_error_ = 0;
  2622. uint64_t last_backend_error_ = 0;
  2623. #endif
  2624. };
  2625. namespace detail {
  2626. // Stands in for a client that Client could not make from its arguments, so a
  2627. // request fails rather than going through a null pointer.
  2628. class InvalidClientImpl final : public ClientImpl {
  2629. public:
  2630. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2631. bool is_valid() const override { return false; }
  2632. private:
  2633. bool create_and_connect_socket(Socket &, Error &error) override {
  2634. error = Error::Connection;
  2635. return false;
  2636. }
  2637. };
  2638. } // namespace detail
  2639. class Client {
  2640. public:
  2641. // Universal interface
  2642. explicit Client(const std::string &scheme_host_port);
  2643. explicit Client(const std::string &scheme_host_port,
  2644. const std::string &client_cert_path,
  2645. const std::string &client_key_path);
  2646. // HTTP only interface
  2647. explicit Client(const std::string &host, int port);
  2648. explicit Client(const std::string &host, int port,
  2649. const std::string &client_cert_path,
  2650. const std::string &client_key_path);
  2651. Client(Client &&) = default;
  2652. Client &operator=(Client &&) = default;
  2653. ~Client();
  2654. bool is_valid() const;
  2655. // clang-format off
  2656. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2657. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2658. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2659. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2660. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2661. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2662. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2663. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2664. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2665. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2666. Result Head(const std::string &path);
  2667. Result Head(const std::string &path, const Headers &headers);
  2668. Result Post(const std::string &path);
  2669. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2670. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2671. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2672. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2673. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2674. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2675. Result Post(const std::string &path, const Params &params);
  2676. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2677. Result Post(const std::string &path, const Headers &headers);
  2678. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2679. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2680. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2681. 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);
  2682. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2683. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2684. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2685. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2686. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2687. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2688. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2689. Result Put(const std::string &path);
  2690. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2691. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2692. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2693. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2694. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2695. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2696. Result Put(const std::string &path, const Params &params);
  2697. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2698. Result Put(const std::string &path, const Headers &headers);
  2699. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2700. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2701. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2702. 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);
  2703. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2704. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2705. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2706. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2707. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2708. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2709. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2710. Result Patch(const std::string &path);
  2711. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2712. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2713. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2714. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2715. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2716. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2717. Result Patch(const std::string &path, const Params &params);
  2718. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2719. Result Patch(const std::string &path, const Headers &headers);
  2720. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2721. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2722. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2723. 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);
  2724. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2725. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2726. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2727. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2728. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2729. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2730. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2731. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2732. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2733. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2734. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2735. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2736. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2737. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2738. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2739. Result Options(const std::string &path);
  2740. Result Options(const std::string &path, const Headers &headers);
  2741. // clang-format on
  2742. // Streaming API: Open a stream for reading response body incrementally
  2743. // Socket ownership is transferred to StreamHandle for true streaming
  2744. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2745. ClientImpl::StreamHandle open_stream(const std::string &method,
  2746. const std::string &path,
  2747. const Params &params = {},
  2748. const Headers &headers = {},
  2749. const std::string &body = {},
  2750. const std::string &content_type = {});
  2751. bool send(Request &req, Response &res, Error &error);
  2752. Result send(const Request &req);
  2753. void stop();
  2754. std::string host() const;
  2755. int port() const;
  2756. size_t is_socket_open() const;
  2757. socket_t socket() const;
  2758. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2759. void set_default_headers(Headers headers);
  2760. void
  2761. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2762. void set_address_family(int family);
  2763. void set_tcp_nodelay(bool on);
  2764. void set_socket_options(SocketOptions socket_options);
  2765. void set_connection_timeout(time_t sec, time_t usec = 0);
  2766. template <class Rep, class Period>
  2767. void
  2768. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2769. void set_read_timeout(time_t sec, time_t usec = 0);
  2770. template <class Rep, class Period>
  2771. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2772. void set_write_timeout(time_t sec, time_t usec = 0);
  2773. template <class Rep, class Period>
  2774. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2775. void set_max_timeout(time_t msec);
  2776. template <class Rep, class Period>
  2777. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2778. void set_basic_auth(const std::string &username, const std::string &password);
  2779. void set_bearer_token_auth(const std::string &token);
  2780. void set_keep_alive(bool on);
  2781. void set_follow_location(bool on);
  2782. void set_path_encode(bool on);
  2783. void set_compress(bool on);
  2784. void set_decompress(bool on);
  2785. void set_payload_max_length(size_t length);
  2786. void set_interface(const std::string &intf);
  2787. void set_proxy(const std::string &host, int port);
  2788. void set_proxy_basic_auth(const std::string &username,
  2789. const std::string &password);
  2790. void set_proxy_bearer_token_auth(const std::string &token);
  2791. void set_no_proxy(const std::vector<std::string> &patterns);
  2792. void set_logger(Logger logger);
  2793. void set_error_logger(ErrorLogger error_logger);
  2794. private:
  2795. std::unique_ptr<ClientImpl> cli_;
  2796. #ifdef CPPHTTPLIB_SSL_ENABLED
  2797. public:
  2798. void set_digest_auth(const std::string &username,
  2799. const std::string &password);
  2800. void set_proxy_digest_auth(const std::string &username,
  2801. const std::string &password);
  2802. void enable_server_certificate_verification(bool enabled);
  2803. void enable_server_hostname_verification(bool enabled);
  2804. void enable_system_ca(bool enabled);
  2805. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2806. const std::string &ca_cert_dir_path = std::string());
  2807. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2808. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2809. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2810. void set_session_verifier(
  2811. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2812. tls::ctx_t tls_context() const;
  2813. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2814. void enable_windows_certificate_verification(bool enabled);
  2815. #endif
  2816. private:
  2817. bool is_ssl_ = false;
  2818. #endif
  2819. };
  2820. #ifdef CPPHTTPLIB_SSL_ENABLED
  2821. class SSLServer : public Server {
  2822. public:
  2823. SSLServer(const char *cert_path, const char *private_key_path,
  2824. const char *client_ca_cert_file_path = nullptr,
  2825. const char *client_ca_cert_dir_path = nullptr,
  2826. const char *private_key_password = nullptr);
  2827. struct PemMemory {
  2828. const char *cert_pem;
  2829. size_t cert_pem_len;
  2830. const char *key_pem;
  2831. size_t key_pem_len;
  2832. const char *client_ca_pem;
  2833. size_t client_ca_pem_len;
  2834. const char *private_key_password;
  2835. };
  2836. explicit SSLServer(const PemMemory &pem);
  2837. // The callback receives the ctx_t handle which can be cast to the
  2838. // appropriate backend type (SSL_CTX* for OpenSSL,
  2839. // tls::impl::MbedTlsContext* for Mbed TLS)
  2840. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2841. ~SSLServer() override;
  2842. bool is_valid() const override;
  2843. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2844. const char *client_ca_pem = nullptr,
  2845. const char *password = nullptr);
  2846. tls::ctx_t tls_context() const { return ctx_; }
  2847. int ssl_last_error() const { return last_ssl_error_; }
  2848. private:
  2849. bool process_and_close_socket(socket_t sock) override;
  2850. tls::ctx_t ctx_ = nullptr;
  2851. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2852. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2853. // bounds, and new ones wait while it is pending so that they cannot keep it
  2854. // waiting.
  2855. std::mutex ctx_mutex_;
  2856. std::condition_variable ctx_cv_;
  2857. size_t handshakes_in_progress_ = 0;
  2858. size_t updates_pending_ = 0;
  2859. int last_ssl_error_ = 0;
  2860. };
  2861. class SSLClient final : public ClientImpl {
  2862. public:
  2863. explicit SSLClient(const std::string &host);
  2864. explicit SSLClient(const std::string &host, int port);
  2865. explicit SSLClient(const std::string &host, int port,
  2866. const std::string &client_cert_path,
  2867. const std::string &client_key_path,
  2868. const std::string &private_key_password = std::string());
  2869. struct PemMemory {
  2870. const char *cert_pem;
  2871. size_t cert_pem_len;
  2872. const char *key_pem;
  2873. size_t key_pem_len;
  2874. const char *private_key_password;
  2875. };
  2876. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2877. ~SSLClient() override;
  2878. bool is_valid() const override;
  2879. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2880. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2881. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2882. // Post-handshake session verifier (backend-independent)
  2883. void set_session_verifier(
  2884. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2885. tls::ctx_t tls_context() const { return ctx_; }
  2886. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2887. void enable_windows_certificate_verification(bool enabled);
  2888. #endif
  2889. private:
  2890. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2891. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2892. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2893. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2894. bool
  2895. process_socket(const Socket &socket,
  2896. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2897. std::function<bool(Stream &strm)> callback) override;
  2898. bool is_ssl() const override;
  2899. bool setup_proxy_connection(
  2900. Socket &socket,
  2901. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2902. Response &res, bool &success, Error &error) override;
  2903. bool connect_with_proxy(
  2904. Socket &sock,
  2905. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2906. Response &res, bool &success, Error &error);
  2907. bool initialize_ssl(Socket &socket, Error &error);
  2908. void init_ctx();
  2909. void reset_ctx_on_error();
  2910. bool load_certs();
  2911. tls::ctx_t ctx_ = nullptr;
  2912. std::mutex ctx_mutex_;
  2913. std::once_flag initialize_cert_;
  2914. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2915. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2916. bool ca_cert_store_set_ = false;
  2917. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  2918. // no certificate, so that a CA that failed to come through fails
  2919. // verification instead of letting the system CAs in.
  2920. bool custom_ca_loaded_ = false;
  2921. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2922. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2923. // set_server_certificate_verifier() installed there.
  2924. tls::VerifyCallback server_certificate_verifier_;
  2925. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2926. bool enable_windows_cert_verification_ = true;
  2927. #endif
  2928. friend class ClientImpl;
  2929. };
  2930. #endif // CPPHTTPLIB_SSL_ENABLED
  2931. namespace detail {
  2932. template <typename T, typename U>
  2933. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2934. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2935. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2936. duration - std::chrono::seconds(sec))
  2937. .count();
  2938. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2939. }
  2940. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2941. return N - 1;
  2942. }
  2943. inline bool is_numeric(const std::string &str) {
  2944. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2945. }
  2946. // std::ranges::next(first, n, last) for C++11
  2947. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2948. for (; n > 0 && first != last; --n) {
  2949. ++first;
  2950. }
  2951. return first;
  2952. }
  2953. inline size_t get_header_value_u64(const Headers &headers,
  2954. const std::string &key, size_t def,
  2955. size_t id, bool &is_invalid_value) {
  2956. is_invalid_value = false;
  2957. auto rng = headers.equal_range(key);
  2958. auto it = bounded_next(rng.first, id, rng.second);
  2959. if (it != rng.second) {
  2960. if (is_numeric(it->second)) {
  2961. // Parse at size_t width so an out-of-range Content-Length is reported
  2962. // rather than silently saturated/truncated (a value above 2^32 would
  2963. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2964. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2965. size_t val = 0;
  2966. const auto &s = it->second;
  2967. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2968. if (r.ec == std::errc::result_out_of_range) {
  2969. is_invalid_value = true;
  2970. return (std::numeric_limits<size_t>::max)();
  2971. }
  2972. return val;
  2973. } else {
  2974. is_invalid_value = true;
  2975. }
  2976. }
  2977. return def;
  2978. }
  2979. inline size_t get_header_value_u64(const Headers &headers,
  2980. const std::string &key, size_t def,
  2981. size_t id) {
  2982. auto dummy = false;
  2983. return get_header_value_u64(headers, key, def, id, dummy);
  2984. }
  2985. } // namespace detail
  2986. template <class Rep, class Period>
  2987. inline Server &
  2988. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2989. detail::duration_to_sec_and_usec(
  2990. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2991. return *this;
  2992. }
  2993. template <class Rep, class Period>
  2994. inline Server &
  2995. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2996. detail::duration_to_sec_and_usec(
  2997. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2998. return *this;
  2999. }
  3000. template <class Rep, class Period>
  3001. inline Server &
  3002. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  3003. detail::duration_to_sec_and_usec(
  3004. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  3005. return *this;
  3006. }
  3007. template <class Rep, class Period>
  3008. inline void ClientImpl::set_connection_timeout(
  3009. const std::chrono::duration<Rep, Period> &duration) {
  3010. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3011. set_connection_timeout(sec, usec);
  3012. });
  3013. }
  3014. template <class Rep, class Period>
  3015. inline void ClientImpl::set_read_timeout(
  3016. const std::chrono::duration<Rep, Period> &duration) {
  3017. detail::duration_to_sec_and_usec(
  3018. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3019. }
  3020. template <class Rep, class Period>
  3021. inline void ClientImpl::set_write_timeout(
  3022. const std::chrono::duration<Rep, Period> &duration) {
  3023. detail::duration_to_sec_and_usec(
  3024. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3025. }
  3026. template <class Rep, class Period>
  3027. inline void ClientImpl::set_max_timeout(
  3028. const std::chrono::duration<Rep, Period> &duration) {
  3029. auto msec =
  3030. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  3031. set_max_timeout(static_cast<time_t>(msec));
  3032. }
  3033. template <class Rep, class Period>
  3034. inline void Client::set_connection_timeout(
  3035. const std::chrono::duration<Rep, Period> &duration) {
  3036. cli_->set_connection_timeout(duration);
  3037. }
  3038. template <class Rep, class Period>
  3039. inline void
  3040. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3041. cli_->set_read_timeout(duration);
  3042. }
  3043. template <class Rep, class Period>
  3044. inline void
  3045. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3046. cli_->set_write_timeout(duration);
  3047. }
  3048. inline void Client::set_max_timeout(time_t msec) {
  3049. cli_->set_max_timeout(msec);
  3050. }
  3051. template <class Rep, class Period>
  3052. inline void
  3053. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3054. cli_->set_max_timeout(duration);
  3055. }
  3056. /*
  3057. * Forward declarations and types that will be part of the .h file if split into
  3058. * .h + .cc.
  3059. */
  3060. std::string hosted_at(const std::string &hostname);
  3061. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3062. // JavaScript-style URL encoding/decoding functions
  3063. std::string encode_uri_component(const std::string &value);
  3064. std::string encode_uri(const std::string &value);
  3065. std::string decode_uri_component(const std::string &value);
  3066. std::string decode_uri(const std::string &value);
  3067. // RFC 3986 compliant URL component encoding/decoding functions
  3068. std::string encode_path_component(const std::string &component);
  3069. std::string decode_path_component(const std::string &component);
  3070. std::string encode_query_component(const std::string &component,
  3071. bool space_as_plus = true);
  3072. std::string decode_query_component(const std::string &component,
  3073. bool plus_as_space = true);
  3074. std::string sanitize_filename(const std::string &filename);
  3075. std::string append_query_params(const std::string &path, const Params &params);
  3076. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3077. std::pair<std::string, std::string>
  3078. make_basic_authentication_header(const std::string &username,
  3079. const std::string &password,
  3080. bool is_proxy = false);
  3081. namespace detail {
  3082. #if defined(_WIN32)
  3083. inline std::wstring u8string_to_wstring(const char *s) {
  3084. if (!s) { return std::wstring(); }
  3085. auto len = static_cast<int>(strlen(s));
  3086. if (!len) { return std::wstring(); }
  3087. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3088. if (!wlen) { return std::wstring(); }
  3089. std::wstring ws;
  3090. ws.resize(wlen);
  3091. wlen = ::MultiByteToWideChar(
  3092. CP_UTF8, 0, s, len,
  3093. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3094. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3095. return ws;
  3096. }
  3097. #endif
  3098. struct FileStat {
  3099. FileStat(const std::string &path);
  3100. bool is_file() const;
  3101. bool is_dir() const;
  3102. time_t mtime() const;
  3103. size_t size() const;
  3104. private:
  3105. #if defined(_WIN32)
  3106. struct _stat st_;
  3107. #else
  3108. struct stat st_;
  3109. #endif
  3110. int ret_ = -1;
  3111. };
  3112. std::string make_host_and_port_string(const std::string &host, int port,
  3113. bool is_ssl);
  3114. template <typename T>
  3115. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3116. Error &error);
  3117. std::string trim_copy(const std::string &s);
  3118. void divide(
  3119. const char *data, std::size_t size, char d,
  3120. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3121. fn);
  3122. void divide(
  3123. const std::string &str, char d,
  3124. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3125. fn);
  3126. void split(const char *b, const char *e, char d,
  3127. std::function<void(const char *, const char *)> fn);
  3128. void split(const char *b, const char *e, char d, size_t m,
  3129. std::function<void(const char *, const char *)> fn);
  3130. bool split_find(const char *b, const char *e, char d,
  3131. std::function<bool(const char *, const char *)> fn);
  3132. bool has_header_token(const Headers &headers, const std::string &key,
  3133. const std::string &token);
  3134. std::string websocket_accept_key(const std::string &client_key);
  3135. bool is_websocket_upgrade(const Request &req);
  3136. bool process_client_socket(
  3137. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3138. time_t write_timeout_sec, time_t write_timeout_usec,
  3139. time_t max_timeout_msec,
  3140. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3141. std::function<bool(Stream &)> callback);
  3142. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3143. int port, int address_family, bool tcp_nodelay,
  3144. bool ipv6_v6only, SocketOptions socket_options,
  3145. time_t connection_timeout_sec,
  3146. time_t connection_timeout_usec,
  3147. time_t read_timeout_sec, time_t read_timeout_usec,
  3148. time_t write_timeout_sec,
  3149. time_t write_timeout_usec,
  3150. const std::string &intf, Error &error);
  3151. const char *get_header_value(const Headers &headers, const std::string &key,
  3152. const char *def, size_t id);
  3153. std::string get_combined_header_value(const Headers &headers,
  3154. const std::string &key);
  3155. std::string params_to_query_str(const Params &params);
  3156. void parse_query_text(const char *data, std::size_t size, Params &params);
  3157. void parse_query_text(const std::string &s, Params &params);
  3158. bool parse_multipart_boundary(const std::string &content_type,
  3159. std::string &boundary);
  3160. bool parse_range_header(const std::string &s, Ranges &ranges);
  3161. bool parse_accept_header(const std::string &s,
  3162. std::vector<std::string> &content_types);
  3163. void parse_disposition_params(const std::string &s, Params &params);
  3164. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3165. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3166. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3167. EncodingType encoding_type(const Request &req, const Response &res,
  3168. const std::string &content_type);
  3169. EncodingType encoding_type(const Request &req, const Response &res);
  3170. class BufferStream final : public Stream {
  3171. public:
  3172. BufferStream() = default;
  3173. ~BufferStream() override = default;
  3174. bool is_readable() const override;
  3175. bool wait_readable() const override;
  3176. bool wait_writable() const override;
  3177. ssize_t read(char *ptr, size_t size) override;
  3178. ssize_t write(const char *ptr, size_t size) override;
  3179. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3180. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3181. socket_t socket() const override;
  3182. time_t duration() const override;
  3183. const std::string &get_buffer() const;
  3184. private:
  3185. std::string buffer;
  3186. size_t position = 0;
  3187. };
  3188. class compressor {
  3189. public:
  3190. virtual ~compressor() = default;
  3191. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3192. virtual bool compress(const char *data, size_t data_length, bool last,
  3193. Callback callback) = 0;
  3194. };
  3195. class decompressor {
  3196. public:
  3197. virtual ~decompressor() = default;
  3198. virtual bool is_valid() const = 0;
  3199. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3200. virtual bool decompress(const char *data, size_t data_length,
  3201. Callback callback) = 0;
  3202. };
  3203. class nocompressor final : public compressor {
  3204. public:
  3205. ~nocompressor() override = default;
  3206. bool compress(const char *data, size_t data_length, bool /*last*/,
  3207. Callback callback) override;
  3208. };
  3209. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3210. class gzip_compressor final : public compressor {
  3211. public:
  3212. gzip_compressor();
  3213. ~gzip_compressor() override;
  3214. bool compress(const char *data, size_t data_length, bool last,
  3215. Callback callback) override;
  3216. private:
  3217. bool is_valid_ = false;
  3218. z_stream strm_;
  3219. };
  3220. class gzip_decompressor final : public decompressor {
  3221. public:
  3222. gzip_decompressor();
  3223. ~gzip_decompressor() override;
  3224. bool is_valid() const override;
  3225. bool decompress(const char *data, size_t data_length,
  3226. Callback callback) override;
  3227. private:
  3228. bool is_valid_ = false;
  3229. z_stream strm_;
  3230. };
  3231. #endif
  3232. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3233. class brotli_compressor final : public compressor {
  3234. public:
  3235. brotli_compressor();
  3236. ~brotli_compressor();
  3237. bool compress(const char *data, size_t data_length, bool last,
  3238. Callback callback) override;
  3239. private:
  3240. BrotliEncoderState *state_ = nullptr;
  3241. };
  3242. class brotli_decompressor final : public decompressor {
  3243. public:
  3244. brotli_decompressor();
  3245. ~brotli_decompressor();
  3246. bool is_valid() const override;
  3247. bool decompress(const char *data, size_t data_length,
  3248. Callback callback) override;
  3249. private:
  3250. BrotliDecoderResult decoder_r;
  3251. BrotliDecoderState *decoder_s = nullptr;
  3252. };
  3253. #endif
  3254. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3255. class zstd_compressor : public compressor {
  3256. public:
  3257. zstd_compressor();
  3258. ~zstd_compressor();
  3259. bool compress(const char *data, size_t data_length, bool last,
  3260. Callback callback) override;
  3261. private:
  3262. ZSTD_CCtx *ctx_ = nullptr;
  3263. };
  3264. class zstd_decompressor : public decompressor {
  3265. public:
  3266. zstd_decompressor();
  3267. ~zstd_decompressor();
  3268. bool is_valid() const override;
  3269. bool decompress(const char *data, size_t data_length,
  3270. Callback callback) override;
  3271. private:
  3272. ZSTD_DCtx *ctx_ = nullptr;
  3273. };
  3274. #endif
  3275. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3276. // to store data. The call can set memory on stack for performance.
  3277. class stream_line_reader {
  3278. public:
  3279. stream_line_reader(Stream &strm, char *fixed_buffer,
  3280. size_t fixed_buffer_size);
  3281. const char *ptr() const;
  3282. size_t size() const;
  3283. bool end_with_crlf() const;
  3284. bool getline();
  3285. private:
  3286. void append(char c);
  3287. void append(const char *data, size_t size);
  3288. Stream &strm_;
  3289. char *fixed_buffer_;
  3290. const size_t fixed_buffer_size_;
  3291. size_t fixed_buffer_used_size_ = 0;
  3292. std::string growable_buffer_;
  3293. };
  3294. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3295. const Headers &src_headers);
  3296. struct ChunkedDecoder {
  3297. Stream &strm;
  3298. size_t chunk_remaining = 0;
  3299. bool finished = false;
  3300. char line_buf[64];
  3301. size_t last_chunk_total = 0;
  3302. size_t last_chunk_offset = 0;
  3303. size_t overhead = 0;
  3304. explicit ChunkedDecoder(Stream &s);
  3305. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3306. size_t &out_chunk_total);
  3307. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3308. };
  3309. // A regular file opened to be served: mapped on Windows, read with pread()
  3310. // elsewhere.
  3311. class mmap {
  3312. public:
  3313. mmap(const char *path);
  3314. ~mmap();
  3315. bool open(const char *path);
  3316. void close();
  3317. bool is_open() const;
  3318. size_t size() const;
  3319. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3320. // down to 0, if the file has shrunk since it was opened.
  3321. size_t read(size_t offset, char *buf, size_t len) const;
  3322. private:
  3323. #if defined(_WIN32)
  3324. HANDLE hFile_ = NULL;
  3325. HANDLE hMapping_ = NULL;
  3326. void *addr_ = nullptr;
  3327. bool is_open_empty_file = false;
  3328. #else
  3329. int fd_ = -1;
  3330. #endif
  3331. size_t size_ = 0;
  3332. };
  3333. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3334. namespace fields {
  3335. bool is_token_char(char c);
  3336. bool is_token(const std::string &s);
  3337. bool is_field_name(const std::string &s);
  3338. bool is_vchar(char c);
  3339. bool is_obs_text(char c);
  3340. bool is_field_vchar(char c);
  3341. bool is_field_content(const std::string &s);
  3342. bool is_field_value(const std::string &s);
  3343. bool is_field_valid(const std::string &name, const std::string &value);
  3344. bool is_request_target(const std::string &s);
  3345. bool is_host(const std::string &s);
  3346. } // namespace fields
  3347. } // namespace detail
  3348. /*
  3349. * TLS Abstraction Layer Declarations
  3350. */
  3351. #ifdef CPPHTTPLIB_SSL_ENABLED
  3352. // TLS abstraction layer - backend-specific type declarations
  3353. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3354. namespace tls {
  3355. namespace impl {
  3356. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3357. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3358. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3359. struct MbedTlsContext {
  3360. mbedtls_ssl_config conf;
  3361. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3362. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3363. mbedtls_entropy_context entropy;
  3364. mbedtls_ctr_drbg_context ctr_drbg;
  3365. #endif
  3366. mbedtls_x509_crt ca_chain;
  3367. mbedtls_x509_crt own_cert;
  3368. mbedtls_pk_context own_key;
  3369. bool is_server = false;
  3370. // Peer certificate required (set_verify_client()); a client defaults to true
  3371. bool verify_client = false;
  3372. // Set by tls::set_verify_callback().
  3373. VerifyCallback verify_callback;
  3374. MbedTlsContext();
  3375. ~MbedTlsContext();
  3376. MbedTlsContext(const MbedTlsContext &) = delete;
  3377. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3378. };
  3379. } // namespace impl
  3380. } // namespace tls
  3381. #endif
  3382. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3383. namespace tls {
  3384. namespace impl {
  3385. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3386. // This struct is accessible via tls::impl for use in SSL context
  3387. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3388. struct WolfSSLContext {
  3389. WOLFSSL_CTX *ctx = nullptr;
  3390. bool is_server = false;
  3391. // Peer certificate required (set_verify_client()); a client defaults to true
  3392. bool verify_client = false;
  3393. // Replaced under verify_callback_mutex()
  3394. std::shared_ptr<VerifyCallback> verify_callback;
  3395. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3396. WolfSSLContext();
  3397. ~WolfSSLContext();
  3398. WolfSSLContext(const WolfSSLContext &) = delete;
  3399. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3400. };
  3401. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3402. struct WolfSSLCAStore {
  3403. std::string pem_data;
  3404. };
  3405. } // namespace impl
  3406. } // namespace tls
  3407. #endif
  3408. #endif // CPPHTTPLIB_SSL_ENABLED
  3409. namespace stream {
  3410. class Result {
  3411. public:
  3412. Result();
  3413. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3414. Result(Result &&other) noexcept;
  3415. Result &operator=(Result &&other) noexcept;
  3416. Result(const Result &) = delete;
  3417. Result &operator=(const Result &) = delete;
  3418. // Response info
  3419. bool is_valid() const;
  3420. explicit operator bool() const;
  3421. int status() const;
  3422. const Headers &headers() const;
  3423. std::string get_header_value(const std::string &key,
  3424. const char *def = "") const;
  3425. bool has_header(const std::string &key) const;
  3426. Error error() const;
  3427. Error read_error() const;
  3428. bool has_read_error() const;
  3429. // Stream reading
  3430. bool next();
  3431. const char *data() const;
  3432. size_t size() const;
  3433. std::string read_all();
  3434. private:
  3435. ClientImpl::StreamHandle handle_;
  3436. std::string buffer_;
  3437. size_t current_size_ = 0;
  3438. size_t chunk_size_;
  3439. bool finished_ = false;
  3440. };
  3441. // GET
  3442. template <typename ClientType>
  3443. inline Result Get(ClientType &cli, const std::string &path,
  3444. size_t chunk_size = 8192) {
  3445. return Result{cli.open_stream("GET", path), chunk_size};
  3446. }
  3447. template <typename ClientType>
  3448. inline Result Get(ClientType &cli, const std::string &path,
  3449. const Headers &headers, size_t chunk_size = 8192) {
  3450. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3451. }
  3452. template <typename ClientType>
  3453. inline Result Get(ClientType &cli, const std::string &path,
  3454. const Params &params, size_t chunk_size = 8192) {
  3455. return Result{cli.open_stream("GET", path, params), chunk_size};
  3456. }
  3457. template <typename ClientType>
  3458. inline Result Get(ClientType &cli, const std::string &path,
  3459. const Params &params, const Headers &headers,
  3460. size_t chunk_size = 8192) {
  3461. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3462. }
  3463. // POST
  3464. template <typename ClientType>
  3465. inline Result Post(ClientType &cli, const std::string &path,
  3466. const std::string &body, const std::string &content_type,
  3467. size_t chunk_size = 8192) {
  3468. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3469. chunk_size};
  3470. }
  3471. template <typename ClientType>
  3472. inline Result Post(ClientType &cli, const std::string &path,
  3473. const Headers &headers, const std::string &body,
  3474. const std::string &content_type, size_t chunk_size = 8192) {
  3475. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3476. chunk_size};
  3477. }
  3478. template <typename ClientType>
  3479. inline Result Post(ClientType &cli, const std::string &path,
  3480. const Params &params, const std::string &body,
  3481. const std::string &content_type, size_t chunk_size = 8192) {
  3482. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3483. chunk_size};
  3484. }
  3485. template <typename ClientType>
  3486. inline Result Post(ClientType &cli, const std::string &path,
  3487. const Params &params, const Headers &headers,
  3488. const std::string &body, const std::string &content_type,
  3489. size_t chunk_size = 8192) {
  3490. return Result{
  3491. cli.open_stream("POST", path, params, headers, body, content_type),
  3492. chunk_size};
  3493. }
  3494. // PUT
  3495. template <typename ClientType>
  3496. inline Result Put(ClientType &cli, const std::string &path,
  3497. const std::string &body, const std::string &content_type,
  3498. size_t chunk_size = 8192) {
  3499. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3500. chunk_size};
  3501. }
  3502. template <typename ClientType>
  3503. inline Result Put(ClientType &cli, const std::string &path,
  3504. const Headers &headers, const std::string &body,
  3505. const std::string &content_type, size_t chunk_size = 8192) {
  3506. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3507. chunk_size};
  3508. }
  3509. template <typename ClientType>
  3510. inline Result Put(ClientType &cli, const std::string &path,
  3511. const Params &params, const std::string &body,
  3512. const std::string &content_type, size_t chunk_size = 8192) {
  3513. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3514. chunk_size};
  3515. }
  3516. template <typename ClientType>
  3517. inline Result Put(ClientType &cli, const std::string &path,
  3518. const Params &params, const Headers &headers,
  3519. const std::string &body, const std::string &content_type,
  3520. size_t chunk_size = 8192) {
  3521. return Result{
  3522. cli.open_stream("PUT", path, params, headers, body, content_type),
  3523. chunk_size};
  3524. }
  3525. // PATCH
  3526. template <typename ClientType>
  3527. inline Result Patch(ClientType &cli, const std::string &path,
  3528. const std::string &body, const std::string &content_type,
  3529. size_t chunk_size = 8192) {
  3530. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3531. chunk_size};
  3532. }
  3533. template <typename ClientType>
  3534. inline Result Patch(ClientType &cli, const std::string &path,
  3535. const Headers &headers, const std::string &body,
  3536. const std::string &content_type, size_t chunk_size = 8192) {
  3537. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3538. chunk_size};
  3539. }
  3540. template <typename ClientType>
  3541. inline Result Patch(ClientType &cli, const std::string &path,
  3542. const Params &params, const std::string &body,
  3543. const std::string &content_type, size_t chunk_size = 8192) {
  3544. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3545. chunk_size};
  3546. }
  3547. template <typename ClientType>
  3548. inline Result Patch(ClientType &cli, const std::string &path,
  3549. const Params &params, const Headers &headers,
  3550. const std::string &body, const std::string &content_type,
  3551. size_t chunk_size = 8192) {
  3552. return Result{
  3553. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3554. chunk_size};
  3555. }
  3556. // DELETE
  3557. template <typename ClientType>
  3558. inline Result Delete(ClientType &cli, const std::string &path,
  3559. size_t chunk_size = 8192) {
  3560. return Result{cli.open_stream("DELETE", path), chunk_size};
  3561. }
  3562. template <typename ClientType>
  3563. inline Result Delete(ClientType &cli, const std::string &path,
  3564. const Headers &headers, size_t chunk_size = 8192) {
  3565. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3566. }
  3567. template <typename ClientType>
  3568. inline Result Delete(ClientType &cli, const std::string &path,
  3569. const std::string &body, const std::string &content_type,
  3570. size_t chunk_size = 8192) {
  3571. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3572. chunk_size};
  3573. }
  3574. template <typename ClientType>
  3575. inline Result Delete(ClientType &cli, const std::string &path,
  3576. const Headers &headers, const std::string &body,
  3577. const std::string &content_type,
  3578. size_t chunk_size = 8192) {
  3579. return Result{
  3580. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3581. chunk_size};
  3582. }
  3583. template <typename ClientType>
  3584. inline Result Delete(ClientType &cli, const std::string &path,
  3585. const Params &params, size_t chunk_size = 8192) {
  3586. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3587. }
  3588. template <typename ClientType>
  3589. inline Result Delete(ClientType &cli, const std::string &path,
  3590. const Params &params, const Headers &headers,
  3591. size_t chunk_size = 8192) {
  3592. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3593. }
  3594. template <typename ClientType>
  3595. inline Result Delete(ClientType &cli, const std::string &path,
  3596. const Params &params, const std::string &body,
  3597. const std::string &content_type,
  3598. size_t chunk_size = 8192) {
  3599. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3600. chunk_size};
  3601. }
  3602. template <typename ClientType>
  3603. inline Result Delete(ClientType &cli, const std::string &path,
  3604. const Params &params, const Headers &headers,
  3605. const std::string &body, const std::string &content_type,
  3606. size_t chunk_size = 8192) {
  3607. return Result{
  3608. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3609. chunk_size};
  3610. }
  3611. // HEAD
  3612. template <typename ClientType>
  3613. inline Result Head(ClientType &cli, const std::string &path,
  3614. size_t chunk_size = 8192) {
  3615. return Result{cli.open_stream("HEAD", path), chunk_size};
  3616. }
  3617. template <typename ClientType>
  3618. inline Result Head(ClientType &cli, const std::string &path,
  3619. const Headers &headers, size_t chunk_size = 8192) {
  3620. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3621. }
  3622. template <typename ClientType>
  3623. inline Result Head(ClientType &cli, const std::string &path,
  3624. const Params &params, size_t chunk_size = 8192) {
  3625. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3626. }
  3627. template <typename ClientType>
  3628. inline Result Head(ClientType &cli, const std::string &path,
  3629. const Params &params, const Headers &headers,
  3630. size_t chunk_size = 8192) {
  3631. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3632. }
  3633. // OPTIONS
  3634. template <typename ClientType>
  3635. inline Result Options(ClientType &cli, const std::string &path,
  3636. size_t chunk_size = 8192) {
  3637. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3638. }
  3639. template <typename ClientType>
  3640. inline Result Options(ClientType &cli, const std::string &path,
  3641. const Headers &headers, size_t chunk_size = 8192) {
  3642. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3643. }
  3644. template <typename ClientType>
  3645. inline Result Options(ClientType &cli, const std::string &path,
  3646. const Params &params, size_t chunk_size = 8192) {
  3647. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3648. }
  3649. template <typename ClientType>
  3650. inline Result Options(ClientType &cli, const std::string &path,
  3651. const Params &params, const Headers &headers,
  3652. size_t chunk_size = 8192) {
  3653. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3654. }
  3655. } // namespace stream
  3656. namespace sse {
  3657. struct SSEMessage {
  3658. std::string event; // Event type (default: "message")
  3659. std::string data; // Event payload
  3660. std::string id; // Event ID for Last-Event-ID header
  3661. SSEMessage();
  3662. void clear();
  3663. };
  3664. class SSEClient {
  3665. public:
  3666. using MessageHandler = std::function<void(const SSEMessage &)>;
  3667. using ErrorHandler = std::function<void(Error)>;
  3668. using OpenHandler = std::function<void()>;
  3669. SSEClient(Client &client, const std::string &path);
  3670. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3671. ~SSEClient();
  3672. SSEClient(const SSEClient &) = delete;
  3673. SSEClient &operator=(const SSEClient &) = delete;
  3674. // Event handlers
  3675. SSEClient &on_message(MessageHandler handler);
  3676. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3677. SSEClient &on_open(OpenHandler handler);
  3678. SSEClient &on_error(ErrorHandler handler);
  3679. SSEClient &set_reconnect_interval(int ms);
  3680. SSEClient &set_max_reconnect_attempts(int n);
  3681. // Update headers (thread-safe)
  3682. SSEClient &set_headers(const Headers &headers);
  3683. // State accessors
  3684. bool is_connected() const;
  3685. const std::string &last_event_id() const;
  3686. // Blocking start - runs event loop with auto-reconnect
  3687. void start();
  3688. // Non-blocking start - runs in background thread
  3689. void start_async();
  3690. // Stop the client (thread-safe)
  3691. void stop();
  3692. private:
  3693. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3694. bool &has_data, bool &has_id);
  3695. void run_event_loop();
  3696. void dispatch_event(const SSEMessage &msg);
  3697. bool should_reconnect(int count) const;
  3698. void wait_for_reconnect();
  3699. // Client and path
  3700. Client &client_;
  3701. std::string path_;
  3702. Headers headers_;
  3703. mutable std::mutex headers_mutex_;
  3704. // Callbacks
  3705. MessageHandler on_message_;
  3706. std::map<std::string, MessageHandler> event_handlers_;
  3707. OpenHandler on_open_;
  3708. ErrorHandler on_error_;
  3709. // Configuration
  3710. int reconnect_interval_ms_ = 3000;
  3711. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3712. // State
  3713. std::atomic<bool> running_{false};
  3714. std::atomic<bool> connected_{false};
  3715. std::string last_event_id_;
  3716. // Async support
  3717. std::thread async_thread_;
  3718. };
  3719. } // namespace sse
  3720. namespace ws {
  3721. class WebSocketClient;
  3722. enum class Opcode : uint8_t {
  3723. Continuation = 0x0,
  3724. Text = 0x1,
  3725. Binary = 0x2,
  3726. Close = 0x8,
  3727. Ping = 0x9,
  3728. Pong = 0xA,
  3729. };
  3730. enum class CloseStatus : uint16_t {
  3731. Normal = 1000,
  3732. GoingAway = 1001,
  3733. ProtocolError = 1002,
  3734. UnsupportedData = 1003,
  3735. NoStatus = 1005,
  3736. Abnormal = 1006,
  3737. InvalidPayload = 1007,
  3738. PolicyViolation = 1008,
  3739. MessageTooBig = 1009,
  3740. MandatoryExtension = 1010,
  3741. InternalError = 1011,
  3742. };
  3743. // Timeout is returned only when a read timeout was set and it elapsed before
  3744. // any byte of a frame arrived: nothing was consumed and the connection is
  3745. // still open, so the caller can send on it and read again. `msg` is left
  3746. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3747. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3748. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3749. // upgrade handshake fully succeeded. On failure error() identifies the
  3750. // failing layer; status()/headers() expose the server's upgrade response
  3751. // when one was received (status() is -1 otherwise), or the proxy's reply to
  3752. // CONNECT when error() is ProxyConnection.
  3753. class Result {
  3754. public:
  3755. Result() = default;
  3756. Result(Error err, int status, Headers &&headers)
  3757. : err_(err), status_(status), headers_(std::move(headers)) {}
  3758. explicit operator bool() const { return err_ == Error::Success; }
  3759. Error error() const { return err_; }
  3760. // Upgrade response info
  3761. int status() const { return status_; }
  3762. const Headers &headers() const { return headers_; }
  3763. std::string get_header_value(const std::string &key,
  3764. const char *def = "") const {
  3765. return detail::get_header_value(headers_, key, def, 0);
  3766. }
  3767. bool has_header(const std::string &key) const {
  3768. return headers_.find(key) != headers_.end();
  3769. }
  3770. #ifdef CPPHTTPLIB_SSL_ENABLED
  3771. Result(Error err, int status, Headers &&headers, int ssl_error,
  3772. uint64_t ssl_backend_error)
  3773. : err_(err), status_(status), headers_(std::move(headers)),
  3774. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3775. int ssl_error() const { return ssl_error_; }
  3776. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3777. #endif
  3778. private:
  3779. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3780. int status_ = -1;
  3781. Headers headers_;
  3782. #ifdef CPPHTTPLIB_SSL_ENABLED
  3783. int ssl_error_ = 0;
  3784. uint64_t ssl_backend_error_ = 0;
  3785. #endif
  3786. };
  3787. class WebSocket {
  3788. public:
  3789. WebSocket(const WebSocket &) = delete;
  3790. WebSocket &operator=(const WebSocket &) = delete;
  3791. ~WebSocket();
  3792. ReadResult read(std::string &msg);
  3793. bool send(const std::string &data);
  3794. bool send(const char *data, size_t len);
  3795. void close(CloseStatus status = CloseStatus::Normal,
  3796. const std::string &reason = "");
  3797. const Request &request() const;
  3798. bool is_open() const;
  3799. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3800. // A server handler owns its connection's timeout this way; a client sets it
  3801. // through WebSocketClient. Safe to call while another thread is in read().
  3802. //
  3803. // Only a timeout set here is reported as Timeout. The compile-time default
  3804. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3805. // than a request for control, so when it elapses read() returns Fail and
  3806. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3807. void set_read_timeout(time_t sec, time_t usec = 0);
  3808. template <class Rep, class Period>
  3809. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3810. private:
  3811. friend class httplib::Server;
  3812. friend class httplib::ws::WebSocketClient;
  3813. WebSocket(
  3814. Stream &strm, const Request &req, bool is_server,
  3815. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3816. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3817. : strm_(strm), req_(req), is_server_(is_server),
  3818. ping_interval_sec_(ping_interval_sec),
  3819. max_missed_pongs_(max_missed_pongs) {
  3820. start_heartbeat();
  3821. }
  3822. WebSocket(
  3823. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3824. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3825. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3826. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3827. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3828. max_missed_pongs_(max_missed_pongs) {
  3829. start_heartbeat();
  3830. }
  3831. void start_heartbeat();
  3832. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3833. Stream &strm_;
  3834. std::unique_ptr<Stream> owned_strm_;
  3835. Request req_;
  3836. bool is_server_;
  3837. time_t ping_interval_sec_;
  3838. int max_missed_pongs_;
  3839. int unacked_pings_ = 0;
  3840. std::atomic<bool> closed_{false};
  3841. // Set when the peer stopped answering pings, to end a read() waiting on it
  3842. std::atomic<bool> pong_timed_out_{false};
  3843. // Set once the caller has bounded read() through set_read_timeout(). Until
  3844. // then the timeout in effect is the compile-time default, and elapsing it
  3845. // is a failure that closes the connection, not a Timeout.
  3846. std::atomic<bool> read_timeout_set_{false};
  3847. std::mutex write_mutex_;
  3848. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3849. // may do so: read_websocket_frame() reads a payload until it has the whole
  3850. // declared length, so a second parser stealing bytes silently corrupts the
  3851. // message the first one is assembling.
  3852. std::mutex read_mutex_;
  3853. std::thread ping_thread_;
  3854. std::mutex ping_mutex_;
  3855. std::condition_variable ping_cv_;
  3856. };
  3857. class WebSocketClient {
  3858. public:
  3859. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3860. const Headers &headers = {});
  3861. ~WebSocketClient();
  3862. WebSocketClient(const WebSocketClient &) = delete;
  3863. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3864. bool is_valid() const;
  3865. Result connect();
  3866. ReadResult read(std::string &msg);
  3867. bool send(const std::string &data);
  3868. bool send(const char *data, size_t len);
  3869. void close(CloseStatus status = CloseStatus::Normal,
  3870. const std::string &reason = "");
  3871. bool is_open() const;
  3872. const std::string &subprotocol() const;
  3873. void set_read_timeout(time_t sec, time_t usec = 0);
  3874. template <class Rep, class Period>
  3875. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3876. void set_write_timeout(time_t sec, time_t usec = 0);
  3877. template <class Rep, class Period>
  3878. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3879. void set_websocket_ping_interval(time_t sec);
  3880. void set_websocket_max_missed_pongs(int count);
  3881. void set_tcp_nodelay(bool on);
  3882. void set_address_family(int family);
  3883. void set_ipv6_v6only(bool on);
  3884. void set_socket_options(SocketOptions socket_options);
  3885. void set_connection_timeout(time_t sec, time_t usec = 0);
  3886. template <class Rep, class Period>
  3887. void
  3888. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3889. void set_interface(const std::string &intf);
  3890. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3891. void set_proxy(const std::string &host, int port);
  3892. void set_proxy_basic_auth(const std::string &username,
  3893. const std::string &password);
  3894. void set_proxy_bearer_token_auth(const std::string &token);
  3895. void set_no_proxy(const std::vector<std::string> &patterns);
  3896. #ifdef CPPHTTPLIB_SSL_ENABLED
  3897. struct PemMemory {
  3898. const char *cert_pem;
  3899. size_t cert_pem_len;
  3900. const char *key_pem;
  3901. size_t key_pem_len;
  3902. const char *private_key_password;
  3903. };
  3904. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3905. const PemMemory &pem, const Headers &headers = {});
  3906. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3907. const std::string &ca_cert_dir_path = std::string());
  3908. void set_ca_cert_store(tls::ca_store_t store);
  3909. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3910. void enable_server_certificate_verification(bool enabled);
  3911. void enable_server_hostname_verification(bool enabled);
  3912. void enable_system_ca(bool enabled);
  3913. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3914. void set_session_verifier(
  3915. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3916. void set_proxy_digest_auth(const std::string &username,
  3917. const std::string &password);
  3918. #endif
  3919. private:
  3920. void shutdown_and_close();
  3921. std::pair<time_t, time_t> handshake_timeout() const;
  3922. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3923. int &ssl_error, uint64_t &ssl_backend_error);
  3924. void prepare_default_headers(Request &req);
  3925. bool is_proxy_enabled() const;
  3926. bool create_and_connect_socket(Error &error);
  3927. bool send_proxy_connect(Request &req, Response &proxy_res, Error &error);
  3928. bool connect_with_proxy(Response &proxy_res, Error &error);
  3929. std::string host_;
  3930. int port_;
  3931. std::string path_;
  3932. Headers headers_;
  3933. std::string subprotocol_;
  3934. bool is_valid_ = false;
  3935. socket_t sock_ = INVALID_SOCKET;
  3936. std::unique_ptr<WebSocket> ws_;
  3937. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3938. time_t read_timeout_usec_ = 0;
  3939. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3940. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3941. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3942. time_t websocket_ping_interval_sec_ =
  3943. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3944. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3945. int address_family_ = AF_UNSPEC;
  3946. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3947. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3948. SocketOptions socket_options_ = nullptr;
  3949. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3950. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3951. std::string interface_;
  3952. // Hostname to connection target map. The value is an IP literal or another
  3953. // hostname; only the connection target changes, never the identity.
  3954. std::map<std::string, std::string> addr_map_;
  3955. std::string proxy_host_;
  3956. int proxy_port_ = -1;
  3957. std::string proxy_basic_auth_username_;
  3958. std::string proxy_basic_auth_password_;
  3959. std::string proxy_bearer_token_auth_token_;
  3960. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  3961. #ifdef CPPHTTPLIB_SSL_ENABLED
  3962. bool is_ssl_ = false;
  3963. tls::ctx_t tls_ctx_ = nullptr;
  3964. tls::session_t tls_session_ = nullptr;
  3965. std::string ca_cert_file_path_;
  3966. std::string ca_cert_dir_path_;
  3967. // Set by set_ca_cert_store() and load_ca_cert_store() even when they bring
  3968. // no certificate, so that a CA that failed to come through fails
  3969. // verification instead of letting the system CAs in.
  3970. bool custom_ca_loaded_ = false;
  3971. bool certs_loaded_ = false;
  3972. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3973. bool server_certificate_verification_ = true;
  3974. bool server_hostname_verification_ = true;
  3975. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3976. std::string proxy_digest_auth_username_;
  3977. std::string proxy_digest_auth_password_;
  3978. #endif
  3979. };
  3980. template <class Rep, class Period>
  3981. inline void WebSocket::set_read_timeout(
  3982. const std::chrono::duration<Rep, Period> &duration) {
  3983. detail::duration_to_sec_and_usec(
  3984. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3985. }
  3986. template <class Rep, class Period>
  3987. inline void WebSocketClient::set_read_timeout(
  3988. const std::chrono::duration<Rep, Period> &duration) {
  3989. detail::duration_to_sec_and_usec(
  3990. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3991. }
  3992. template <class Rep, class Period>
  3993. inline void WebSocketClient::set_write_timeout(
  3994. const std::chrono::duration<Rep, Period> &duration) {
  3995. detail::duration_to_sec_and_usec(
  3996. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3997. }
  3998. template <class Rep, class Period>
  3999. inline void WebSocketClient::set_connection_timeout(
  4000. const std::chrono::duration<Rep, Period> &duration) {
  4001. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  4002. set_connection_timeout(sec, usec);
  4003. });
  4004. }
  4005. namespace impl {
  4006. bool is_valid_utf8(const std::string &s);
  4007. // Three states, because a failure that consumed bytes and one that consumed
  4008. // none are not the same thing: the first has left the stream in the middle of
  4009. // a frame and the connection cannot be reused, the second can just be retried.
  4010. enum class FrameRead { Ok, Fail, Timeout };
  4011. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4012. std::string &payload, bool &fin,
  4013. bool expect_masked, size_t max_len);
  4014. } // namespace impl
  4015. } // namespace ws
  4016. // ----------------------------------------------------------------------------
  4017. /*
  4018. * Implementation that will be part of the .cc file if split into .h + .cc.
  4019. */
  4020. namespace stream {
  4021. // stream::Result implementations
  4022. inline Result::Result() : chunk_size_(8192) {}
  4023. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  4024. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  4025. inline Result::Result(Result &&other) noexcept
  4026. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  4027. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  4028. finished_(other.finished_) {
  4029. other.current_size_ = 0;
  4030. other.finished_ = true;
  4031. }
  4032. inline Result &Result::operator=(Result &&other) noexcept {
  4033. if (this != &other) {
  4034. handle_ = std::move(other.handle_);
  4035. buffer_ = std::move(other.buffer_);
  4036. current_size_ = other.current_size_;
  4037. chunk_size_ = other.chunk_size_;
  4038. finished_ = other.finished_;
  4039. other.current_size_ = 0;
  4040. other.finished_ = true;
  4041. }
  4042. return *this;
  4043. }
  4044. inline bool Result::is_valid() const { return handle_.is_valid(); }
  4045. inline Result::operator bool() const { return is_valid(); }
  4046. inline int Result::status() const {
  4047. return handle_.response ? handle_.response->status : -1;
  4048. }
  4049. inline const Headers &Result::headers() const {
  4050. static const Headers empty_headers;
  4051. return handle_.response ? handle_.response->headers : empty_headers;
  4052. }
  4053. inline std::string Result::get_header_value(const std::string &key,
  4054. const char *def) const {
  4055. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  4056. }
  4057. inline bool Result::has_header(const std::string &key) const {
  4058. return handle_.response ? handle_.response->has_header(key) : false;
  4059. }
  4060. inline Error Result::error() const { return handle_.error; }
  4061. inline Error Result::read_error() const { return handle_.get_read_error(); }
  4062. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  4063. inline bool Result::next() {
  4064. if (!handle_.is_valid() || finished_) { return false; }
  4065. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4066. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4067. if (n > 0) {
  4068. current_size_ = static_cast<size_t>(n);
  4069. return true;
  4070. }
  4071. current_size_ = 0;
  4072. finished_ = true;
  4073. return false;
  4074. }
  4075. inline const char *Result::data() const { return buffer_.data(); }
  4076. inline size_t Result::size() const { return current_size_; }
  4077. inline std::string Result::read_all() {
  4078. std::string result;
  4079. while (next()) {
  4080. result.append(data(), size());
  4081. }
  4082. return result;
  4083. }
  4084. } // namespace stream
  4085. namespace sse {
  4086. // SSEMessage implementations
  4087. inline SSEMessage::SSEMessage() : event("message") {}
  4088. inline void SSEMessage::clear() {
  4089. event = "message";
  4090. data.clear();
  4091. id.clear();
  4092. }
  4093. // SSEClient implementations
  4094. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4095. : client_(client), path_(path) {}
  4096. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4097. const Headers &headers)
  4098. : client_(client), path_(path), headers_(headers) {}
  4099. inline SSEClient::~SSEClient() { stop(); }
  4100. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4101. on_message_ = std::move(handler);
  4102. return *this;
  4103. }
  4104. inline SSEClient &SSEClient::on_event(const std::string &type,
  4105. MessageHandler handler) {
  4106. event_handlers_[type] = std::move(handler);
  4107. return *this;
  4108. }
  4109. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4110. on_open_ = std::move(handler);
  4111. return *this;
  4112. }
  4113. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4114. on_error_ = std::move(handler);
  4115. return *this;
  4116. }
  4117. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4118. reconnect_interval_ms_ = ms;
  4119. return *this;
  4120. }
  4121. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4122. max_reconnect_attempts_ = n;
  4123. return *this;
  4124. }
  4125. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4126. std::lock_guard<std::mutex> lock(headers_mutex_);
  4127. headers_ = headers;
  4128. return *this;
  4129. }
  4130. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4131. inline const std::string &SSEClient::last_event_id() const {
  4132. return last_event_id_;
  4133. }
  4134. inline void SSEClient::start() {
  4135. running_.store(true);
  4136. run_event_loop();
  4137. }
  4138. inline void SSEClient::start_async() {
  4139. running_.store(true);
  4140. async_thread_ = std::thread([this]() { run_event_loop(); });
  4141. }
  4142. inline void SSEClient::stop() {
  4143. running_.store(false);
  4144. client_.stop(); // Cancel any pending operations
  4145. if (async_thread_.joinable()) { async_thread_.join(); }
  4146. }
  4147. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4148. int &retry_ms, bool &has_data,
  4149. bool &has_id) {
  4150. // Blank line signals end of event
  4151. if (line.empty()) { return true; }
  4152. // Lines starting with ':' are comments (ignored)
  4153. if (line[0] == ':') { return false; }
  4154. // Find the colon separator
  4155. auto colon_pos = line.find(':');
  4156. auto field = line.substr(0, colon_pos);
  4157. std::string value;
  4158. // Value starts after colon, skip optional single space
  4159. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4160. auto value_start = colon_pos + 1;
  4161. if (line[value_start] == ' ') { value_start++; }
  4162. value = line.substr(value_start);
  4163. }
  4164. // Handle known fields
  4165. if (field == "event") {
  4166. // An empty event type is dispatched as "message" per the SSE spec
  4167. msg.event = value.empty() ? std::string("message") : std::move(value);
  4168. } else if (field == "data") {
  4169. // Multiple data lines are concatenated with newlines
  4170. if (has_data) { msg.data += "\n"; }
  4171. msg.data += value;
  4172. has_data = true;
  4173. } else if (field == "id") {
  4174. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4175. // valid (clears the last event ID)
  4176. if (detail::fields::is_field_value(value)) {
  4177. msg.id = value;
  4178. has_id = true;
  4179. }
  4180. } else if (field == "retry") {
  4181. // Parse retry interval in milliseconds
  4182. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4183. if (detail::is_numeric(value)) {
  4184. int v = 0;
  4185. auto res =
  4186. detail::from_chars(value.data(), value.data() + value.size(), v);
  4187. if (res.ec == std::errc{}) { retry_ms = v; }
  4188. }
  4189. }
  4190. // Unknown fields are ignored per SSE spec
  4191. return false;
  4192. }
  4193. inline void SSEClient::run_event_loop() {
  4194. auto reconnect_count = 0;
  4195. while (running_.load()) {
  4196. // Build headers, including Last-Event-ID if we have one
  4197. Headers request_headers;
  4198. {
  4199. std::lock_guard<std::mutex> lock(headers_mutex_);
  4200. request_headers = headers_;
  4201. }
  4202. if (!last_event_id_.empty()) {
  4203. request_headers.emplace("Last-Event-ID", last_event_id_);
  4204. }
  4205. // Open streaming connection. An event stream has no end, so each event is
  4206. // bounded instead of the whole body.
  4207. auto handle = client_.open_stream("GET", path_, {}, request_headers);
  4208. handle.body_reader_.payload_max_length = 0;
  4209. // stop() ends a read that is waiting for the next event
  4210. if (handle.stream_) {
  4211. handle.stream_->set_read_interrupt([this] { return !running_.load(); });
  4212. }
  4213. stream::Result result{std::move(handle)};
  4214. // Connection error handling
  4215. if (!result) {
  4216. connected_.store(false);
  4217. if (on_error_) { on_error_(result.error()); }
  4218. if (!should_reconnect(reconnect_count)) { break; }
  4219. wait_for_reconnect();
  4220. reconnect_count++;
  4221. continue;
  4222. }
  4223. if (result.status() != StatusCode::OK_200) {
  4224. connected_.store(false);
  4225. if (on_error_) { on_error_(Error::Connection); }
  4226. // For certain errors, don't reconnect.
  4227. // Note: 401 is intentionally absent so that handlers can refresh
  4228. // credentials via set_headers() and let the client reconnect.
  4229. if (result.status() == StatusCode::NoContent_204 ||
  4230. result.status() == StatusCode::NotFound_404 ||
  4231. result.status() == StatusCode::Forbidden_403) {
  4232. break;
  4233. }
  4234. if (!should_reconnect(reconnect_count)) { break; }
  4235. wait_for_reconnect();
  4236. reconnect_count++;
  4237. continue;
  4238. }
  4239. // Connection successful
  4240. connected_.store(true);
  4241. reconnect_count = 0;
  4242. if (on_open_) { on_open_(); }
  4243. // Event receiving loop
  4244. std::string buffer;
  4245. SSEMessage current_msg;
  4246. auto has_data = false;
  4247. auto has_id = false;
  4248. auto first_line = true;
  4249. auto after_cr = false;
  4250. auto event_too_long = false;
  4251. while (running_.load() && result.next()) {
  4252. // What is left in the buffer has no line ending
  4253. auto search_pos = buffer.size();
  4254. buffer.append(result.data(), result.size());
  4255. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4256. // per the SSE spec
  4257. size_t line_start = 0;
  4258. size_t eol_pos;
  4259. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4260. std::string::npos) {
  4261. auto line = buffer.substr(line_start, eol_pos - line_start);
  4262. line_start = eol_pos + 1;
  4263. search_pos = line_start;
  4264. // The \n of a \r\n may arrive in a later chunk than its \r
  4265. auto is_lf_of_crlf =
  4266. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4267. after_cr = buffer[eol_pos] == '\r';
  4268. if (is_lf_of_crlf) { continue; }
  4269. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4270. if (first_line) {
  4271. first_line = false;
  4272. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4273. }
  4274. // Parse the line and check if event is complete
  4275. auto event_complete = parse_sse_line(
  4276. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4277. if (event_complete) {
  4278. // Update last_event_id for reconnection, even for an event that
  4279. // has no data. An empty id clears it.
  4280. if (has_id) { last_event_id_ = current_msg.id; }
  4281. // An event without a data field is not dispatched
  4282. if (has_data) { dispatch_event(current_msg); }
  4283. // Reset the message for the next event either way
  4284. current_msg.clear();
  4285. has_data = false;
  4286. has_id = false;
  4287. }
  4288. }
  4289. // Keep unprocessed data in buffer
  4290. buffer.erase(0, line_start);
  4291. // Neither an event nor a line still waiting for its end may grow
  4292. // without bound. 0 means no limit.
  4293. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4294. buffer.size() + current_msg.data.size() >
  4295. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4296. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4297. event_too_long = true;
  4298. break;
  4299. }
  4300. }
  4301. // Connection ended
  4302. connected_.store(false);
  4303. // Reconnecting would only get the same event again
  4304. if (!running_.load() || event_too_long) { break; }
  4305. // Check for read errors
  4306. if (result.has_read_error()) {
  4307. if (on_error_) { on_error_(result.read_error()); }
  4308. }
  4309. if (!should_reconnect(reconnect_count)) { break; }
  4310. wait_for_reconnect();
  4311. reconnect_count++;
  4312. }
  4313. connected_.store(false);
  4314. }
  4315. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4316. // Check for specific event type handler first
  4317. auto it = event_handlers_.find(msg.event);
  4318. if (it != event_handlers_.end()) {
  4319. it->second(msg);
  4320. return;
  4321. }
  4322. // Fall back to generic message handler
  4323. if (on_message_) { on_message_(msg); }
  4324. }
  4325. inline bool SSEClient::should_reconnect(int count) const {
  4326. if (!running_.load()) { return false; }
  4327. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4328. return count < max_reconnect_attempts_;
  4329. }
  4330. inline void SSEClient::wait_for_reconnect() {
  4331. // Use small increments to check running_ flag frequently.
  4332. // Always wait at least one increment, so that a zero interval (e.g.
  4333. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4334. const auto step_ms = 100;
  4335. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4336. auto waited = 0;
  4337. while (running_.load() && waited < interval_ms) {
  4338. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4339. waited += step_ms;
  4340. }
  4341. }
  4342. } // namespace sse
  4343. #ifdef CPPHTTPLIB_SSL_ENABLED
  4344. /*
  4345. * TLS abstraction layer - internal function declarations
  4346. * These are implementation details and not part of the public API.
  4347. */
  4348. namespace tls {
  4349. // Client context
  4350. ctx_t create_client_context();
  4351. void free_context(ctx_t ctx);
  4352. bool set_min_version(ctx_t ctx, Version version);
  4353. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4354. bool load_ca_file(ctx_t ctx, const char *file_path);
  4355. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4356. bool load_system_certs(ctx_t ctx);
  4357. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4358. const char *password);
  4359. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4360. const char *key_path, const char *password);
  4361. // Server context
  4362. ctx_t create_server_context();
  4363. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4364. const char *password);
  4365. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4366. const char *key_path, const char *password);
  4367. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4368. void set_verify_client(ctx_t ctx, bool require);
  4369. // Session management
  4370. session_t create_session(ctx_t ctx, socket_t sock);
  4371. void free_session(session_t session);
  4372. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4373. // Handshake (non-blocking capable)
  4374. TlsError connect(session_t session);
  4375. TlsError accept(session_t session);
  4376. // Handshake with timeout (blocking until timeout)
  4377. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4378. time_t timeout_usec, TlsError *err);
  4379. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4380. time_t timeout_usec, TlsError *err);
  4381. // I/O (non-blocking capable)
  4382. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4383. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4384. int pending(const_session_t session);
  4385. void shutdown(session_t session, bool graceful);
  4386. // Connection state
  4387. bool is_peer_closed(session_t session, socket_t sock);
  4388. // Certificate verification
  4389. cert_t get_peer_cert(const_session_t session);
  4390. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4391. // do not use them after free_session(), as with get_peer_cert().
  4392. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4393. void free_cert(cert_t cert);
  4394. bool verify_hostname(cert_t cert, const char *hostname);
  4395. uint64_t hostname_mismatch_code();
  4396. long get_verify_result(const_session_t session);
  4397. // Certificate introspection
  4398. std::string get_cert_subject_cn(cert_t cert);
  4399. std::string get_cert_issuer_name(cert_t cert);
  4400. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4401. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4402. std::string get_cert_serial(cert_t cert);
  4403. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4404. const char *get_sni(const_session_t session);
  4405. // CA store management
  4406. ca_store_t create_ca_store(const char *pem, size_t len);
  4407. void free_ca_store(ca_store_t store);
  4408. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4409. // Free each with free_cert(), and do not use them once the context's CA
  4410. // certificates change.
  4411. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4412. std::vector<std::string> get_ca_names(ctx_t ctx);
  4413. // Dynamic certificate update (for servers)
  4414. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4415. const char *password);
  4416. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4417. // Certificate verification callback
  4418. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4419. long get_verify_error(const_session_t session);
  4420. std::string verify_error_string(long error_code);
  4421. // TlsError information
  4422. uint64_t peek_error();
  4423. uint64_t get_error();
  4424. std::string error_string(uint64_t code);
  4425. } // namespace tls
  4426. #endif // CPPHTTPLIB_SSL_ENABLED
  4427. /*
  4428. * Group 1: detail namespace - Non-SSL utilities
  4429. */
  4430. namespace detail {
  4431. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4432. const void *optval, socklen_t optlen) {
  4433. return setsockopt(sock, level, optname,
  4434. #ifdef _WIN32
  4435. reinterpret_cast<const char *>(optval),
  4436. #else
  4437. optval,
  4438. #endif
  4439. optlen) == 0;
  4440. }
  4441. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4442. time_t sec, time_t usec) {
  4443. #ifdef _WIN32
  4444. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4445. #else
  4446. timeval timeout;
  4447. timeout.tv_sec = static_cast<long>(sec);
  4448. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4449. #endif
  4450. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4451. }
  4452. inline bool is_hex(char c, int &v) {
  4453. if (is_ascii_digit(c)) {
  4454. v = c - '0';
  4455. return true;
  4456. } else if ('A' <= c && c <= 'F') {
  4457. v = c - 'A' + 10;
  4458. return true;
  4459. } else if ('a' <= c && c <= 'f') {
  4460. v = c - 'a' + 10;
  4461. return true;
  4462. }
  4463. return false;
  4464. }
  4465. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4466. int &val) {
  4467. if (i >= s.size()) { return false; }
  4468. val = 0;
  4469. for (; cnt; i++, cnt--) {
  4470. if (!s[i]) { return false; }
  4471. auto v = 0;
  4472. if (is_hex(s[i], v)) {
  4473. val = val * 16 + v;
  4474. } else {
  4475. return false;
  4476. }
  4477. }
  4478. return true;
  4479. }
  4480. inline std::string from_i_to_hex(size_t n) {
  4481. static const auto charset = "0123456789abcdef";
  4482. std::string ret;
  4483. do {
  4484. ret = charset[n & 15] + ret;
  4485. n >>= 4;
  4486. } while (n > 0);
  4487. return ret;
  4488. }
  4489. // A round trip rather than `n <= SIZE_MAX`, which is always true on 64-bit
  4490. // builds and trips -Wtautological-type-limit-compare.
  4491. inline bool fits_in_size_t(uint64_t n) {
  4492. return static_cast<uint64_t>(static_cast<size_t>(n)) == n;
  4493. }
  4494. inline std::string compute_etag(const FileStat &fs,
  4495. const std::string &suffix = std::string()) {
  4496. if (!fs.is_file()) { return std::string(); }
  4497. // If mtime cannot be determined (negative value indicates an error
  4498. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4499. // value like 0 could collide with a real file that legitimately has
  4500. // mtime == 0 (epoch) and lead to misleading validators.
  4501. auto mtime_raw = fs.mtime();
  4502. if (mtime_raw < 0) { return std::string(); }
  4503. auto mtime = static_cast<size_t>(mtime_raw);
  4504. auto size = fs.size();
  4505. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4506. from_i_to_hex(size) + suffix + "\"";
  4507. }
  4508. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4509. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4510. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4511. inline std::string file_mtime_to_http_date(time_t mtime) {
  4512. if (mtime < 0) { return std::string(); }
  4513. struct tm tm_buf;
  4514. #ifdef _WIN32
  4515. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4516. #else
  4517. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4518. #endif
  4519. char buf[64];
  4520. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4521. return std::string();
  4522. }
  4523. return std::string(buf);
  4524. }
  4525. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4526. inline time_t parse_http_date(const std::string &date_str) {
  4527. struct tm tm_buf;
  4528. // Create a classic locale object once for all parsing attempts
  4529. const std::locale classic_locale = std::locale::classic();
  4530. // Try to parse using std::get_time (C++11, cross-platform)
  4531. auto try_parse = [&](const char *fmt) -> bool {
  4532. std::istringstream ss(date_str);
  4533. ss.imbue(classic_locale);
  4534. memset(&tm_buf, 0, sizeof(tm_buf));
  4535. ss >> std::get_time(&tm_buf, fmt);
  4536. return !ss.fail();
  4537. };
  4538. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4539. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4540. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4541. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4542. // asctime format: "Sun Nov 6 08:49:37 1994"
  4543. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4544. return static_cast<time_t>(-1);
  4545. }
  4546. }
  4547. }
  4548. #ifdef _WIN32
  4549. return _mkgmtime(&tm_buf);
  4550. #elif defined _AIX
  4551. return mktime(&tm_buf);
  4552. #else
  4553. return timegm(&tm_buf);
  4554. #endif
  4555. }
  4556. inline bool is_weak_etag(const std::string &s) {
  4557. // Check if the string is a weak ETag (starts with 'W/"')
  4558. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4559. }
  4560. inline bool is_strong_etag(const std::string &s) {
  4561. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4562. // chars)
  4563. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4564. }
  4565. inline size_t to_utf8(int code, char *buff) {
  4566. if (code < 0x0080) {
  4567. buff[0] = static_cast<char>(code & 0x7F);
  4568. return 1;
  4569. } else if (code < 0x0800) {
  4570. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4571. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4572. return 2;
  4573. } else if (code < 0xD800) {
  4574. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4575. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4576. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4577. return 3;
  4578. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4579. return 0;
  4580. } else if (code < 0x10000) {
  4581. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4582. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4583. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4584. return 3;
  4585. } else if (code < 0x110000) {
  4586. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4587. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4588. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4589. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4590. return 4;
  4591. }
  4592. // NOTREACHED
  4593. return 0;
  4594. }
  4595. } // namespace detail
  4596. namespace ws {
  4597. namespace impl {
  4598. inline bool is_valid_utf8(const std::string &s) {
  4599. size_t i = 0;
  4600. auto n = s.size();
  4601. while (i < n) {
  4602. auto c = static_cast<unsigned char>(s[i]);
  4603. size_t len;
  4604. uint32_t cp;
  4605. if (c < 0x80) {
  4606. i++;
  4607. continue;
  4608. } else if ((c & 0xE0) == 0xC0) {
  4609. len = 2;
  4610. cp = c & 0x1F;
  4611. } else if ((c & 0xF0) == 0xE0) {
  4612. len = 3;
  4613. cp = c & 0x0F;
  4614. } else if ((c & 0xF8) == 0xF0) {
  4615. len = 4;
  4616. cp = c & 0x07;
  4617. } else {
  4618. return false;
  4619. }
  4620. if (i + len > n) { return false; }
  4621. for (size_t j = 1; j < len; j++) {
  4622. auto b = static_cast<unsigned char>(s[i + j]);
  4623. if ((b & 0xC0) != 0x80) { return false; }
  4624. cp = (cp << 6) | (b & 0x3F);
  4625. }
  4626. // Overlong encoding check
  4627. if (len == 2 && cp < 0x80) { return false; }
  4628. if (len == 3 && cp < 0x800) { return false; }
  4629. if (len == 4 && cp < 0x10000) { return false; }
  4630. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4631. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4632. if (cp > 0x10FFFF) { return false; }
  4633. i += len;
  4634. }
  4635. return true;
  4636. }
  4637. } // namespace impl
  4638. } // namespace ws
  4639. namespace detail {
  4640. // NOTE: This code came up with the following stackoverflow post:
  4641. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4642. inline std::string base64_encode(const std::string &in) {
  4643. static const auto lookup =
  4644. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4645. std::string out;
  4646. out.reserve(in.size());
  4647. // Unsigned: the accumulator is never masked, so with a signed int the
  4648. // `val << 8` below overflows once enough bytes are folded in (undefined
  4649. // behaviour before C++20). Only the low bits are ever emitted, so the
  4650. // wrap-around of an unsigned accumulator does not affect the output.
  4651. uint32_t val = 0;
  4652. auto valb = -6;
  4653. for (auto c : in) {
  4654. val = (val << 8) + static_cast<uint8_t>(c);
  4655. valb += 8;
  4656. while (valb >= 0) {
  4657. out.push_back(lookup[(val >> valb) & 0x3F]);
  4658. valb -= 6;
  4659. }
  4660. }
  4661. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4662. while (out.size() % 4) {
  4663. out.push_back('=');
  4664. }
  4665. return out;
  4666. }
  4667. inline std::string sha1(const std::string &input) {
  4668. // RFC 3174 SHA-1 implementation
  4669. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4670. return (x << n) | (x >> (32 - n));
  4671. };
  4672. uint32_t h0 = 0x67452301;
  4673. uint32_t h1 = 0xEFCDAB89;
  4674. uint32_t h2 = 0x98BADCFE;
  4675. uint32_t h3 = 0x10325476;
  4676. uint32_t h4 = 0xC3D2E1F0;
  4677. // Pre-processing: adding padding bits
  4678. std::string msg = input;
  4679. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4680. msg.push_back(static_cast<char>(0x80u));
  4681. while (msg.size() % 64 != 56) {
  4682. msg.push_back(0);
  4683. }
  4684. // Append original length in bits as 64-bit big-endian
  4685. for (int i = 56; i >= 0; i -= 8) {
  4686. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4687. }
  4688. // Process each 512-bit chunk
  4689. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4690. uint32_t w[80];
  4691. for (size_t i = 0; i < 16; i++) {
  4692. w[i] =
  4693. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4694. << 24) |
  4695. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4696. << 16) |
  4697. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4698. << 8) |
  4699. (static_cast<uint32_t>(
  4700. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4701. }
  4702. for (int i = 16; i < 80; i++) {
  4703. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4704. }
  4705. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4706. for (int i = 0; i < 80; i++) {
  4707. uint32_t f, k;
  4708. if (i < 20) {
  4709. f = (b & c) | ((~b) & d);
  4710. k = 0x5A827999;
  4711. } else if (i < 40) {
  4712. f = b ^ c ^ d;
  4713. k = 0x6ED9EBA1;
  4714. } else if (i < 60) {
  4715. f = (b & c) | (b & d) | (c & d);
  4716. k = 0x8F1BBCDC;
  4717. } else {
  4718. f = b ^ c ^ d;
  4719. k = 0xCA62C1D6;
  4720. }
  4721. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4722. e = d;
  4723. d = c;
  4724. c = left_rotate(b, 30);
  4725. b = a;
  4726. a = temp;
  4727. }
  4728. h0 += a;
  4729. h1 += b;
  4730. h2 += c;
  4731. h3 += d;
  4732. h4 += e;
  4733. }
  4734. // Produce the final hash as a 20-byte binary string
  4735. std::string hash(20, '\0');
  4736. for (size_t i = 0; i < 4; i++) {
  4737. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4738. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4739. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4740. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4741. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4742. }
  4743. return hash;
  4744. }
  4745. inline std::string websocket_accept_key(const std::string &client_key) {
  4746. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4747. return base64_encode(sha1(client_key + magic));
  4748. }
  4749. inline bool is_websocket_upgrade(const Request &req) {
  4750. if (req.method != "GET") { return false; }
  4751. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4752. // list of protocols and asks recipients to match each name
  4753. // case-insensitively, so look for the token rather than compare the whole
  4754. // field value.
  4755. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4756. // Check Connection: Upgrade
  4757. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4758. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4759. // RFC 6455 Section 4.2.1
  4760. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4761. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4762. return false;
  4763. }
  4764. static const std::string b64chars =
  4765. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4766. for (size_t i = 0; i < 22; i++) {
  4767. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4768. }
  4769. // Check Sec-WebSocket-Version: 13
  4770. auto version = req.get_header_value("Sec-WebSocket-Version");
  4771. if (version != "13") { return false; }
  4772. return true;
  4773. }
  4774. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4775. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4776. thread_local std::random_device rd;
  4777. size_t filled = 0;
  4778. while (filled < n) {
  4779. auto v = rd();
  4780. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4781. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4782. }
  4783. }
  4784. }
  4785. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4786. const char *data, size_t len, bool fin,
  4787. bool mask) {
  4788. // First byte: FIN + opcode
  4789. uint8_t header[2];
  4790. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4791. (static_cast<uint8_t>(opcode) & 0x0F));
  4792. // Second byte: MASK + payload length
  4793. if (len < 126) {
  4794. header[1] = static_cast<uint8_t>(len);
  4795. if (mask) { header[1] |= 0x80; }
  4796. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4797. } else if (len <= 0xFFFF) {
  4798. header[1] = 126;
  4799. if (mask) { header[1] |= 0x80; }
  4800. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4801. uint8_t ext[2];
  4802. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4803. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4804. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4805. } else {
  4806. header[1] = 127;
  4807. if (mask) { header[1] |= 0x80; }
  4808. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4809. uint8_t ext[8];
  4810. for (int i = 7; i >= 0; i--) {
  4811. ext[7 - i] =
  4812. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4813. }
  4814. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4815. }
  4816. if (mask) {
  4817. // Generate random mask key
  4818. uint8_t mask_key[4];
  4819. fill_random_bytes(mask_key, sizeof(mask_key));
  4820. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4821. // Write masked payload in chunks
  4822. const size_t chunk_size = 4096;
  4823. std::vector<char> buf((std::min)(len, chunk_size));
  4824. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4825. size_t n = (std::min)(chunk_size, len - offset);
  4826. for (size_t i = 0; i < n; i++) {
  4827. buf[i] =
  4828. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4829. }
  4830. if (strm.write(buf.data(), n) < 0) { return false; }
  4831. }
  4832. } else {
  4833. if (len > 0) {
  4834. if (strm.write(data, len) < 0) { return false; }
  4835. }
  4836. }
  4837. return true;
  4838. }
  4839. } // namespace detail
  4840. namespace ws {
  4841. namespace impl {
  4842. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4843. // hands back whatever its buffer already holds -- so every multi-byte field has
  4844. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4845. // header straddles the read buffer's boundary.
  4846. //
  4847. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4848. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4849. // there is a failure like any other. (When read() fails it always records why,
  4850. // so the error belongs to this call and not to an earlier one.)
  4851. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4852. auto p = static_cast<char *>(buf);
  4853. size_t total = 0;
  4854. while (total < size) {
  4855. auto n = strm.read(p + total, size - total);
  4856. if (n <= 0) {
  4857. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4858. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4859. }
  4860. total += static_cast<size_t>(n);
  4861. }
  4862. return FrameRead::Ok;
  4863. }
  4864. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4865. std::string &payload, bool &fin,
  4866. bool expect_masked, size_t max_len) {
  4867. // Read first 2 bytes. This is the only read that may report a timeout: it
  4868. // sits on a frame boundary, where nothing has been consumed yet.
  4869. uint8_t header[2];
  4870. FrameRead first = read_exact(strm, header, 2);
  4871. if (first != FrameRead::Ok) { return first; }
  4872. fin = (header[0] & 0x80) != 0;
  4873. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4874. if (header[0] & 0x70) { return FrameRead::Fail; }
  4875. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4876. bool masked = (header[1] & 0x80) != 0;
  4877. uint64_t payload_len = header[1] & 0x7F;
  4878. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4879. // MUST have a payload length of 125 bytes or less
  4880. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4881. if (is_control) {
  4882. if (!fin) { return FrameRead::Fail; }
  4883. if (payload_len > 125) { return FrameRead::Fail; }
  4884. }
  4885. if (masked != expect_masked) { return FrameRead::Fail; }
  4886. // Extended payload length
  4887. if (payload_len == 126) {
  4888. uint8_t ext[2];
  4889. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4890. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4891. } else if (payload_len == 127) {
  4892. uint8_t ext[8];
  4893. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4894. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4895. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4896. payload_len = 0;
  4897. for (int i = 0; i < 8; i++) {
  4898. payload_len = (payload_len << 8) | ext[i];
  4899. }
  4900. }
  4901. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4902. // size_t cannot hold (32-bit builds) is refused either way.
  4903. if ((max_len > 0 && payload_len > max_len) ||
  4904. !detail::fits_in_size_t(payload_len)) {
  4905. return FrameRead::Fail;
  4906. }
  4907. // Read mask key if present
  4908. uint8_t mask_key[4] = {0};
  4909. if (masked) {
  4910. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4911. return FrameRead::Fail;
  4912. }
  4913. }
  4914. // Grow the payload only as it arrives, since a header alone can announce
  4915. // max_len bytes that never come.
  4916. payload.clear();
  4917. auto len = static_cast<size_t>(payload_len);
  4918. while (payload.size() < len) {
  4919. auto offset = payload.size();
  4920. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4921. payload.resize(offset + n);
  4922. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4923. return FrameRead::Fail;
  4924. }
  4925. }
  4926. // Unmask if needed
  4927. if (masked) {
  4928. for (size_t i = 0; i < payload.size(); i++) {
  4929. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4930. }
  4931. }
  4932. return FrameRead::Ok;
  4933. }
  4934. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4935. // be sent followed by a UTF-8 reason.
  4936. inline bool is_valid_close_payload(const std::string &payload) {
  4937. if (payload.empty()) { return true; }
  4938. if (payload.size() < 2) { return false; }
  4939. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4940. static_cast<uint8_t>(payload[1]);
  4941. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4942. (1007 <= code && code <= 1014) ||
  4943. (3000 <= code && code <= 4999);
  4944. return may_be_sent && is_valid_utf8(payload.substr(2));
  4945. }
  4946. } // namespace impl
  4947. } // namespace ws
  4948. namespace detail {
  4949. // A path a mount point serves: absolute, with no ".", ".." or empty segment
  4950. // except a trailing '/', so the file served is the one that req.path names to
  4951. // the handlers that ran before it.
  4952. inline bool is_valid_path(const std::string &path) {
  4953. if (path.empty() || path[0] != '/') { return false; }
  4954. auto beg = size_t{1};
  4955. for (auto i = beg; i <= path.size(); i++) {
  4956. if (i < path.size() && path[i] != '/') {
  4957. if (path[i] == '\0' || path[i] == '\\') { return false; }
  4958. continue;
  4959. }
  4960. auto len = i - beg;
  4961. if ((len == 0 && i < path.size()) || (len == 1 && path[beg] == '.') ||
  4962. (len == 2 && path[beg] == '.' && path[beg + 1] == '.')) {
  4963. return false;
  4964. }
  4965. beg = i + 1;
  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. // Drops the fields set_header() would refuse, from headers an application can
  7044. // fill directly: CR/LF in one would split the message.
  7045. inline void erase_invalid_fields(Headers &headers) {
  7046. for (auto it = headers.begin(); it != headers.end();) {
  7047. if (fields::is_field_valid(it->first, it->second)) {
  7048. ++it;
  7049. } else {
  7050. it = headers.erase(it);
  7051. }
  7052. }
  7053. }
  7054. inline bool read_headers(Stream &strm, Headers &headers) {
  7055. const auto bufsiz = 2048;
  7056. char buf[bufsiz];
  7057. stream_line_reader line_reader(strm, buf, bufsiz);
  7058. size_t header_count = 0;
  7059. for (;;) {
  7060. if (!line_reader.getline()) { return false; }
  7061. // Check if the line ends with CRLF.
  7062. auto line_terminator_len = 2;
  7063. if (line_reader.end_with_crlf()) {
  7064. // Blank line indicates end of headers.
  7065. if (line_reader.size() == 2) { break; }
  7066. } else {
  7067. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7068. // Blank line indicates end of headers.
  7069. if (line_reader.size() == 1) { break; }
  7070. line_terminator_len = 1;
  7071. #else
  7072. continue; // Skip invalid line.
  7073. #endif
  7074. }
  7075. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7076. // Check header count limit
  7077. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  7078. // Exclude line terminator
  7079. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  7080. if (!parse_header(line_reader.ptr(), end,
  7081. [&](const std::string &key, const std::string &val) {
  7082. headers.emplace(key, val);
  7083. })) {
  7084. return false;
  7085. }
  7086. header_count++;
  7087. }
  7088. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7089. // headers that have different values to prevent request smuggling.
  7090. auto cl_range = headers.equal_range("Content-Length");
  7091. if (cl_range.first != cl_range.second) {
  7092. const auto &first_val = cl_range.first->second;
  7093. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7094. if (it->second != first_val) { return false; }
  7095. }
  7096. }
  7097. return true;
  7098. }
  7099. // Parsed by hand: std::regex_match recurses once per character of the reason
  7100. // phrase, which a server can make as long as a whole line.
  7101. inline bool parse_status_line(const char *line, std::string &version,
  7102. int &status, std::string &reason) {
  7103. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7104. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7105. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7106. !is_ascii_digit(line[11])) {
  7107. return false;
  7108. }
  7109. auto p = line + 12;
  7110. auto reason_begin = p;
  7111. if (*p == ' ') {
  7112. reason_begin = ++p;
  7113. p += std::strcspn(p, "\r\n");
  7114. }
  7115. auto reason_end = p;
  7116. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7117. if (*p == '\r') { p++; }
  7118. #else
  7119. if (*p++ != '\r') { return false; }
  7120. #endif
  7121. if (*p++ != '\n' || *p != '\0') { return false; }
  7122. version.assign(line, 8);
  7123. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7124. reason.assign(reason_begin, reason_end);
  7125. return true;
  7126. }
  7127. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7128. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7129. struct WebSocketUpgradeResponse {
  7130. Error error = Error::Success;
  7131. int status = -1;
  7132. Headers headers;
  7133. std::string selected_subprotocol;
  7134. };
  7135. // Reads a response's status line and headers, leaving any body unread. An
  7136. // unparsable status line is no stream error; it just leaves `status` as is.
  7137. inline bool read_response_head(Stream &strm, int &status, Headers &headers) {
  7138. const auto bufsiz = 2048;
  7139. char buf[bufsiz];
  7140. stream_line_reader line_reader(strm, buf, bufsiz);
  7141. if (!line_reader.getline()) { return false; }
  7142. std::string version;
  7143. std::string reason;
  7144. if (!parse_status_line(line_reader.ptr(), version, status, reason)) {
  7145. return true;
  7146. }
  7147. return read_headers(strm, headers);
  7148. }
  7149. inline bool
  7150. read_websocket_upgrade_response(Stream &strm,
  7151. const std::string &expected_accept,
  7152. const std::string &offered_subprotocols,
  7153. WebSocketUpgradeResponse &upgrade) {
  7154. // The headers of a rejection are kept so the caller can see why the server
  7155. // refused the upgrade.
  7156. if (!read_response_head(strm, upgrade.status, upgrade.headers)) {
  7157. upgrade.error = Error::Read;
  7158. return false;
  7159. }
  7160. const auto &headers = upgrade.headers;
  7161. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7162. upgrade.error = Error::WebSocketHandshake;
  7163. return false;
  7164. }
  7165. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7166. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7167. upgrade.error = Error::WebSocketHandshake;
  7168. return false;
  7169. }
  7170. // Verify Connection: Upgrade
  7171. if (!has_header_token(headers, "Connection", "upgrade")) {
  7172. upgrade.error = Error::WebSocketHandshake;
  7173. return false;
  7174. }
  7175. // Verify Sec-WebSocket-Accept header value
  7176. auto it = headers.find("Sec-WebSocket-Accept");
  7177. if (it == headers.end() || it->second != expected_accept) {
  7178. upgrade.error = Error::WebSocketHandshake;
  7179. return false;
  7180. }
  7181. // Extract negotiated subprotocol
  7182. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7183. if (proto_it != headers.end()) {
  7184. upgrade.selected_subprotocol = proto_it->second;
  7185. }
  7186. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7187. if (!upgrade.selected_subprotocol.empty()) {
  7188. auto was_offered = false;
  7189. split(offered_subprotocols.data(),
  7190. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7191. [&](const char *b, const char *e) {
  7192. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7193. was_offered = true;
  7194. }
  7195. });
  7196. if (!was_offered) {
  7197. upgrade.error = Error::WebSocketHandshake;
  7198. return false;
  7199. }
  7200. }
  7201. return true;
  7202. }
  7203. enum class ReadContentResult {
  7204. Success, // Successfully read the content
  7205. PayloadTooLarge, // The content exceeds the specified payload limit
  7206. Error // An error occurred while reading the content
  7207. };
  7208. inline ReadContentResult read_content_with_length(
  7209. Stream &strm, size_t len, DownloadProgress progress,
  7210. ContentReceiverWithProgress out,
  7211. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7212. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7213. detail::BodyReader br;
  7214. br.stream = &strm;
  7215. br.has_content_length = true;
  7216. br.content_length = len;
  7217. br.payload_max_length = payload_max_length;
  7218. br.chunked = false;
  7219. br.bytes_read = 0;
  7220. br.last_error = Error::Success;
  7221. size_t r = 0;
  7222. while (r < len) {
  7223. auto read_len = static_cast<size_t>(len - r);
  7224. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7225. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7226. if (n <= 0) {
  7227. // Check if it was a payload size error
  7228. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7229. return ReadContentResult::PayloadTooLarge;
  7230. }
  7231. return ReadContentResult::Error;
  7232. }
  7233. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7234. return ReadContentResult::Error;
  7235. }
  7236. r += static_cast<size_t>(n);
  7237. if (progress) {
  7238. if (!progress(r, len)) { return ReadContentResult::Error; }
  7239. }
  7240. }
  7241. return ReadContentResult::Success;
  7242. }
  7243. inline ReadContentResult
  7244. read_content_without_length(Stream &strm, size_t payload_max_length,
  7245. ContentReceiverWithProgress out) {
  7246. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7247. size_t r = 0;
  7248. for (;;) {
  7249. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7250. if (n == 0) { return ReadContentResult::Success; }
  7251. if (n < 0) { return ReadContentResult::Error; }
  7252. // Check if adding this data would exceed the payload limit
  7253. if (payload_max_length > 0 &&
  7254. (r > payload_max_length ||
  7255. payload_max_length - r < static_cast<size_t>(n))) {
  7256. return ReadContentResult::PayloadTooLarge;
  7257. }
  7258. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7259. return ReadContentResult::Error;
  7260. }
  7261. r += static_cast<size_t>(n);
  7262. }
  7263. return ReadContentResult::Success;
  7264. }
  7265. template <typename T>
  7266. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7267. size_t payload_max_length,
  7268. ContentReceiverWithProgress out) {
  7269. detail::ChunkedDecoder dec(strm);
  7270. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7271. size_t total_len = 0;
  7272. for (;;) {
  7273. size_t chunk_offset = 0;
  7274. size_t chunk_total = 0;
  7275. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7276. if (n < 0) { return ReadContentResult::Error; }
  7277. if (n == 0) {
  7278. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7279. return ReadContentResult::Error;
  7280. }
  7281. return ReadContentResult::Success;
  7282. }
  7283. if (payload_max_length > 0 &&
  7284. (total_len > payload_max_length ||
  7285. payload_max_length - total_len < static_cast<size_t>(n))) {
  7286. return ReadContentResult::PayloadTooLarge;
  7287. }
  7288. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7289. return ReadContentResult::Error;
  7290. }
  7291. total_len += static_cast<size_t>(n);
  7292. }
  7293. }
  7294. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7295. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7296. // is the final transfer coding. A single field value may list several
  7297. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7298. // several Transfer-Encoding lines, which combine into one comma-separated
  7299. // list in the order the lines were received. Headers preserves that order,
  7300. // so the final coding is the last token of the last line. Match it
  7301. // case-insensitively rather than comparing the whole value against
  7302. // "chunked".
  7303. //
  7304. // Security: reading a chunked message as unframed leaves its body in the
  7305. // socket, where a keep-alive connection parses it as a smuggled request.
  7306. // Server::process_request() answers 400 and closes when the final coding is
  7307. // not chunked, so a request whose framing cannot be determined never
  7308. // reaches the "no body" path.
  7309. auto rng = headers.equal_range("Transfer-Encoding");
  7310. if (rng.first == rng.second) { return false; }
  7311. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7312. // combined list ending in nothing rather than inheriting the line before it.
  7313. std::string last_coding;
  7314. for (auto it = rng.first; it != rng.second; ++it) {
  7315. const auto &value = it->second;
  7316. last_coding.clear();
  7317. split(value.data(), value.data() + value.size(), ',',
  7318. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7319. }
  7320. return case_ignore::equal(last_coding, "chunked");
  7321. }
  7322. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7323. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7324. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7325. return msg.has_header("Transfer-Encoding") &&
  7326. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7327. }
  7328. inline bool has_conflicting_content_length(const Headers &headers) {
  7329. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7330. // Content-Length is framed ambiguously. The body readers here delimit it by
  7331. // the transfer coding and drop Content-Length, while an intermediary may do
  7332. // the reverse, so the two disagree on where the body ends and a reused
  7333. // connection is desynchronised (request/response smuggling). Content-Length:
  7334. // 0 is tolerated for compatibility with existing peers.
  7335. return has_header(headers, "Transfer-Encoding") &&
  7336. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7337. }
  7338. template <typename T, typename U>
  7339. bool prepare_content_receiver(T &x, int &status,
  7340. ContentReceiverWithProgress receiver,
  7341. bool decompress, size_t payload_max_length,
  7342. bool &exceed_payload_max_length, U callback) {
  7343. if (decompress) {
  7344. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7345. std::unique_ptr<decompressor> decompressor;
  7346. if (!encoding.empty()) {
  7347. // A coding we know about but were not built with is an error. An
  7348. // unrecognized coding (including "identity") is left alone and the
  7349. // payload is passed through as-is, since some servers misuse the header,
  7350. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7351. decompressor = detail::create_decompressor(encoding);
  7352. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7353. status = StatusCode::UnsupportedMediaType_415;
  7354. return false;
  7355. }
  7356. }
  7357. if (decompressor) {
  7358. if (decompressor->is_valid()) {
  7359. size_t decompressed_size = 0;
  7360. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7361. size_t off, size_t len) {
  7362. return decompressor->decompress(
  7363. buf, n, [&](const char *buf2, size_t n2) {
  7364. // Guard against zip-bomb: check
  7365. // decompressed size against limit.
  7366. if (payload_max_length > 0 &&
  7367. (decompressed_size >= payload_max_length ||
  7368. n2 > payload_max_length - decompressed_size)) {
  7369. exceed_payload_max_length = true;
  7370. return false;
  7371. }
  7372. decompressed_size += n2;
  7373. return receiver(buf2, n2, off, len);
  7374. });
  7375. };
  7376. return callback(std::move(out));
  7377. } else {
  7378. status = StatusCode::InternalServerError_500;
  7379. return false;
  7380. }
  7381. }
  7382. }
  7383. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7384. size_t len) {
  7385. return receiver(buf, n, off, len);
  7386. };
  7387. return callback(std::move(out));
  7388. }
  7389. template <typename T>
  7390. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7391. DownloadProgress progress,
  7392. ContentReceiverWithProgress receiver, bool decompress) {
  7393. bool exceed_payload_max_length = false;
  7394. return prepare_content_receiver(
  7395. x, status, std::move(receiver), decompress, payload_max_length,
  7396. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7397. auto ret = true;
  7398. // Note: exceed_payload_max_length may also be set by the decompressor
  7399. // wrapper in prepare_content_receiver when the decompressed payload
  7400. // size exceeds the limit.
  7401. if (is_chunked_transfer_encoding(x.headers)) {
  7402. auto result = read_content_chunked(strm, x, 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 if (!has_header(x.headers, "Content-Length")) {
  7412. auto result =
  7413. read_content_without_length(strm, payload_max_length, out);
  7414. if (result == ReadContentResult::Success) {
  7415. ret = true;
  7416. } else if (result == ReadContentResult::PayloadTooLarge) {
  7417. exceed_payload_max_length = true;
  7418. ret = false;
  7419. } else {
  7420. ret = false;
  7421. }
  7422. } else {
  7423. auto is_invalid_value = false;
  7424. auto len = get_header_value_u64(x.headers, "Content-Length",
  7425. (std::numeric_limits<size_t>::max)(),
  7426. 0, is_invalid_value);
  7427. if (is_invalid_value) {
  7428. ret = false;
  7429. } else if (len > 0) {
  7430. auto result = read_content_with_length(
  7431. strm, len, std::move(progress), out, payload_max_length);
  7432. ret = (result == ReadContentResult::Success);
  7433. if (result == ReadContentResult::PayloadTooLarge) {
  7434. exceed_payload_max_length = true;
  7435. }
  7436. }
  7437. }
  7438. if (!ret) {
  7439. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7440. : StatusCode::BadRequest_400;
  7441. }
  7442. return ret;
  7443. });
  7444. }
  7445. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7446. const std::string &path) {
  7447. // Neither the method nor the request target may carry CR/LF, SP or other
  7448. // control octets; otherwise a value smuggled into either splits the request
  7449. // line and injects headers or a whole request.
  7450. if (!fields::is_token(method)) { return -1; }
  7451. if (!fields::is_request_target(path)) { return -1; }
  7452. std::string s = method;
  7453. s += ' ';
  7454. s += path;
  7455. s += " HTTP/1.1\r\n";
  7456. return strm.write(s.data(), s.size());
  7457. }
  7458. inline ssize_t write_response_line(Stream &strm, int status) {
  7459. std::string s = "HTTP/1.1 ";
  7460. s += std::to_string(status);
  7461. s += ' ';
  7462. s += httplib::status_message(status);
  7463. s += "\r\n";
  7464. return strm.write(s.data(), s.size());
  7465. }
  7466. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7467. ssize_t write_len = 0;
  7468. for (const auto &x : headers) {
  7469. std::string s;
  7470. s = x.first;
  7471. s += ": ";
  7472. s += x.second;
  7473. s += "\r\n";
  7474. auto len = strm.write(s.data(), s.size());
  7475. if (len < 0) { return len; }
  7476. write_len += len;
  7477. }
  7478. auto len = strm.write("\r\n");
  7479. if (len < 0) { return len; }
  7480. write_len += len;
  7481. return write_len;
  7482. }
  7483. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7484. size_t offset = 0;
  7485. while (offset < l) {
  7486. auto length = strm.write(d + offset, l - offset);
  7487. if (length < 0) { return false; }
  7488. offset += static_cast<size_t>(length);
  7489. }
  7490. return true;
  7491. }
  7492. template <typename T>
  7493. inline bool write_content_with_progress(Stream &strm,
  7494. const ContentProvider &content_provider,
  7495. size_t offset, size_t length,
  7496. T is_shutting_down,
  7497. const UploadProgress &upload_progress,
  7498. Error &error) {
  7499. size_t end_offset = offset + length;
  7500. size_t start_offset = offset;
  7501. auto ok = true;
  7502. auto finished = false;
  7503. DataSink data_sink;
  7504. data_sink.write = [&](const char *d, size_t l) -> bool {
  7505. if (ok) {
  7506. // Bytes past `length` would follow the framed body, where the peer reads
  7507. // them as the next message. Write only what fits and fail the rest.
  7508. if (l > end_offset - offset) {
  7509. l = end_offset - offset;
  7510. ok = false;
  7511. }
  7512. if (write_data(strm, d, l)) {
  7513. offset += l;
  7514. if (upload_progress && length > 0) {
  7515. size_t current_written = offset - start_offset;
  7516. if (!upload_progress(current_written, length)) {
  7517. ok = false;
  7518. return false;
  7519. }
  7520. }
  7521. } else {
  7522. ok = false;
  7523. }
  7524. }
  7525. return ok;
  7526. };
  7527. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7528. // The body is framed by `length`, so a provider that reports itself done
  7529. // early has truncated it. Record that and let the short-body check below
  7530. // fail the write, rather than calling the provider again forever.
  7531. data_sink.done = [&]() { finished = true; };
  7532. while (offset < end_offset && !finished && !is_shutting_down()) {
  7533. auto last_offset = offset;
  7534. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7535. error = Error::Write;
  7536. return false;
  7537. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7538. error = Error::Canceled;
  7539. return false;
  7540. } else if (!ok) {
  7541. error = Error::Write;
  7542. return false;
  7543. }
  7544. // A provider that reports success without writing anything and without
  7545. // reporting itself done gets handed the same offset and length again on
  7546. // the next pass, so it would spin here for as long as the peer stays
  7547. // connected. Treat making no progress as a short body, like done() early.
  7548. if (!finished && offset == last_offset) {
  7549. error = Error::Write;
  7550. return false;
  7551. }
  7552. }
  7553. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7554. error = Error::Write;
  7555. return false;
  7556. }
  7557. error = Error::Success;
  7558. return true;
  7559. }
  7560. template <typename T>
  7561. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7562. size_t offset, size_t length, T is_shutting_down,
  7563. Error &error) {
  7564. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7565. is_shutting_down, nullptr, error);
  7566. }
  7567. template <typename T>
  7568. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7569. size_t offset, size_t length,
  7570. const T &is_shutting_down) {
  7571. auto error = Error::Success;
  7572. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7573. error);
  7574. }
  7575. template <typename T>
  7576. inline bool
  7577. write_content_without_length(Stream &strm,
  7578. const ContentProvider &content_provider,
  7579. const T &is_shutting_down) {
  7580. size_t offset = 0;
  7581. auto data_available = true;
  7582. auto ok = true;
  7583. DataSink data_sink;
  7584. data_sink.write = [&](const char *d, size_t l) -> bool {
  7585. if (ok) {
  7586. offset += l;
  7587. if (!write_data(strm, d, l)) { ok = false; }
  7588. }
  7589. return ok;
  7590. };
  7591. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7592. data_sink.done = [&](void) { data_available = false; };
  7593. while (data_available && !is_shutting_down()) {
  7594. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7595. return false;
  7596. } else if (!content_provider(offset, 0, data_sink)) {
  7597. return false;
  7598. } else if (!ok) {
  7599. return false;
  7600. }
  7601. }
  7602. return !data_available; // true only if done() was called, false if shutting
  7603. // down
  7604. }
  7605. // Runs a known-length content provider to completion and compresses what it
  7606. // writes into `out`, chunk by chunk, without holding the identity form.
  7607. inline bool compress_content_provider(const ContentProvider &content_provider,
  7608. size_t length, compressor &cmp,
  7609. std::string &out) {
  7610. size_t offset = 0;
  7611. auto ok = true;
  7612. auto finished = false;
  7613. DataSink data_sink;
  7614. auto append = [&](const char *data, size_t data_len) {
  7615. out.append(data, data_len);
  7616. return true;
  7617. };
  7618. data_sink.write = [&](const char *d, size_t l) -> bool {
  7619. if (!ok) { return false; }
  7620. offset += l;
  7621. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7622. return ok;
  7623. };
  7624. // The body is framed by `length`, so a provider that reports itself done
  7625. // early has truncated it; the short-body check below turns that into a
  7626. // failure rather than calling the provider again forever.
  7627. data_sink.done = [&]() { finished = true; };
  7628. while (offset < length && !finished) {
  7629. auto prev_offset = offset;
  7630. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7631. return false;
  7632. }
  7633. // No Stream to block on here, so a provider that keeps returning true
  7634. // without writing would spin. Treat a pass that made no progress as a
  7635. // failure.
  7636. if (offset == prev_offset) { return false; }
  7637. }
  7638. if (offset != length) { return false; }
  7639. return cmp.compress(nullptr, 0, true, append);
  7640. }
  7641. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7642. // and the file flag, so recording them has to come after; keeping all of it
  7643. // here means a third file-serving path cannot get that order wrong.
  7644. inline void set_file_content_provider(Response &res,
  7645. const std::shared_ptr<mmap> &m,
  7646. const std::string &content_type,
  7647. EncodingType encoding) {
  7648. // One read and one write move up to this much of the file at a time.
  7649. auto buf = std::make_shared<std::vector<char>>(
  7650. (std::min)(m->size(), size_t(256 * 1024)));
  7651. res.set_content_provider(
  7652. m->size(), content_type,
  7653. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7654. // Never read past the file, which ends the response early if it has
  7655. // shrunk since it was opened.
  7656. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7657. if (n == 0) { return false; }
  7658. sink.write(buf->data(), n);
  7659. return true;
  7660. });
  7661. res.is_file_content_provider_ = true;
  7662. res.content_coding_ = encoding;
  7663. }
  7664. template <typename T, typename U>
  7665. inline bool
  7666. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7667. const T &is_shutting_down, U &compressor, Error &error) {
  7668. size_t offset = 0;
  7669. auto data_available = true;
  7670. auto ok = true;
  7671. DataSink data_sink;
  7672. data_sink.write = [&](const char *d, size_t l) -> bool {
  7673. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7674. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7675. // zero-length chunk is the terminator, so it must not be emitted here.
  7676. if (ok && l > 0) {
  7677. offset += l;
  7678. std::string payload;
  7679. if (compressor.compress(d, l, false,
  7680. [&](const char *data, size_t data_len) {
  7681. payload.append(data, data_len);
  7682. return true;
  7683. })) {
  7684. if (!payload.empty()) {
  7685. // Emit chunked response header and footer for each chunk
  7686. auto chunk =
  7687. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7688. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7689. }
  7690. } else {
  7691. ok = false;
  7692. }
  7693. }
  7694. return ok;
  7695. };
  7696. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7697. auto done_with_trailer = [&](const Headers *trailer) {
  7698. if (!ok) { return; }
  7699. data_available = false;
  7700. std::string payload;
  7701. if (!compressor.compress(nullptr, 0, true,
  7702. [&](const char *data, size_t data_len) {
  7703. payload.append(data, data_len);
  7704. return true;
  7705. })) {
  7706. ok = false;
  7707. return;
  7708. }
  7709. if (!payload.empty()) {
  7710. // Emit chunked response header and footer for each chunk
  7711. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7712. if (!write_data(strm, chunk.data(), chunk.size())) {
  7713. ok = false;
  7714. return;
  7715. }
  7716. }
  7717. constexpr const char done_marker[] = "0\r\n";
  7718. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7719. // Trailer
  7720. if (trailer) {
  7721. for (const auto &kv : *trailer) {
  7722. // Skip fields with invalid names or values to prevent response
  7723. // splitting via CR/LF injection, matching set_header().
  7724. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7725. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7726. if (!write_data(strm, field_line.data(), field_line.size())) {
  7727. ok = false;
  7728. }
  7729. }
  7730. }
  7731. constexpr const char crlf[] = "\r\n";
  7732. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7733. };
  7734. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7735. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7736. done_with_trailer(&trailer);
  7737. };
  7738. while (data_available && !is_shutting_down()) {
  7739. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7740. error = Error::Write;
  7741. return false;
  7742. } else if (!content_provider(offset, 0, data_sink)) {
  7743. error = Error::Canceled;
  7744. return false;
  7745. } else if (!ok) {
  7746. error = Error::Write;
  7747. return false;
  7748. }
  7749. }
  7750. if (data_available) { // exited due to is_shutting_down(), not done()
  7751. error = Error::Write;
  7752. return false;
  7753. }
  7754. error = Error::Success;
  7755. return true;
  7756. }
  7757. template <typename T, typename U>
  7758. inline bool write_content_chunked(Stream &strm,
  7759. const ContentProvider &content_provider,
  7760. const T &is_shutting_down, U &compressor) {
  7761. auto error = Error::Success;
  7762. return write_content_chunked(strm, content_provider, is_shutting_down,
  7763. compressor, error);
  7764. }
  7765. template <typename T>
  7766. inline bool redirect(T &cli, Request &req, Response &res,
  7767. const std::string &path, const std::string &location,
  7768. Error &error) {
  7769. Request new_req = req;
  7770. new_req.path = path;
  7771. new_req.redirect_count_ -= 1;
  7772. if (res.status == StatusCode::SeeOther_303 &&
  7773. (req.method != "GET" && req.method != "HEAD")) {
  7774. new_req.method = "GET";
  7775. new_req.body.clear();
  7776. new_req.headers.clear();
  7777. new_req.content_length_ = 0;
  7778. new_req.content_provider_ = nullptr;
  7779. new_req.is_chunked_content_provider_ = false;
  7780. }
  7781. Response new_res;
  7782. auto ret = cli.send(new_req, new_res, error);
  7783. if (ret) {
  7784. req = std::move(new_req);
  7785. res = std::move(new_res);
  7786. if (res.location.empty()) { res.location = location; }
  7787. }
  7788. return ret;
  7789. }
  7790. inline std::string params_to_query_str(const Params &params) {
  7791. std::string query;
  7792. for (auto it = params.begin(); it != params.end(); ++it) {
  7793. if (it != params.begin()) { query += '&'; }
  7794. query += encode_query_component(it->first);
  7795. query += '=';
  7796. query += encode_query_component(it->second);
  7797. }
  7798. return query;
  7799. }
  7800. // Splits one "key=value" span of a query string at its first '='. A span with
  7801. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7802. // "?flag" keeps its name.
  7803. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7804. std::string &val) {
  7805. divide(b, static_cast<std::size_t>(e - b), '=',
  7806. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7807. std::size_t rhs_size) {
  7808. key.assign(lhs_data, lhs_size);
  7809. val.assign(rhs_data, rhs_size);
  7810. });
  7811. }
  7812. inline void parse_query_text(const char *data, std::size_t size,
  7813. Params &params) {
  7814. std::set<std::string> cache;
  7815. split(data, data + size, '&', [&](const char *b, const char *e) {
  7816. std::string kv(b, e);
  7817. if (cache.find(kv) != cache.end()) { return; }
  7818. cache.insert(std::move(kv));
  7819. std::string key;
  7820. std::string val;
  7821. divide_query_pair(b, e, key, val);
  7822. if (!key.empty()) {
  7823. params.emplace(decode_query_component(key), decode_query_component(val));
  7824. }
  7825. });
  7826. }
  7827. inline void parse_query_text(const std::string &s, Params &params) {
  7828. parse_query_text(s.data(), s.size(), params);
  7829. }
  7830. // Normalize a query string by decoding and re-encoding each key/value pair
  7831. // while preserving the original parameter order. This avoids double-encoding
  7832. // and ensures consistent encoding. It works on the raw string rather than
  7833. // parsing into Params and re-serializing, because that round trip cannot
  7834. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7835. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7836. // duplicated pairs.
  7837. inline std::string normalize_query_string(const std::string &query) {
  7838. std::string result;
  7839. split(query.data(), query.data() + query.size(), '&',
  7840. [&](const char *b, const char *e) {
  7841. std::string key;
  7842. std::string val;
  7843. divide_query_pair(b, e, key, val);
  7844. if (!key.empty()) {
  7845. auto dec_key = decode_query_component(key);
  7846. auto dec_val = decode_query_component(val);
  7847. if (!result.empty()) { result += '&'; }
  7848. result += encode_query_component(dec_key);
  7849. if (!val.empty() || std::find(b, e, '=') != e) {
  7850. result += '=';
  7851. result += encode_query_component(dec_val);
  7852. }
  7853. }
  7854. });
  7855. return result;
  7856. }
  7857. // The query of a client's path: what follows '?', up to the fragment.
  7858. inline std::string query_of(const std::string &path) {
  7859. auto fragment_pos = path.find('#');
  7860. auto query_pos = path.find('?');
  7861. return query_pos < fragment_pos
  7862. ? path.substr(query_pos + 1, fragment_pos - query_pos - 1)
  7863. : std::string();
  7864. }
  7865. // Build the request target that goes on the wire from a caller-supplied path.
  7866. // Shared by the buffered send path and the streaming API so that both put the
  7867. // same bytes in the request line for the same input.
  7868. inline std::string encode_request_target(const std::string &uri,
  7869. bool path_encode) {
  7870. // The fragment stays with the client (RFC 9110 §7.1).
  7871. auto target = uri.substr(0, uri.find('#'));
  7872. // `substr(0, npos)` yields the whole string, which is what the no-query
  7873. // case needs.
  7874. auto query_pos = target.find('?');
  7875. auto path_part = target.substr(0, query_pos);
  7876. std::string query_part;
  7877. if (query_pos != std::string::npos) {
  7878. query_part = target.substr(query_pos + 1);
  7879. }
  7880. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7881. if (!query_part.empty()) {
  7882. // When path encoding is disabled the caller has supplied an already-encoded
  7883. // target and expects the exact bytes to be sent on the wire, so skip
  7884. // normalization for the query too. Normalizing would decode-then-re-encode
  7885. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7886. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7887. if (path_encode) {
  7888. auto normalized = normalize_query_string(query_part);
  7889. if (!normalized.empty()) {
  7890. result += '?';
  7891. result += normalized;
  7892. }
  7893. } else {
  7894. result += '?';
  7895. result += query_part;
  7896. }
  7897. }
  7898. return result;
  7899. }
  7900. inline bool parse_multipart_boundary(const std::string &content_type,
  7901. std::string &boundary) {
  7902. std::map<std::string, std::string> params;
  7903. extract_media_type(content_type, &params);
  7904. auto it = params.find("boundary");
  7905. if (it == params.end()) { return false; }
  7906. boundary = it->second;
  7907. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7908. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7909. // bytes costs a nearly full comparison at nearly every position: the
  7910. // boundary's length multiplies the worst-case cost of scanning a body.
  7911. return !boundary.empty() && boundary.size() <= 70;
  7912. }
  7913. inline void parse_disposition_params(const std::string &s, Params &params) {
  7914. std::set<std::string> cache;
  7915. split_unquoted(
  7916. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7917. std::string kv(b, e);
  7918. if (cache.find(kv) != cache.end()) { return; }
  7919. cache.insert(kv);
  7920. std::string key;
  7921. std::string val;
  7922. divide_param_pair(b, e, key, val);
  7923. if (!key.empty()) {
  7924. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7925. }
  7926. });
  7927. }
  7928. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7929. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7930. #else
  7931. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7932. #endif
  7933. auto is_valid = [](const std::string &str) {
  7934. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7935. };
  7936. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7937. const auto pos = static_cast<size_t>(6);
  7938. const auto len = static_cast<size_t>(s.size() - 6);
  7939. auto all_valid_ranges = true;
  7940. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7941. if (!all_valid_ranges) { return; }
  7942. const auto it = std::find(b, e, '-');
  7943. if (it == e) {
  7944. all_valid_ranges = false;
  7945. return;
  7946. }
  7947. const auto lhs = std::string(b, it);
  7948. const auto rhs = std::string(it + 1, e);
  7949. if (!is_valid(lhs) || !is_valid(rhs)) {
  7950. all_valid_ranges = false;
  7951. return;
  7952. }
  7953. ssize_t first = -1;
  7954. if (!lhs.empty()) {
  7955. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7956. // would turn the range into a suffix range.
  7957. auto res =
  7958. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7959. if (res.ec != std::errc{}) {
  7960. all_valid_ranges = false;
  7961. return;
  7962. }
  7963. }
  7964. ssize_t last = -1;
  7965. if (!rhs.empty()) {
  7966. // An overflowing last-byte-pos is past any content length, so keeping
  7967. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7968. ssize_t v;
  7969. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7970. if (res.ec == std::errc{}) { last = v; }
  7971. }
  7972. if ((first == -1 && last == -1) ||
  7973. (first != -1 && last != -1 && first > last)) {
  7974. all_valid_ranges = false;
  7975. return;
  7976. }
  7977. ranges.emplace_back(first, last);
  7978. });
  7979. return all_valid_ranges && !ranges.empty();
  7980. }
  7981. return false;
  7982. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7983. }
  7984. #else
  7985. } catch (...) { return false; }
  7986. #endif
  7987. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7988. inline std::string remove_quoted_strings(const std::string &s) {
  7989. std::string out;
  7990. auto in_quotes = false;
  7991. for (size_t i = 0; i < s.size(); i++) {
  7992. if (s[i] == '"') {
  7993. in_quotes = !in_quotes;
  7994. } else if (!in_quotes) {
  7995. out += s[i];
  7996. } else if (s[i] == '\\') {
  7997. i++;
  7998. }
  7999. }
  8000. return out;
  8001. }
  8002. inline bool parse_accept_header(const std::string &s,
  8003. std::vector<std::string> &content_types) {
  8004. // Parameter values are not used here, so a quoted-string is dropped rather
  8005. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  8006. if (s.find('"') != std::string::npos) {
  8007. return parse_accept_header(remove_quoted_strings(s), content_types);
  8008. }
  8009. content_types.clear();
  8010. // Empty string is considered valid (no preference)
  8011. if (s.empty()) { return true; }
  8012. struct AcceptEntry {
  8013. std::string media_type;
  8014. double quality;
  8015. int order;
  8016. };
  8017. std::vector<AcceptEntry> entries;
  8018. int order = 0;
  8019. bool has_invalid_entry = false;
  8020. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  8021. // has to parse and ignore empty list elements, so a leading, trailing or
  8022. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  8023. // split() skips them, and the header length limit bounds how many a sender
  8024. // can send, so ignoring all of them cannot be used as a denial-of-service
  8025. // vector.
  8026. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  8027. std::string entry(b, e);
  8028. entry = trim_copy(entry);
  8029. AcceptEntry accept_entry;
  8030. accept_entry.order = order++;
  8031. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  8032. accept_entry.media_type, accept_entry.quality)) {
  8033. has_invalid_entry = true;
  8034. return;
  8035. }
  8036. // Remove additional parameters from media type
  8037. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  8038. // Basic validation of media type format
  8039. if (accept_entry.media_type.empty()) {
  8040. has_invalid_entry = true;
  8041. return;
  8042. }
  8043. // Check for basic media type format (should contain '/' or be '*')
  8044. if (accept_entry.media_type != "*" &&
  8045. accept_entry.media_type.find('/') == std::string::npos) {
  8046. has_invalid_entry = true;
  8047. return;
  8048. }
  8049. entries.push_back(std::move(accept_entry));
  8050. });
  8051. // Return false if any invalid entry was found
  8052. if (has_invalid_entry) { return false; }
  8053. // Sort by quality (descending), then by original order (ascending)
  8054. std::sort(entries.begin(), entries.end(),
  8055. [](const AcceptEntry &a, const AcceptEntry &b) {
  8056. if (a.quality != b.quality) {
  8057. return a.quality > b.quality; // Higher quality first
  8058. }
  8059. return a.order < b.order; // Earlier order first for same quality
  8060. });
  8061. // Extract sorted media types
  8062. content_types.reserve(entries.size());
  8063. for (auto &entry : entries) {
  8064. content_types.push_back(std::move(entry.media_type));
  8065. }
  8066. return true;
  8067. }
  8068. class FormDataParser {
  8069. public:
  8070. FormDataParser() = default;
  8071. void set_boundary(std::string &&boundary) {
  8072. boundary_ = std::move(boundary);
  8073. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  8074. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  8075. }
  8076. bool is_valid() const { return is_valid_; }
  8077. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  8078. const ContentReceiver &content_callback) {
  8079. // Once the close delimiter has been seen the rest of the body is epilogue
  8080. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  8081. // spread across reads is not copied in only to be erased right away.
  8082. if (state_ == 5) { return true; }
  8083. buf_append(buf, n);
  8084. while (buf_size() > 0) {
  8085. switch (state_) {
  8086. case 0: { // Initial boundary
  8087. auto pos = buf_find(dash_boundary_crlf_);
  8088. if (pos == buf_size()) {
  8089. // Not found yet: keep only a possible partial boundary at the tail so
  8090. // that a body which never contains the boundary cannot grow the
  8091. // buffer (and get rescanned from the start) without bound.
  8092. auto keep = dash_boundary_crlf_.size() - 1;
  8093. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8094. return true;
  8095. }
  8096. buf_erase(pos + dash_boundary_crlf_.size());
  8097. state_ = 1;
  8098. break;
  8099. }
  8100. case 1: { // New entry
  8101. clear_file_info();
  8102. header_searched_ = 0;
  8103. state_ = 2;
  8104. break;
  8105. }
  8106. case 2: { // Headers
  8107. // Resume where the last call stopped looking, so that a line arriving
  8108. // a few bytes at a time is not searched from its start each time.
  8109. auto pos = buf_find(crlf_, header_searched_);
  8110. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8111. while (pos < buf_size()) {
  8112. // Empty line
  8113. if (pos == 0) {
  8114. if (!header_callback(file_)) {
  8115. is_valid_ = false;
  8116. return false;
  8117. }
  8118. buf_erase(crlf_.size());
  8119. state_ = 3;
  8120. break;
  8121. }
  8122. // Check header count limit
  8123. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8124. is_valid_ = false;
  8125. return false;
  8126. }
  8127. header_count_++;
  8128. const auto header = buf_head(pos);
  8129. if (!parse_header(header.data(), header.data() + header.size(),
  8130. [&](const std::string &, const std::string &) {})) {
  8131. is_valid_ = false;
  8132. return false;
  8133. }
  8134. // Parse and emplace space trimmed headers into a map
  8135. if (!parse_header(
  8136. header.data(), header.data() + header.size(),
  8137. [&](const std::string &key, const std::string &val) {
  8138. file_.headers.emplace(key, val);
  8139. })) {
  8140. is_valid_ = false;
  8141. return false;
  8142. }
  8143. constexpr const char header_content_type[] = "Content-Type:";
  8144. if (start_with_case_ignore(header, header_content_type)) {
  8145. file_.content_type =
  8146. trim_copy(header.substr(str_len(header_content_type)));
  8147. } else {
  8148. std::string disposition_params;
  8149. if (parse_content_disposition(header, disposition_params)) {
  8150. Params params;
  8151. parse_disposition_params(disposition_params, params);
  8152. auto it = params.find("name");
  8153. if (it != params.end()) {
  8154. file_.name = it->second;
  8155. } else {
  8156. is_valid_ = false;
  8157. return false;
  8158. }
  8159. it = params.find("filename");
  8160. if (it != params.end()) { file_.filename = it->second; }
  8161. it = params.find("filename*");
  8162. if (it != params.end()) {
  8163. // RFC 5987: only UTF-8 encoding is allowed
  8164. const auto &val = it->second;
  8165. constexpr const char utf8_prefix[] = "UTF-8''";
  8166. constexpr size_t prefix_len = str_len(utf8_prefix);
  8167. if (val.size() > prefix_len &&
  8168. start_with_case_ignore(val, utf8_prefix)) {
  8169. file_.filename = decode_path_component(
  8170. val.substr(prefix_len)); // override...
  8171. } else {
  8172. is_valid_ = false;
  8173. return false;
  8174. }
  8175. }
  8176. }
  8177. }
  8178. buf_erase(pos + crlf_.size());
  8179. pos = buf_find(crlf_);
  8180. }
  8181. if (state_ != 3) {
  8182. // The CR of the CRLF may be the last byte so far.
  8183. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8184. return true;
  8185. }
  8186. break;
  8187. }
  8188. case 3: { // Body
  8189. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8190. auto pos = buf_find(crlf_dash_boundary_);
  8191. if (pos < buf_size()) {
  8192. if (!content_callback(buf_data(), pos)) {
  8193. is_valid_ = false;
  8194. return false;
  8195. }
  8196. buf_erase(pos + crlf_dash_boundary_.size());
  8197. state_ = 4;
  8198. } else {
  8199. auto len = buf_size() - crlf_dash_boundary_.size();
  8200. if (len > 0) {
  8201. if (!content_callback(buf_data(), len)) {
  8202. is_valid_ = false;
  8203. return false;
  8204. }
  8205. buf_erase(len);
  8206. }
  8207. return true;
  8208. }
  8209. break;
  8210. }
  8211. case 4: { // Boundary
  8212. if (crlf_.size() > buf_size()) { return true; }
  8213. if (buf_start_with(crlf_)) {
  8214. buf_erase(crlf_.size());
  8215. state_ = 1;
  8216. } else if (buf_start_with(dash_)) {
  8217. buf_erase(dash_.size());
  8218. is_valid_ = true;
  8219. state_ = 5;
  8220. } else {
  8221. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8222. // accepted after a boundary; RFC 2046 allows transport-padding in
  8223. // between, but this parser has never supported it. Either way the
  8224. // body is already destined to be rejected, so fail now instead of
  8225. // buffering the rest of it. Both are two bytes, so the check above
  8226. // already guarantees enough buffered data to decide.
  8227. is_valid_ = false;
  8228. return false;
  8229. }
  8230. break;
  8231. }
  8232. case 5: { // Epilogue
  8233. buf_erase(buf_size());
  8234. break;
  8235. }
  8236. }
  8237. }
  8238. return true;
  8239. }
  8240. private:
  8241. void clear_file_info() {
  8242. file_.name.clear();
  8243. file_.filename.clear();
  8244. file_.content_type.clear();
  8245. file_.headers.clear();
  8246. header_count_ = 0;
  8247. }
  8248. bool start_with_case_ignore(const std::string &a, const char *b,
  8249. size_t offset = 0) const {
  8250. const auto b_len = strlen(b);
  8251. if (a.size() < offset + b_len) { return false; }
  8252. for (size_t i = 0; i < b_len; i++) {
  8253. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8254. return false;
  8255. }
  8256. }
  8257. return true;
  8258. }
  8259. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8260. // Returns true if header matches, with the params portion in `params_out`.
  8261. bool parse_content_disposition(const std::string &header,
  8262. std::string &params_out) const {
  8263. constexpr const char prefix[] = "Content-Disposition:";
  8264. constexpr size_t prefix_len = str_len(prefix);
  8265. if (!start_with_case_ignore(header, prefix)) { return false; }
  8266. // Skip whitespace after "Content-Disposition:"
  8267. auto pos = prefix_len;
  8268. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8269. pos++;
  8270. }
  8271. // Match "form-data;" (case-insensitive)
  8272. constexpr const char form_data[] = "form-data;";
  8273. constexpr size_t form_data_len = str_len(form_data);
  8274. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8275. pos += form_data_len;
  8276. // Skip whitespace after "form-data;"
  8277. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8278. pos++;
  8279. }
  8280. params_out = header.substr(pos);
  8281. return true;
  8282. }
  8283. const std::string dash_ = "--";
  8284. const std::string crlf_ = "\r\n";
  8285. std::string boundary_;
  8286. std::string dash_boundary_crlf_;
  8287. std::string crlf_dash_boundary_;
  8288. size_t state_ = 0;
  8289. bool is_valid_ = false;
  8290. FormData file_;
  8291. size_t header_count_ = 0;
  8292. size_t header_searched_ = 0;
  8293. // Buffer
  8294. bool start_with(const std::string &a, size_t spos, size_t epos,
  8295. const std::string &b) const {
  8296. if (epos - spos < b.size()) { return false; }
  8297. for (size_t i = 0; i < b.size(); i++) {
  8298. if (a[i + spos] != b[i]) { return false; }
  8299. }
  8300. return true;
  8301. }
  8302. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8303. const char *buf_data() const { return &buf_[buf_spos_]; }
  8304. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8305. bool buf_start_with(const std::string &s) const {
  8306. return start_with(buf_, buf_spos_, buf_epos_, s);
  8307. }
  8308. size_t buf_find(const std::string &s, size_t from = 0) const {
  8309. auto c = s.front();
  8310. size_t off = buf_spos_ + from;
  8311. while (off < buf_epos_) {
  8312. auto pos = off;
  8313. while (true) {
  8314. if (pos == buf_epos_) { return buf_size(); }
  8315. if (buf_[pos] == c) { break; }
  8316. pos++;
  8317. }
  8318. auto remaining_size = buf_epos_ - pos;
  8319. if (s.size() > remaining_size) { return buf_size(); }
  8320. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8321. off = pos + 1;
  8322. }
  8323. return buf_size();
  8324. }
  8325. void buf_append(const char *data, size_t n) {
  8326. auto remaining_size = buf_size();
  8327. if (remaining_size > 0 && buf_spos_ > 0) {
  8328. for (size_t i = 0; i < remaining_size; i++) {
  8329. buf_[i] = buf_[buf_spos_ + i];
  8330. }
  8331. }
  8332. buf_spos_ = 0;
  8333. buf_epos_ = remaining_size;
  8334. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8335. for (size_t i = 0; i < n; i++) {
  8336. buf_[buf_epos_ + i] = data[i];
  8337. }
  8338. buf_epos_ += n;
  8339. }
  8340. void buf_erase(size_t size) { buf_spos_ += size; }
  8341. std::string buf_;
  8342. size_t buf_spos_ = 0;
  8343. size_t buf_epos_ = 0;
  8344. };
  8345. inline std::string random_string(size_t length) {
  8346. constexpr const char data[] =
  8347. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8348. std::string result(length, '\0');
  8349. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8350. for (auto &c : result) {
  8351. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8352. }
  8353. return result;
  8354. }
  8355. inline std::string make_multipart_data_boundary() {
  8356. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8357. }
  8358. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8359. auto valid = true;
  8360. for (size_t i = 0; i < boundary.size(); i++) {
  8361. auto c = boundary[i];
  8362. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8363. valid = false;
  8364. break;
  8365. }
  8366. }
  8367. return valid;
  8368. }
  8369. // Escape a multipart field name/filename following the WHATWG HTML standard
  8370. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8371. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8372. // With quoted = false, only CR and LF are escaped; this is for header values
  8373. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8374. inline std::string escape_multipart_field(const std::string &s,
  8375. bool quoted = true) {
  8376. std::string result;
  8377. result.reserve(s.size());
  8378. for (auto c : s) {
  8379. switch (c) {
  8380. case '"':
  8381. if (quoted) {
  8382. result += "%22";
  8383. } else {
  8384. result += c;
  8385. }
  8386. break;
  8387. case '\\':
  8388. // A lone backslash would escape the character after it (RFC 9110
  8389. // 5.6.4).
  8390. if (quoted) { result += '\\'; }
  8391. result += c;
  8392. break;
  8393. case '\r': result += "%0D"; break;
  8394. case '\n': result += "%0A"; break;
  8395. default: result += c; break;
  8396. }
  8397. }
  8398. return result;
  8399. }
  8400. template <typename T>
  8401. inline std::string
  8402. serialize_multipart_formdata_item_begin(const T &item,
  8403. const std::string &boundary) {
  8404. std::string body = "--" + boundary + "\r\n";
  8405. body += "Content-Disposition: form-data; name=\"" +
  8406. escape_multipart_field(item.name) + "\"";
  8407. if (!item.filename.empty()) {
  8408. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8409. }
  8410. body += "\r\n";
  8411. if (!item.content_type.empty()) {
  8412. body +=
  8413. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8414. "\r\n";
  8415. }
  8416. body += "\r\n";
  8417. return body;
  8418. }
  8419. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8420. inline std::string
  8421. serialize_multipart_formdata_finish(const std::string &boundary) {
  8422. return "--" + boundary + "--\r\n";
  8423. }
  8424. inline std::string
  8425. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8426. return "multipart/form-data; boundary=" + boundary;
  8427. }
  8428. inline std::string
  8429. serialize_multipart_formdata(const UploadFormDataItems &items,
  8430. const std::string &boundary, bool finish = true) {
  8431. std::string body;
  8432. for (const auto &item : items) {
  8433. body += serialize_multipart_formdata_item_begin(item, boundary);
  8434. body += item.content + serialize_multipart_formdata_item_end();
  8435. }
  8436. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8437. return body;
  8438. }
  8439. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8440. const std::string &boundary) {
  8441. size_t total = 0;
  8442. for (const auto &item : items) {
  8443. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8444. total += item.content.size();
  8445. total += serialize_multipart_formdata_item_end().size();
  8446. }
  8447. total += serialize_multipart_formdata_finish(boundary).size();
  8448. return total;
  8449. }
  8450. struct MultipartSegment {
  8451. const char *data;
  8452. size_t size;
  8453. };
  8454. // NOTE: items must outlive the returned ContentProvider
  8455. // (safe for synchronous use inside Post/Put/Patch)
  8456. inline ContentProvider
  8457. make_multipart_content_provider(const UploadFormDataItems &items,
  8458. const std::string &boundary) {
  8459. // Own the per-item header strings and the finish string
  8460. std::vector<std::string> owned;
  8461. owned.reserve(items.size() + 1);
  8462. for (const auto &item : items)
  8463. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8464. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8465. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8466. std::vector<MultipartSegment> segs;
  8467. segs.reserve(items.size() * 3 + 1);
  8468. static const char crlf[] = "\r\n";
  8469. for (size_t i = 0; i < items.size(); i++) {
  8470. segs.push_back({owned[i].data(), owned[i].size()});
  8471. segs.push_back({items[i].content.data(), items[i].content.size()});
  8472. segs.push_back({crlf, 2});
  8473. }
  8474. segs.push_back({owned.back().data(), owned.back().size()});
  8475. struct MultipartState {
  8476. std::vector<std::string> owned;
  8477. std::vector<MultipartSegment> segs;
  8478. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8479. };
  8480. auto state = std::make_shared<MultipartState>();
  8481. state->owned = std::move(owned);
  8482. // `segs` holds raw pointers into owned strings; std::string move preserves
  8483. // the data pointer, so these pointers remain valid after the move above.
  8484. state->segs = std::move(segs);
  8485. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8486. // Buffer multiple small segments into fewer, larger writes to avoid
  8487. // excessive TCP packets when there are many form data items (#2410)
  8488. auto &buf = state->buf;
  8489. auto buf_size = buf.size();
  8490. size_t buf_len = 0;
  8491. size_t remaining = length;
  8492. // Find the first segment containing 'offset'
  8493. size_t pos = 0;
  8494. size_t seg_idx = 0;
  8495. for (; seg_idx < state->segs.size(); seg_idx++) {
  8496. const auto &seg = state->segs[seg_idx];
  8497. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8498. pos += seg.size;
  8499. }
  8500. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8501. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8502. const auto &seg = state->segs[seg_idx];
  8503. size_t available = seg.size - seg_offset;
  8504. size_t to_copy = (std::min)(available, remaining);
  8505. const char *src = seg.data + seg_offset;
  8506. seg_offset = 0; // only the first segment has a non-zero offset
  8507. while (to_copy > 0) {
  8508. size_t space = buf_size - buf_len;
  8509. size_t chunk = (std::min)(to_copy, space);
  8510. std::memcpy(buf.data() + buf_len, src, chunk);
  8511. buf_len += chunk;
  8512. src += chunk;
  8513. to_copy -= chunk;
  8514. remaining -= chunk;
  8515. if (buf_len == buf_size) {
  8516. if (!sink.write(buf.data(), buf_len)) { return false; }
  8517. buf_len = 0;
  8518. }
  8519. }
  8520. }
  8521. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8522. return true;
  8523. };
  8524. }
  8525. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8526. if (ranges.size() <= 1) return;
  8527. // Sort ranges by start position
  8528. std::sort(ranges.begin(), ranges.end(),
  8529. [](const Range &a, const Range &b) { return a.first < b.first; });
  8530. Ranges coalesced;
  8531. coalesced.reserve(ranges.size());
  8532. for (auto &r : ranges) {
  8533. auto first_pos = r.first;
  8534. auto last_pos = r.second;
  8535. // Handle special cases like in range_error
  8536. if (first_pos == -1 && last_pos == -1) {
  8537. first_pos = 0;
  8538. last_pos = static_cast<ssize_t>(content_length);
  8539. }
  8540. if (first_pos == -1) {
  8541. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8542. last_pos = static_cast<ssize_t>(content_length) - 1;
  8543. }
  8544. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8545. last_pos = static_cast<ssize_t>(content_length) - 1;
  8546. }
  8547. // Skip invalid ranges
  8548. if (!(0 <= first_pos && first_pos <= last_pos &&
  8549. last_pos < static_cast<ssize_t>(content_length))) {
  8550. continue;
  8551. }
  8552. // Coalesce with previous range if overlapping or adjacent (but not
  8553. // identical)
  8554. if (!coalesced.empty()) {
  8555. auto &prev = coalesced.back();
  8556. // Check if current range overlaps or is adjacent to previous range
  8557. // but don't coalesce identical ranges (allow duplicates)
  8558. if (first_pos <= prev.second + 1 &&
  8559. !(first_pos == prev.first && last_pos == prev.second)) {
  8560. // Extend the previous range
  8561. prev.second = (std::max)(prev.second, last_pos);
  8562. continue;
  8563. }
  8564. }
  8565. // Add new range
  8566. coalesced.emplace_back(first_pos, last_pos);
  8567. }
  8568. ranges = std::move(coalesced);
  8569. }
  8570. inline bool range_error(Request &req, Response &res) {
  8571. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8572. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8573. req.ranges.clear();
  8574. if (res.status == StatusCode::PartialContent_206) {
  8575. res.status = StatusCode::OK_200;
  8576. }
  8577. return false;
  8578. }
  8579. ssize_t content_len = static_cast<ssize_t>(
  8580. res.content_length_ ? res.content_length_ : res.body.size());
  8581. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8582. size_t overwrapping_count = 0;
  8583. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8584. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8585. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8586. // Too many ranges
  8587. if (CPPHTTPLIB_RANGE_MAX_COUNT > 0 &&
  8588. req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) {
  8589. return true;
  8590. }
  8591. for (auto &r : req.ranges) {
  8592. auto &first_pos = r.first;
  8593. auto &last_pos = r.second;
  8594. if (first_pos == -1 && last_pos == -1) {
  8595. first_pos = 0;
  8596. last_pos = content_len;
  8597. }
  8598. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8599. // selects the entire representation.
  8600. if (first_pos == -1) {
  8601. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8602. last_pos = content_len - 1;
  8603. }
  8604. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8605. // A client can limit the number of bytes requested without knowing the
  8606. // size of the selected representation. If the last-pos value is absent,
  8607. // or if the value is greater than or equal to the current length of the
  8608. // representation data, the byte range is interpreted as the remainder of
  8609. // the representation (i.e., the server replaces the value of last-pos
  8610. // with a value that is one less than the current length of the selected
  8611. // representation).
  8612. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8613. if (last_pos == -1 || last_pos >= content_len) {
  8614. last_pos = content_len - 1;
  8615. }
  8616. // Range must be within content length
  8617. if (!(0 <= first_pos && first_pos <= last_pos &&
  8618. last_pos <= content_len - 1)) {
  8619. return true;
  8620. }
  8621. // Request must not have more than two overlapping ranges
  8622. for (const auto &processed_range : processed_ranges) {
  8623. if (!(last_pos < processed_range.first ||
  8624. first_pos > processed_range.second)) {
  8625. overwrapping_count++;
  8626. if (overwrapping_count > 2) { return true; }
  8627. break; // Only count once per range
  8628. }
  8629. }
  8630. processed_ranges.emplace_back(first_pos, last_pos);
  8631. }
  8632. // After validation, coalesce overlapping ranges as per RFC 9110
  8633. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8634. }
  8635. return false;
  8636. }
  8637. inline std::pair<size_t, size_t>
  8638. get_range_offset_and_length(Range r, size_t content_length) {
  8639. assert(r.first != -1 && r.second != -1);
  8640. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8641. assert(r.first <= r.second &&
  8642. r.second < static_cast<ssize_t>(content_length));
  8643. (void)(content_length);
  8644. return std::make_pair(static_cast<size_t>(r.first),
  8645. static_cast<size_t>(r.second - r.first) + 1);
  8646. }
  8647. inline std::string make_content_range_header_field(
  8648. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8649. auto st = offset_and_length.first;
  8650. auto ed = st + offset_and_length.second - 1;
  8651. std::string field = "bytes ";
  8652. field += std::to_string(st);
  8653. field += '-';
  8654. field += std::to_string(ed);
  8655. field += '/';
  8656. field += std::to_string(content_length);
  8657. return field;
  8658. }
  8659. template <typename SToken, typename CToken, typename Content>
  8660. bool process_multipart_ranges_data(const Request &req,
  8661. const std::string &boundary,
  8662. const std::string &content_type,
  8663. size_t content_length, SToken stoken,
  8664. CToken ctoken, Content content) {
  8665. for (size_t i = 0; i < req.ranges.size(); i++) {
  8666. ctoken("--");
  8667. stoken(boundary);
  8668. ctoken("\r\n");
  8669. if (!content_type.empty()) {
  8670. ctoken("Content-Type: ");
  8671. stoken(content_type);
  8672. ctoken("\r\n");
  8673. }
  8674. auto offset_and_length =
  8675. get_range_offset_and_length(req.ranges[i], content_length);
  8676. ctoken("Content-Range: ");
  8677. stoken(make_content_range_header_field(offset_and_length, content_length));
  8678. ctoken("\r\n");
  8679. ctoken("\r\n");
  8680. if (!content(offset_and_length.first, offset_and_length.second)) {
  8681. return false;
  8682. }
  8683. ctoken("\r\n");
  8684. }
  8685. ctoken("--");
  8686. stoken(boundary);
  8687. ctoken("--");
  8688. return true;
  8689. }
  8690. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8691. const std::string &boundary,
  8692. const std::string &content_type,
  8693. size_t content_length,
  8694. std::string &data) {
  8695. process_multipart_ranges_data(
  8696. req, boundary, content_type, content_length,
  8697. [&](const std::string &token) { data += token; },
  8698. [&](const std::string &token) { data += token; },
  8699. [&](size_t offset, size_t length) {
  8700. assert(offset + length <= content_length);
  8701. data += res.body.substr(offset, length);
  8702. return true;
  8703. });
  8704. }
  8705. inline size_t get_multipart_ranges_data_length(const Request &req,
  8706. const std::string &boundary,
  8707. const std::string &content_type,
  8708. size_t content_length) {
  8709. size_t data_length = 0;
  8710. process_multipart_ranges_data(
  8711. req, boundary, content_type, content_length,
  8712. [&](const std::string &token) { data_length += token.size(); },
  8713. [&](const std::string &token) { data_length += token.size(); },
  8714. [&](size_t /*offset*/, size_t length) {
  8715. data_length += length;
  8716. return true;
  8717. });
  8718. return data_length;
  8719. }
  8720. template <typename T>
  8721. inline bool
  8722. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8723. const std::string &boundary,
  8724. const std::string &content_type,
  8725. size_t content_length, const T &is_shutting_down) {
  8726. return process_multipart_ranges_data(
  8727. req, boundary, content_type, content_length,
  8728. [&](const std::string &token) { strm.write(token); },
  8729. [&](const std::string &token) { strm.write(token); },
  8730. [&](size_t offset, size_t length) {
  8731. return write_content(strm, res.content_provider_, offset, length,
  8732. is_shutting_down);
  8733. });
  8734. }
  8735. inline bool has_framed_body(const Request &req) {
  8736. return is_chunked_transfer_encoding(req.headers) ||
  8737. req.get_header_value_u64("Content-Length") > 0;
  8738. }
  8739. inline bool is_connection_persistent(const Request &req) {
  8740. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8741. if (req.version == "HTTP/1.0" &&
  8742. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8743. return false;
  8744. }
  8745. return true;
  8746. }
  8747. inline bool expect_content(const Request &req) {
  8748. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8749. req.method == "DELETE") {
  8750. return true;
  8751. }
  8752. return has_framed_body(req);
  8753. }
  8754. #ifdef _WIN32
  8755. class WSInit {
  8756. public:
  8757. WSInit() {
  8758. WSADATA wsaData;
  8759. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8760. }
  8761. ~WSInit() {
  8762. if (is_valid_) WSACleanup();
  8763. }
  8764. bool is_valid_ = false;
  8765. };
  8766. static WSInit wsinit_;
  8767. #endif
  8768. inline std::string unescape_quoted_pairs(const std::string &s) {
  8769. std::string out;
  8770. out.reserve(s.size());
  8771. for (size_t i = 0; i < s.size(); i++) {
  8772. if (s[i] == '\\' && i + 1 < s.size()) {
  8773. out += s[++i];
  8774. } else {
  8775. out += s[i];
  8776. }
  8777. }
  8778. return out;
  8779. }
  8780. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8781. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8782. // quoted-pair, so the recipient recovers the original value.
  8783. inline std::string escape_quoted_pairs(const std::string &s) {
  8784. std::string out;
  8785. out.reserve(s.size());
  8786. for (auto c : s) {
  8787. if (c == '\\' || c == '"') { out += '\\'; }
  8788. out += c;
  8789. }
  8790. return out;
  8791. }
  8792. // RFC 9110 Section 11.6.1 defines a challenge list as
  8793. // WWW-Authenticate = #challenge
  8794. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8795. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8796. // so a server may offer several schemes, each with its own comma-separated
  8797. // auth-param list, in either order and either as separate field lines or
  8798. // packed into one. Splitting on every comma would break apart a challenge's
  8799. // own param list; splitting only on the first space would miss a Digest
  8800. // challenge that isn't first. Split on commas that aren't inside a
  8801. // quoted-string instead (split_unquoted), then track which scheme each
  8802. // resulting segment belongs to: a segment whose text before "=" contains
  8803. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8804. // leading token.
  8805. inline bool parse_www_authenticate(const Response &res,
  8806. std::map<std::string, std::string> &auth,
  8807. bool is_proxy) {
  8808. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8809. auto combined = get_combined_header_value(res.headers, auth_key);
  8810. if (combined.empty()) { return false; }
  8811. auto found_digest = false;
  8812. auto in_digest_challenge = false;
  8813. split_unquoted(
  8814. combined.data(), combined.data() + combined.size(), ',',
  8815. [&](const char *b, const char *e) {
  8816. std::string segment(b, e);
  8817. auto eq_pos = segment.find('=');
  8818. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8819. // for the first segment of a challenge, "<scheme> <key>") must be
  8820. // trimmed before its boundaries are inspected.
  8821. auto key_part = trim_copy(
  8822. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8823. auto space_pos = key_part.find_last_of(" \t");
  8824. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8825. // "<scheme>[ <key>]" starts a new challenge.
  8826. auto scheme_end =
  8827. space_pos == std::string::npos ? key_part.size() : space_pos;
  8828. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8829. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8830. // from one challenge is never paired with another's algorithm.
  8831. in_digest_challenge =
  8832. !found_digest &&
  8833. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8834. if (in_digest_challenge) { found_digest = true; }
  8835. if (space_pos == std::string::npos) {
  8836. // Bare scheme (or a token68), no auth-param on this segment.
  8837. return;
  8838. }
  8839. key_part = key_part.substr(space_pos + 1);
  8840. }
  8841. if (!in_digest_challenge) { return; }
  8842. auto val = trim_copy(segment.substr(eq_pos + 1));
  8843. auto unquoted = trim_double_quotes_copy(val);
  8844. if (unquoted.size() != val.size()) {
  8845. unquoted = unescape_quoted_pairs(unquoted);
  8846. }
  8847. auth[std::move(key_part)] = std::move(unquoted);
  8848. });
  8849. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8850. // make_digest_authentication_header() dereferences both unconditionally, so
  8851. // a challenge missing either can't produce a usable Authorization header.
  8852. // Treat it the same as no Digest challenge at all.
  8853. return found_digest && auth.find("realm") != auth.end() &&
  8854. auth.find("nonce") != auth.end();
  8855. }
  8856. class ContentProviderAdapter {
  8857. public:
  8858. explicit ContentProviderAdapter(
  8859. ContentProviderWithoutLength &&content_provider)
  8860. : content_provider_(std::move(content_provider)) {}
  8861. bool operator()(size_t offset, size_t, DataSink &sink) {
  8862. return content_provider_(offset, sink);
  8863. }
  8864. private:
  8865. ContentProviderWithoutLength content_provider_;
  8866. };
  8867. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8868. namespace fields {
  8869. inline bool is_token_char(char c) {
  8870. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8871. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8872. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8873. }
  8874. inline bool is_token(const std::string &s) {
  8875. if (s.empty()) { return false; }
  8876. for (auto c : s) {
  8877. if (!is_token_char(c)) { return false; }
  8878. }
  8879. return true;
  8880. }
  8881. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8882. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8883. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8884. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8885. inline bool is_field_content(const std::string &s) {
  8886. if (s.empty()) { return true; }
  8887. if (s.size() == 1) {
  8888. return is_field_vchar(s[0]);
  8889. } else if (s.size() == 2) {
  8890. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8891. } else {
  8892. size_t i = 0;
  8893. if (!is_field_vchar(s[i])) { return false; }
  8894. i++;
  8895. while (i < s.size() - 1) {
  8896. auto c = s[i++];
  8897. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8898. } else {
  8899. return false;
  8900. }
  8901. }
  8902. return is_field_vchar(s[i]);
  8903. }
  8904. }
  8905. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8906. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8907. return is_field_name(name) && is_field_value(value);
  8908. }
  8909. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8910. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8911. inline bool is_request_target(const std::string &s) {
  8912. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8913. }
  8914. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8915. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8916. inline bool is_host(const std::string &s) {
  8917. return std::all_of(s.begin(), s.end(), [](char c) {
  8918. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8919. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8920. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8921. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8922. });
  8923. }
  8924. } // namespace fields
  8925. // Built in memory first, like ClientImpl::write_request, so a rejected header
  8926. // never leaves a partial request on the wire.
  8927. inline bool write_request_head(Stream &strm, Request &req, Error &error) {
  8928. BufferStream bstrm;
  8929. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8930. error = Error::Write;
  8931. return false;
  8932. }
  8933. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8934. return false;
  8935. }
  8936. const auto &data = bstrm.get_buffer();
  8937. if (!write_data(strm, data.data(), data.size())) {
  8938. error = Error::Write;
  8939. return false;
  8940. }
  8941. return true;
  8942. }
  8943. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8944. WebSocketUpgradeResponse &upgrade) {
  8945. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8946. std::string key_bytes(16, '\0');
  8947. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8948. key_bytes.size());
  8949. auto client_key = base64_encode(key_bytes);
  8950. req.headers.erase("Upgrade");
  8951. req.headers.erase("Connection");
  8952. req.headers.erase("Sec-WebSocket-Key");
  8953. req.headers.erase("Sec-WebSocket-Version");
  8954. req.headers.emplace("Upgrade", "websocket");
  8955. req.headers.emplace("Connection", "Upgrade");
  8956. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8957. req.headers.emplace("Sec-WebSocket-Version", "13");
  8958. if (!write_request_head(strm, req, upgrade.error)) { return false; }
  8959. // Verify 101 response and Sec-WebSocket-Accept header
  8960. auto expected_accept = websocket_accept_key(client_key);
  8961. auto offered_subprotocols =
  8962. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8963. return read_websocket_upgrade_response(strm, expected_accept,
  8964. offered_subprotocols, upgrade);
  8965. }
  8966. inline bool is_ip_address(const std::string &host) {
  8967. struct in_addr addr4;
  8968. struct in6_addr addr6;
  8969. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8970. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8971. }
  8972. // Resolve where a client should connect for `host`, honoring a user-supplied
  8973. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8974. // supplying the Host header and SNI; only the connection target changes.
  8975. //
  8976. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8977. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8978. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8979. // absent or empty mapping leaves `host` as the connection target; without the
  8980. // empty check the value would reach getaddrinfo as a null node and silently
  8981. // resolve to loopback.
  8982. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8983. const std::string &host, std::string &connect_host,
  8984. std::string &ip) {
  8985. connect_host = host;
  8986. ip.clear();
  8987. auto it = addr_map.find(host);
  8988. if (it == addr_map.end() || it->second.empty()) { return; }
  8989. if (is_ip_address(it->second)) {
  8990. ip = it->second;
  8991. } else {
  8992. connect_host = it->second;
  8993. }
  8994. }
  8995. } // namespace detail
  8996. /*
  8997. * Group 2: detail namespace - SSL common utilities
  8998. */
  8999. #ifdef CPPHTTPLIB_SSL_ENABLED
  9000. namespace detail {
  9001. class SSLSocketStream final : public Stream {
  9002. public:
  9003. SSLSocketStream(
  9004. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  9005. time_t read_timeout_usec, time_t write_timeout_sec,
  9006. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  9007. std::chrono::time_point<std::chrono::steady_clock> start_time =
  9008. (std::chrono::steady_clock::time_point::min)());
  9009. ~SSLSocketStream() override;
  9010. bool is_readable() const override;
  9011. bool wait_readable() const override;
  9012. bool wait_writable() const override;
  9013. bool is_peer_alive() const override;
  9014. ssize_t read(char *ptr, size_t size) override;
  9015. ssize_t write(const char *ptr, size_t size) override;
  9016. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9017. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9018. socket_t socket() const override;
  9019. time_t duration() const override;
  9020. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9021. void set_max_timeout(time_t msec) override;
  9022. void set_read_interrupt(std::function<bool()> interrupted) override;
  9023. // See SocketStream::set_readable_hint().
  9024. void set_readable_hint() { readable_hint_ = true; }
  9025. // The error from the last read() or write() that failed in the TLS layer,
  9026. // with code Success if none did
  9027. const tls::TlsError &tls_error() const { return tls_error_; }
  9028. private:
  9029. bool ensure_readable();
  9030. socket_t sock_;
  9031. tls::session_t session_;
  9032. time_t read_timeout_sec_;
  9033. time_t read_timeout_usec_;
  9034. time_t write_timeout_sec_;
  9035. time_t write_timeout_usec_;
  9036. time_t max_timeout_msec_;
  9037. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9038. std::function<bool()> read_interrupted_;
  9039. bool readable_hint_ = false;
  9040. tls::TlsError tls_error_;
  9041. };
  9042. // A TLS stream for WebSocket connections, where the receive path and the
  9043. // send path (application send() plus the heartbeat ping thread) run on
  9044. // different threads. A single TLS session must never be entered
  9045. // concurrently, so every call into the session is serialized by one mutex.
  9046. //
  9047. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  9048. // whole lifetime and each read()/write() performs a single non-blocking TLS
  9049. // call under the lock, then waits for readiness with select() outside the
  9050. // lock. The lock is therefore held only for CPU-bound work, so a reader
  9051. // blocked waiting for data never stalls a concurrent sender.
  9052. //
  9053. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  9054. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  9055. class WebSocketSSLStream final : public Stream {
  9056. public:
  9057. WebSocketSSLStream(socket_t sock, tls::session_t session,
  9058. time_t read_timeout_sec, time_t read_timeout_usec,
  9059. time_t write_timeout_sec, time_t write_timeout_usec);
  9060. ~WebSocketSSLStream() override;
  9061. bool is_readable() const override;
  9062. bool wait_readable() const override;
  9063. bool wait_writable() const override;
  9064. ssize_t read(char *ptr, size_t size) override;
  9065. ssize_t write(const char *ptr, size_t size) override;
  9066. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  9067. void get_local_ip_and_port(std::string &ip, int &port) const override;
  9068. socket_t socket() const override;
  9069. time_t duration() const override;
  9070. void set_read_timeout(time_t sec, time_t usec = 0) override;
  9071. void set_read_interrupt(std::function<bool()> interrupted) override;
  9072. private:
  9073. mutable std::mutex session_mutex_;
  9074. socket_t sock_;
  9075. tls::session_t session_;
  9076. // WebSocket::close() shortens the read timeout from the closing thread
  9077. // while the receive thread is inside wait_readable(), so these two are read
  9078. // and written concurrently. The write timeouts are never mutated.
  9079. std::atomic<time_t> read_timeout_sec_;
  9080. std::atomic<time_t> read_timeout_usec_;
  9081. time_t write_timeout_sec_;
  9082. time_t write_timeout_usec_;
  9083. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  9084. std::function<bool()> read_interrupted_;
  9085. };
  9086. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9087. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  9088. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  9089. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  9090. unsigned int hash_length = 0;
  9091. unsigned char hash[EVP_MAX_MD_SIZE];
  9092. EVP_DigestInit_ex(context.get(), algo, nullptr);
  9093. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  9094. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  9095. std::stringstream ss;
  9096. for (auto i = 0u; i < hash_length; ++i) {
  9097. ss << std::hex << std::setw(2) << std::setfill('0')
  9098. << static_cast<unsigned int>(hash[i]);
  9099. }
  9100. return ss.str();
  9101. }
  9102. inline std::string MD5(const std::string &s) {
  9103. return message_digest(s, EVP_md5());
  9104. }
  9105. inline std::string SHA_256(const std::string &s) {
  9106. return message_digest(s, EVP_sha256());
  9107. }
  9108. inline std::string SHA_512(const std::string &s) {
  9109. return message_digest(s, EVP_sha512());
  9110. }
  9111. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9112. namespace {
  9113. template <size_t N>
  9114. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9115. std::stringstream ss;
  9116. for (size_t i = 0; i < N; ++i) {
  9117. ss << std::hex << std::setw(2) << std::setfill('0')
  9118. << static_cast<unsigned int>(hash[i]);
  9119. }
  9120. return ss.str();
  9121. }
  9122. } // namespace
  9123. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9124. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9125. // initialized once. PSA state is process-global; do not free it.
  9126. inline bool ensure_mbedtls_psa_crypto() {
  9127. static std::once_flag once;
  9128. static bool ok = false;
  9129. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9130. return ok;
  9131. }
  9132. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9133. unsigned char *out, size_t out_size) {
  9134. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9135. size_t olen = 0;
  9136. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9137. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9138. olen == out_size;
  9139. }
  9140. #endif
  9141. inline std::string MD5(const std::string &s) {
  9142. unsigned char hash[16];
  9143. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9144. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9145. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9146. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9147. hash);
  9148. #else
  9149. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9150. hash);
  9151. #endif
  9152. return hash_to_hex(hash);
  9153. }
  9154. inline std::string SHA_256(const std::string &s) {
  9155. unsigned char hash[32];
  9156. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9157. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9158. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9159. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9160. hash, 0);
  9161. #else
  9162. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9163. s.size(), hash, 0);
  9164. #endif
  9165. return hash_to_hex(hash);
  9166. }
  9167. inline std::string SHA_512(const std::string &s) {
  9168. unsigned char hash[64];
  9169. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9170. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9171. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9172. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9173. hash, 0);
  9174. #else
  9175. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9176. s.size(), hash, 0);
  9177. #endif
  9178. return hash_to_hex(hash);
  9179. }
  9180. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9181. namespace {
  9182. template <size_t N>
  9183. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9184. std::stringstream ss;
  9185. for (size_t i = 0; i < N; ++i) {
  9186. ss << std::hex << std::setw(2) << std::setfill('0')
  9187. << static_cast<unsigned int>(hash[i]);
  9188. }
  9189. return ss.str();
  9190. }
  9191. } // namespace
  9192. inline std::string MD5(const std::string &s) {
  9193. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9194. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9195. static_cast<word32>(s.size()), hash);
  9196. return hash_to_hex(hash);
  9197. }
  9198. inline std::string SHA_256(const std::string &s) {
  9199. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9200. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9201. static_cast<word32>(s.size()), hash);
  9202. return hash_to_hex(hash);
  9203. }
  9204. inline std::string SHA_512(const std::string &s) {
  9205. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9206. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9207. static_cast<word32>(s.size()), hash);
  9208. return hash_to_hex(hash);
  9209. }
  9210. #endif
  9211. template <typename T>
  9212. inline bool process_server_socket_ssl(
  9213. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9214. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9215. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9216. time_t write_timeout_usec, T callback) {
  9217. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9218. // of a pipelined request, which keep_alive() cannot see on the socket.
  9219. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9220. write_timeout_sec, write_timeout_usec);
  9221. return process_server_socket_core(
  9222. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9223. [&]() { return strm.is_readable(); },
  9224. [&](bool socket_readable, bool close_connection,
  9225. bool &connection_closed) {
  9226. if (socket_readable) { strm.set_readable_hint(); }
  9227. return callback(strm, close_connection, connection_closed);
  9228. });
  9229. }
  9230. template <typename T>
  9231. inline bool process_client_socket_ssl(
  9232. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9233. time_t read_timeout_usec, time_t write_timeout_sec,
  9234. time_t write_timeout_usec, time_t max_timeout_msec,
  9235. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9236. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9237. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9238. start_time);
  9239. return callback(strm);
  9240. }
  9241. // `uri` is req's request-target in origin form, as curl sends it, also when
  9242. // the request line carries the absolute form for a proxy.
  9243. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9244. const Request &req, const std::string &uri,
  9245. const std::map<std::string, std::string> &auth, size_t cnonce_count,
  9246. const std::string &cnonce, const std::string &username,
  9247. const std::string &password, bool is_proxy = false) {
  9248. std::string nc;
  9249. {
  9250. std::stringstream ss;
  9251. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9252. nc = ss.str();
  9253. }
  9254. std::string qop;
  9255. if (auth.find("qop") != auth.end()) {
  9256. qop = auth.at("qop");
  9257. if (qop.find("auth-int") != std::string::npos) {
  9258. qop = "auth-int";
  9259. } else if (qop.find("auth") != std::string::npos) {
  9260. qop = "auth";
  9261. } else {
  9262. qop.clear();
  9263. }
  9264. }
  9265. std::string algo = "MD5";
  9266. if (auth.find("algorithm") != auth.end()) {
  9267. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9268. // not a token would otherwise be emitted verbatim and could carry commas
  9269. // or quotes that inject further auth-params into the header below.
  9270. const auto &a = auth.at("algorithm");
  9271. if (fields::is_token(a)) { algo = a; }
  9272. }
  9273. std::string response;
  9274. {
  9275. auto H = algo == "SHA-256" ? detail::SHA_256
  9276. : algo == "SHA-512" ? detail::SHA_512
  9277. : detail::MD5;
  9278. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9279. auto A2 = req.method + ":" + uri;
  9280. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9281. if (qop.empty()) {
  9282. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9283. } else {
  9284. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9285. ":" + qop + ":" + H(A2));
  9286. }
  9287. }
  9288. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9289. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9290. // close the string early. realm, nonce and opaque come straight from the
  9291. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9292. // without this a crafted challenge injects extra auth-params into the header.
  9293. auto field =
  9294. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9295. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9296. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9297. "\", uri=\"" + detail::escape_quoted_pairs(uri) +
  9298. "\", algorithm=" + algo +
  9299. (qop.empty() ? ", response=\""
  9300. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9301. "\", response=\"") +
  9302. response + "\"" +
  9303. (opaque.empty()
  9304. ? ""
  9305. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9306. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9307. return std::make_pair(key, field);
  9308. }
  9309. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9310. // backend accepts the same names.
  9311. inline bool match_hostname(const std::string &pattern,
  9312. const std::string &hostname) {
  9313. // A trailing dot on the host is ignored
  9314. auto host = hostname;
  9315. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9316. // Exact match (case-insensitive)
  9317. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9318. // Split both pattern and hostname into components by '.', keeping any empty
  9319. // one, which no name may have
  9320. auto labels = [](const std::string &s) {
  9321. std::vector<std::string> v;
  9322. size_t b = 0;
  9323. while (true) {
  9324. auto e = s.find('.', b);
  9325. v.push_back(s.substr(b, e - b));
  9326. if (e == std::string::npos) { return v; }
  9327. b = e + 1;
  9328. }
  9329. };
  9330. auto pattern_components = labels(pattern);
  9331. auto host_components = labels(host);
  9332. auto has_empty_label = [](const std::vector<std::string> &v) {
  9333. return std::any_of(v.begin(), v.end(),
  9334. [](const std::string &l) { return l.empty(); });
  9335. };
  9336. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9337. return false;
  9338. }
  9339. // Component count must match
  9340. if (host_components.size() != pattern_components.size()) { return false; }
  9341. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9342. // and an IDNA label may not have one
  9343. const auto &leftmost = pattern_components.front();
  9344. if (leftmost.find('*') != std::string::npos &&
  9345. (pattern_components.size() < 3 ||
  9346. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9347. return false;
  9348. }
  9349. // Compare each component with wildcard support
  9350. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9351. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9352. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9353. auto itr = pattern_components.begin();
  9354. for (const auto &h : host_components) {
  9355. auto &p = *itr;
  9356. auto is_leftmost = itr == pattern_components.begin();
  9357. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9358. bool partial_match = false;
  9359. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9360. const auto prefix_length = p.size() - 1;
  9361. if (prefix_length == 0) {
  9362. partial_match = true;
  9363. } else if (h.size() >= prefix_length) {
  9364. partial_match =
  9365. std::equal(p.begin(),
  9366. p.begin() + static_cast<std::string::difference_type>(
  9367. prefix_length),
  9368. h.begin(), [](const char ca, const char cb) {
  9369. return detail::case_ignore::to_lower(ca) ==
  9370. detail::case_ignore::to_lower(cb);
  9371. });
  9372. }
  9373. }
  9374. if (!partial_match) { return false; }
  9375. }
  9376. ++itr;
  9377. }
  9378. return true;
  9379. }
  9380. #ifdef _WIN32
  9381. // Verify certificate using Windows CertGetCertificateChain API.
  9382. // This provides real-time certificate validation with Windows Update
  9383. // integration, independent of the TLS backend.
  9384. inline bool verify_cert_with_windows_schannel(
  9385. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9386. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9387. if (der_cert.empty()) { return false; }
  9388. out_error = 0;
  9389. // Create Windows certificate context from DER data
  9390. auto cert_context = CertCreateCertificateContext(
  9391. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9392. static_cast<DWORD>(der_cert.size()));
  9393. if (!cert_context) {
  9394. out_error = GetLastError();
  9395. return false;
  9396. }
  9397. auto cert_guard =
  9398. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9399. // Give CryptoAPI the certificates the server sent. Without them it follows
  9400. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9401. std::vector<tls::cert_t> peer_certs;
  9402. tls::get_peer_certs(session, peer_certs);
  9403. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9404. auto store_guard = scope_exit([&] {
  9405. for (auto cert : peer_certs) {
  9406. tls::free_cert(cert);
  9407. }
  9408. if (store) { CertCloseStore(store, 0); }
  9409. });
  9410. for (auto cert : peer_certs) {
  9411. std::vector<unsigned char> der;
  9412. if (store && tls::get_cert_der(cert, der)) {
  9413. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9414. static_cast<DWORD>(der.size()),
  9415. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9416. }
  9417. }
  9418. // Setup chain parameters
  9419. CERT_CHAIN_PARA chain_para = {};
  9420. chain_para.cbSize = sizeof(chain_para);
  9421. // Require the server authentication usage along the chain, which also
  9422. // rejects roots that Windows trusts only for other purposes.
  9423. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9424. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9425. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9426. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9427. // Build certificate chain with revocation checking
  9428. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9429. auto chain_result = CertGetCertificateChain(
  9430. nullptr, cert_context, nullptr, store, &chain_para,
  9431. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9432. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9433. nullptr, &chain_context);
  9434. if (!chain_result || !chain_context) {
  9435. out_error = GetLastError();
  9436. return false;
  9437. }
  9438. auto chain_guard =
  9439. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9440. // Verify SSL policy
  9441. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9442. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9443. #ifdef AUTHTYPE_SERVER
  9444. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9445. #endif
  9446. std::wstring whost;
  9447. if (verify_hostname) {
  9448. whost = u8string_to_wstring(hostname.c_str());
  9449. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9450. }
  9451. CERT_CHAIN_POLICY_PARA policy_para = {};
  9452. policy_para.cbSize = sizeof(policy_para);
  9453. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9454. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9455. #else
  9456. policy_para.dwFlags = 0;
  9457. #endif
  9458. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9459. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9460. policy_status.cbSize = sizeof(policy_status);
  9461. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9462. &policy_para, &policy_status)) {
  9463. out_error = GetLastError();
  9464. return false;
  9465. }
  9466. if (policy_status.dwError != 0) {
  9467. out_error = policy_status.dwError;
  9468. return false;
  9469. }
  9470. return true;
  9471. }
  9472. #endif // _WIN32
  9473. // Loads CA file/dir configuration and applies the system CA policy to a
  9474. // client TLS context. PEM data and native stores are applied to the context
  9475. // directly at set time; has_custom_store reflects them for the Auto policy
  9476. // decision.
  9477. inline bool load_client_ca_config(tls::ctx_t ctx,
  9478. const std::string &ca_cert_file_path,
  9479. const std::string &ca_cert_dir_path,
  9480. bool has_custom_store, SystemCAMode mode,
  9481. uint64_t &backend_error) {
  9482. auto ret = true;
  9483. if (!ca_cert_file_path.empty()) {
  9484. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9485. backend_error = tls::get_error();
  9486. ret = false;
  9487. }
  9488. } else if (!ca_cert_dir_path.empty()) {
  9489. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9490. backend_error = tls::get_error();
  9491. ret = false;
  9492. }
  9493. }
  9494. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9495. !ca_cert_dir_path.empty() || has_custom_store;
  9496. if (mode == SystemCAMode::Enabled ||
  9497. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9498. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9499. }
  9500. return ret;
  9501. }
  9502. // Serializes the CA certificates installed in ctx as PEM, so they can be
  9503. // loaded into another context.
  9504. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9505. std::string pem;
  9506. std::vector<tls::cert_t> certs;
  9507. tls::get_ca_certs(ctx, certs);
  9508. for (auto cert : certs) {
  9509. std::vector<unsigned char> der;
  9510. if (tls::get_cert_der(cert, der)) {
  9511. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9512. pem += "-----BEGIN CERTIFICATE-----\n";
  9513. for (size_t i = 0; i < b64.size(); i += 64) {
  9514. pem += b64.substr(i, 64);
  9515. pem += '\n';
  9516. }
  9517. pem += "-----END CERTIFICATE-----\n";
  9518. }
  9519. tls::free_cert(cert);
  9520. }
  9521. return pem;
  9522. }
  9523. // Returns a PemMemory field as a NUL-terminated string: its first len bytes,
  9524. // copied to buf, or pem itself when len is 0.
  9525. inline const char *pem_c_str(const char *pem, size_t len, std::string &buf) {
  9526. if (!pem || len == 0) { return pem; }
  9527. buf.assign(pem, len);
  9528. return buf.c_str();
  9529. }
  9530. // The parts of session setup that only SSLClient needs, plus the handful
  9531. // WebSocketClient also exposes; everything else takes the defaults, which is
  9532. // what keeps the two clients on one implementation.
  9533. struct ClientTlsSessionOptions {
  9534. // Both SSLClient and WebSocketClient expose this independently of
  9535. // certificate verification.
  9536. bool server_hostname_verification = true;
  9537. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9538. // When non-null, guards session creation against concurrent use of the
  9539. // context. A WebSocketClient is not safe to use from several threads to
  9540. // begin with, so it passes nothing.
  9541. std::mutex *ctx_mutex = nullptr;
  9542. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9543. // The caller decides whether Schannel has anything to say about this
  9544. // connection; see SSLClient::initialize_ssl().
  9545. bool windows_cert_verification = false;
  9546. // A server certificate verifier works on the backend's chain verification,
  9547. // so the backend keeps deciding and Schannel only adds its own check.
  9548. bool server_certificate_verifier_set = false;
  9549. #endif
  9550. };
  9551. // Filled in on failure for callers that report error details.
  9552. struct ClientTlsSessionError {
  9553. Error error = Error::Success;
  9554. int ssl_error = 0;
  9555. uint64_t backend_error = 0;
  9556. };
  9557. // Establishes a client TLS session on an already connected socket. On failure
  9558. // the session is left for the caller to free: SSLClient frees it right away,
  9559. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9560. inline bool setup_client_tls_session(
  9561. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9562. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9563. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9564. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9565. using namespace tls;
  9566. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9567. if (out_error) {
  9568. out_error->error = error;
  9569. out_error->ssl_error = ssl_error;
  9570. out_error->backend_error = backend_error;
  9571. }
  9572. return false;
  9573. };
  9574. // A TLS failure, whose verification codes name the Error too
  9575. auto fail_tls = [&](ErrorCode code, uint64_t backend_error) {
  9576. auto error = Error::SSLConnection;
  9577. if (code == ErrorCode::CertVerifyFailed) {
  9578. error = Error::SSLServerVerification;
  9579. } else if (code == ErrorCode::HostnameMismatch) {
  9580. error = Error::SSLServerHostnameVerification;
  9581. }
  9582. return fail(error, static_cast<int>(code), backend_error);
  9583. };
  9584. if (!ctx) {
  9585. session = nullptr;
  9586. return fail(Error::SSLConnection, 0, 0);
  9587. }
  9588. // With Windows verification on and no server certificate verifier set,
  9589. // Schannel is the only chain verifier. The backend's trust store is a
  9590. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9591. // demand, so the backend's verdict is not used.
  9592. auto windows_verifies_chain = false;
  9593. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9594. windows_verifies_chain = options.windows_cert_verification &&
  9595. !options.server_certificate_verifier_set;
  9596. #endif
  9597. // The chain, and a host name, are verified during the handshake, so that a
  9598. // server failing them never gets to see a client certificate. Unless
  9599. // Schannel verifies the chain instead, this holds for IP hosts too, whose
  9600. // identity is checked after the handshake by verify_hostname().
  9601. auto verify_in_handshake =
  9602. server_certificate_verification && !windows_verifies_chain;
  9603. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  9604. // A session verifier may accept a certificate the built-in check rejects,
  9605. // and runs only after the handshake
  9606. verify_in_handshake = verify_in_handshake && !options.session_verifier;
  9607. #endif
  9608. {
  9609. std::unique_lock<std::mutex> guard;
  9610. if (options.ctx_mutex) {
  9611. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9612. }
  9613. // The mode is set on the context, so under the same lock
  9614. set_verify_client(ctx, verify_in_handshake);
  9615. session = create_session(ctx, sock);
  9616. }
  9617. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9618. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9619. // their identity is checked post-handshake below instead.
  9620. if (!is_ip_address(host)) {
  9621. if (!set_sni(session, host.c_str(),
  9622. verify_in_handshake && options.server_hostname_verification)) {
  9623. return fail(Error::SSLConnection, 0, get_error());
  9624. }
  9625. }
  9626. TlsError tls_err;
  9627. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9628. &tls_err)) {
  9629. return fail_tls(tls_err.code, tls_err.backend_code);
  9630. }
  9631. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9632. if (options.session_verifier) {
  9633. verification_status = options.session_verifier(session);
  9634. }
  9635. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9636. return fail(Error::SSLServerVerification, 0, get_error());
  9637. }
  9638. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9639. server_certificate_verification) {
  9640. if (!windows_verifies_chain) {
  9641. auto verify_result = get_verify_result(session);
  9642. if (verify_result != 0) {
  9643. return fail_tls(ErrorCode::CertVerifyFailed,
  9644. static_cast<uint64_t>(verify_result));
  9645. }
  9646. }
  9647. auto server_cert = get_peer_cert(session);
  9648. if (!server_cert) {
  9649. return fail_tls(ErrorCode::CertVerifyFailed, get_error());
  9650. }
  9651. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9652. // Identity check against the peer certificate, post-handshake for all
  9653. // backends. For IP hosts this is the only identity verification, since no
  9654. // hostname is bound during the handshake.
  9655. if (options.server_hostname_verification) {
  9656. if (!verify_hostname(server_cert, host.c_str())) {
  9657. return fail_tls(ErrorCode::HostnameMismatch, hostname_mismatch_code());
  9658. }
  9659. }
  9660. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9661. // Windows Schannel verification, which lets Windows fetch missing roots
  9662. // and intermediates on demand. It must not be skipped: unless a server
  9663. // certificate verifier is set, it is the only chain check.
  9664. if (options.windows_cert_verification) {
  9665. std::vector<unsigned char> der;
  9666. uint64_t wincrypt_error = 0;
  9667. if (!get_cert_der(server_cert, der) ||
  9668. !verify_cert_with_windows_schannel(
  9669. der, host, options.server_hostname_verification, wincrypt_error,
  9670. session)) {
  9671. return fail_tls(ErrorCode::CertVerifyFailed, wincrypt_error);
  9672. }
  9673. }
  9674. #endif
  9675. }
  9676. return true;
  9677. }
  9678. } // namespace detail
  9679. #endif // CPPHTTPLIB_SSL_ENABLED
  9680. /*
  9681. * Group 3: httplib namespace - Non-SSL public API implementations
  9682. */
  9683. inline void default_socket_options(socket_t sock) {
  9684. set_socket_opt(sock, SOL_SOCKET,
  9685. #ifdef SO_REUSEPORT
  9686. SO_REUSEPORT,
  9687. #else
  9688. SO_REUSEADDR,
  9689. #endif
  9690. 1);
  9691. }
  9692. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9693. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9694. sizeof(optval));
  9695. }
  9696. inline std::string get_bearer_token_auth(const Request &req) {
  9697. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9698. // than the prefix carries no token.
  9699. constexpr const char bearer_prefix[] = "Bearer ";
  9700. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9701. auto value = req.get_header_value("Authorization");
  9702. if (value.size() >= bearer_prefix_len &&
  9703. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9704. bearer_prefix)) {
  9705. return value.substr(bearer_prefix_len);
  9706. }
  9707. return "";
  9708. }
  9709. inline const char *status_message(int status) {
  9710. switch (status) {
  9711. case StatusCode::Continue_100: return "Continue";
  9712. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9713. case StatusCode::Processing_102: return "Processing";
  9714. case StatusCode::EarlyHints_103: return "Early Hints";
  9715. case StatusCode::OK_200: return "OK";
  9716. case StatusCode::Created_201: return "Created";
  9717. case StatusCode::Accepted_202: return "Accepted";
  9718. case StatusCode::NonAuthoritativeInformation_203:
  9719. return "Non-Authoritative Information";
  9720. case StatusCode::NoContent_204: return "No Content";
  9721. case StatusCode::ResetContent_205: return "Reset Content";
  9722. case StatusCode::PartialContent_206: return "Partial Content";
  9723. case StatusCode::MultiStatus_207: return "Multi-Status";
  9724. case StatusCode::AlreadyReported_208: return "Already Reported";
  9725. case StatusCode::IMUsed_226: return "IM Used";
  9726. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9727. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9728. case StatusCode::Found_302: return "Found";
  9729. case StatusCode::SeeOther_303: return "See Other";
  9730. case StatusCode::NotModified_304: return "Not Modified";
  9731. case StatusCode::UseProxy_305: return "Use Proxy";
  9732. case StatusCode::unused_306: return "unused";
  9733. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9734. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9735. case StatusCode::BadRequest_400: return "Bad Request";
  9736. case StatusCode::Unauthorized_401: return "Unauthorized";
  9737. case StatusCode::PaymentRequired_402: return "Payment Required";
  9738. case StatusCode::Forbidden_403: return "Forbidden";
  9739. case StatusCode::NotFound_404: return "Not Found";
  9740. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9741. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9742. case StatusCode::ProxyAuthenticationRequired_407:
  9743. return "Proxy Authentication Required";
  9744. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9745. case StatusCode::Conflict_409: return "Conflict";
  9746. case StatusCode::Gone_410: return "Gone";
  9747. case StatusCode::LengthRequired_411: return "Length Required";
  9748. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9749. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9750. case StatusCode::UriTooLong_414: return "URI Too Long";
  9751. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9752. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9753. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9754. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9755. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9756. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9757. case StatusCode::Locked_423: return "Locked";
  9758. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9759. case StatusCode::TooEarly_425: return "Too Early";
  9760. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9761. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9762. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9763. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9764. return "Request Header Fields Too Large";
  9765. case StatusCode::UnavailableForLegalReasons_451:
  9766. return "Unavailable For Legal Reasons";
  9767. case StatusCode::NotImplemented_501: return "Not Implemented";
  9768. case StatusCode::BadGateway_502: return "Bad Gateway";
  9769. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9770. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9771. case StatusCode::HttpVersionNotSupported_505:
  9772. return "HTTP Version Not Supported";
  9773. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9774. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9775. case StatusCode::LoopDetected_508: return "Loop Detected";
  9776. case StatusCode::NotExtended_510: return "Not Extended";
  9777. case StatusCode::NetworkAuthenticationRequired_511:
  9778. return "Network Authentication Required";
  9779. default:
  9780. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9781. }
  9782. }
  9783. inline std::string to_string(const Error error) {
  9784. switch (error) {
  9785. case Error::Success: return "Success (no error)";
  9786. case Error::Unknown: return "Unknown";
  9787. case Error::Connection: return "Could not establish connection";
  9788. case Error::BindIPAddress: return "Failed to bind IP address";
  9789. case Error::Read: return "Failed to read connection";
  9790. case Error::Write: return "Failed to write connection";
  9791. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9792. case Error::Canceled: return "Connection handling canceled";
  9793. case Error::SSLConnection: return "SSL connection failed";
  9794. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9795. case Error::SSLServerVerification: return "SSL server verification failed";
  9796. case Error::SSLServerHostnameVerification:
  9797. return "SSL server hostname verification failed";
  9798. case Error::UnsupportedMultipartBoundaryChars:
  9799. return "Unsupported HTTP multipart boundary characters";
  9800. case Error::Compression: return "Compression failed";
  9801. case Error::ConnectionTimeout: return "Connection timed out";
  9802. case Error::ProxyConnection: return "Proxy connection failed";
  9803. case Error::ConnectionClosed: return "Connection closed by server";
  9804. case Error::Timeout: return "Read timeout";
  9805. case Error::ResourceExhaustion: return "Resource exhaustion";
  9806. case Error::TooManyFormDataFiles: return "Too many form data files";
  9807. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9808. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9809. case Error::ExceedMaxSocketDescriptorCount:
  9810. return "Exceeded maximum socket descriptor count";
  9811. case Error::InvalidRequestLine: return "Invalid request line";
  9812. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9813. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9814. case Error::InvalidHeaders: return "Invalid headers";
  9815. case Error::MultipartParsing: return "Multipart parsing failed";
  9816. case Error::OpenFile: return "Failed to open file";
  9817. case Error::Listen: return "Failed to listen on socket";
  9818. case Error::GetSockName: return "Failed to get socket name";
  9819. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9820. case Error::HTTPParsing: return "HTTP parsing failed";
  9821. case Error::InvalidRangeHeader: return "Invalid Range header";
  9822. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9823. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9824. case Error::UserCallbackException: return "User callback threw an exception";
  9825. default: break;
  9826. }
  9827. return "Invalid";
  9828. }
  9829. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9830. os << to_string(obj);
  9831. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9832. return os;
  9833. }
  9834. inline std::string hosted_at(const std::string &hostname) {
  9835. std::vector<std::string> addrs;
  9836. hosted_at(hostname, addrs);
  9837. if (addrs.empty()) { return std::string(); }
  9838. return addrs[0];
  9839. }
  9840. inline void hosted_at(const std::string &hostname,
  9841. std::vector<std::string> &addrs) {
  9842. struct addrinfo hints;
  9843. struct addrinfo *result;
  9844. memset(&hints, 0, sizeof(struct addrinfo));
  9845. hints.ai_family = AF_UNSPEC;
  9846. hints.ai_socktype = SOCK_STREAM;
  9847. hints.ai_protocol = 0;
  9848. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9849. &result, 0)) {
  9850. #if defined __linux__ && !defined __ANDROID__
  9851. res_init();
  9852. #endif
  9853. return;
  9854. }
  9855. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9856. for (auto rp = result; rp; rp = rp->ai_next) {
  9857. const auto &addr =
  9858. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9859. std::string ip;
  9860. auto dummy = -1;
  9861. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9862. dummy)) {
  9863. addrs.emplace_back(std::move(ip));
  9864. }
  9865. }
  9866. }
  9867. inline std::string encode_uri_component(const std::string &value) {
  9868. std::ostringstream escaped;
  9869. escaped.fill('0');
  9870. escaped << std::hex;
  9871. for (auto c : value) {
  9872. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9873. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9874. escaped << c;
  9875. } else {
  9876. escaped << std::uppercase;
  9877. escaped << '%' << std::setw(2)
  9878. << static_cast<int>(static_cast<unsigned char>(c));
  9879. escaped << std::nouppercase;
  9880. }
  9881. }
  9882. return escaped.str();
  9883. }
  9884. inline std::string encode_uri(const std::string &value) {
  9885. std::ostringstream escaped;
  9886. escaped.fill('0');
  9887. escaped << std::hex;
  9888. for (auto c : value) {
  9889. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9890. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9891. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9892. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9893. escaped << c;
  9894. } else {
  9895. escaped << std::uppercase;
  9896. escaped << '%' << std::setw(2)
  9897. << static_cast<int>(static_cast<unsigned char>(c));
  9898. escaped << std::nouppercase;
  9899. }
  9900. }
  9901. return escaped.str();
  9902. }
  9903. inline std::string decode_uri_component(const std::string &value) {
  9904. std::string result;
  9905. for (size_t i = 0; i < value.size(); i++) {
  9906. if (value[i] == '%' && i + 2 < value.size()) {
  9907. auto val = 0;
  9908. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9909. result += static_cast<char>(val);
  9910. i += 2;
  9911. } else {
  9912. result += value[i];
  9913. }
  9914. } else {
  9915. result += value[i];
  9916. }
  9917. }
  9918. return result;
  9919. }
  9920. inline std::string decode_uri(const std::string &value) {
  9921. std::string result;
  9922. for (size_t i = 0; i < value.size(); i++) {
  9923. if (value[i] == '%' && i + 2 < value.size()) {
  9924. auto val = 0;
  9925. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9926. auto c = static_cast<char>(val);
  9927. // Keep escapes of the reserved characters that encode_uri leaves
  9928. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9929. // delimiter is not promoted into a real one (as with JS decodeURI).
  9930. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9931. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9932. c == '#') {
  9933. result += value[i];
  9934. result += value[i + 1];
  9935. result += value[i + 2];
  9936. } else {
  9937. result += c;
  9938. }
  9939. i += 2;
  9940. } else {
  9941. result += value[i];
  9942. }
  9943. } else {
  9944. result += value[i];
  9945. }
  9946. }
  9947. return result;
  9948. }
  9949. inline std::string encode_path_component(const std::string &component) {
  9950. std::string result;
  9951. result.reserve(component.size() * 3);
  9952. for (size_t i = 0; i < component.size(); i++) {
  9953. auto c = static_cast<unsigned char>(component[i]);
  9954. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9955. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9956. c == '_' || c == '~') {
  9957. result += static_cast<char>(c);
  9958. }
  9959. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9960. // "," / ";" / "="
  9961. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9962. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9963. c == '=') {
  9964. result += static_cast<char>(c);
  9965. }
  9966. // Colon is allowed in path segments except first segment
  9967. else if (c == ':') {
  9968. result += static_cast<char>(c);
  9969. }
  9970. // @ is allowed in path
  9971. else if (c == '@') {
  9972. result += static_cast<char>(c);
  9973. } else {
  9974. result += '%';
  9975. char hex[3];
  9976. snprintf(hex, sizeof(hex), "%02X", c);
  9977. result.append(hex, 2);
  9978. }
  9979. }
  9980. return result;
  9981. }
  9982. inline std::string decode_path_component(const std::string &component) {
  9983. std::string result;
  9984. result.reserve(component.size());
  9985. for (size_t i = 0; i < component.size(); i++) {
  9986. if (component[i] == '%' && i + 1 < component.size()) {
  9987. if (component[i + 1] == 'u') {
  9988. // Unicode %uXXXX encoding
  9989. auto val = 0;
  9990. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9991. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9992. char buff[4];
  9993. size_t len = 0;
  9994. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9995. (len = detail::to_utf8(val, buff)) > 0) {
  9996. result.append(buff, len);
  9997. i += 5; // 'u0000'
  9998. } else {
  9999. // Not 4 hex digits, or a surrogate, which is no character: the
  10000. // escape is kept as it is rather than joining its neighbours
  10001. result += component[i];
  10002. }
  10003. } else {
  10004. // Standard %XX encoding
  10005. auto val = 0;
  10006. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10007. // 2 digits hex codes
  10008. result += static_cast<char>(val);
  10009. i += 2; // 'XX'
  10010. } else {
  10011. result += component[i];
  10012. }
  10013. }
  10014. } else {
  10015. result += component[i];
  10016. }
  10017. }
  10018. return result;
  10019. }
  10020. inline std::string encode_query_component(const std::string &component,
  10021. bool space_as_plus) {
  10022. std::string result;
  10023. result.reserve(component.size() * 3);
  10024. for (size_t i = 0; i < component.size(); i++) {
  10025. auto c = static_cast<unsigned char>(component[i]);
  10026. // Unreserved characters per RFC 3986
  10027. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  10028. c == '_' || c == '~') {
  10029. result += static_cast<char>(c);
  10030. }
  10031. // Space handling
  10032. else if (c == ' ') {
  10033. if (space_as_plus) {
  10034. result += '+';
  10035. } else {
  10036. result += "%20";
  10037. }
  10038. }
  10039. // Plus sign handling
  10040. else if (c == '+') {
  10041. if (space_as_plus) {
  10042. result += "%2B";
  10043. } else {
  10044. result += static_cast<char>(c);
  10045. }
  10046. }
  10047. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  10048. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  10049. c == '*' || c == ',' || c == ';') {
  10050. result += static_cast<char>(c);
  10051. }
  10052. // Colon and @ are allowed in query
  10053. else if (c == ':' || c == '@') {
  10054. result += static_cast<char>(c);
  10055. }
  10056. // Forward slash is allowed in query values
  10057. else if (c == '/') {
  10058. result += static_cast<char>(c);
  10059. }
  10060. // Question mark is allowed in query values (after first ?)
  10061. else if (c == '?') {
  10062. result += static_cast<char>(c);
  10063. } else {
  10064. result += '%';
  10065. char hex[3];
  10066. snprintf(hex, sizeof(hex), "%02X", c);
  10067. result.append(hex, 2);
  10068. }
  10069. }
  10070. return result;
  10071. }
  10072. inline std::string decode_query_component(const std::string &component,
  10073. bool plus_as_space) {
  10074. std::string result;
  10075. result.reserve(component.size());
  10076. for (size_t i = 0; i < component.size(); i++) {
  10077. if (component[i] == '%' && i + 2 < component.size()) {
  10078. auto val = 0;
  10079. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  10080. result += static_cast<char>(val);
  10081. i += 2;
  10082. } else {
  10083. result += component[i];
  10084. }
  10085. } else if (component[i] == '+' && plus_as_space) {
  10086. result += ' '; // + becomes space in form-urlencoded
  10087. } else {
  10088. result += component[i];
  10089. }
  10090. }
  10091. return result;
  10092. }
  10093. inline std::string sanitize_filename(const std::string &filename) {
  10094. // Extract basename: find the last path separator (/ or \)
  10095. auto pos = filename.find_last_of("/\\");
  10096. auto result =
  10097. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  10098. // Strip null bytes
  10099. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  10100. // Trim whitespace
  10101. {
  10102. auto start = result.find_first_not_of(" \t");
  10103. auto end = result.find_last_not_of(" \t");
  10104. result = (start == std::string::npos)
  10105. ? ""
  10106. : result.substr(start, end - start + 1);
  10107. }
  10108. // Reject . and ..
  10109. if (result == "." || result == "..") { return ""; }
  10110. return result;
  10111. }
  10112. inline std::string append_query_params(const std::string &path,
  10113. const Params &params) {
  10114. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  10115. auto fragment_pos = path.find('#');
  10116. auto path_with_query = path.substr(0, fragment_pos);
  10117. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10118. path_with_query += detail::params_to_query_str(params);
  10119. if (fragment_pos != std::string::npos) {
  10120. path_with_query.append(path, fragment_pos, std::string::npos);
  10121. }
  10122. return path_with_query;
  10123. }
  10124. // Header utilities
  10125. inline std::pair<std::string, std::string>
  10126. make_range_header(const Ranges &ranges) {
  10127. std::string field = "bytes=";
  10128. auto i = 0;
  10129. for (const auto &r : ranges) {
  10130. if (i != 0) { field += ", "; }
  10131. if (r.first != -1) { field += std::to_string(r.first); }
  10132. field += '-';
  10133. if (r.second != -1) { field += std::to_string(r.second); }
  10134. i++;
  10135. }
  10136. return std::make_pair("Range", std::move(field));
  10137. }
  10138. inline std::pair<std::string, std::string>
  10139. make_basic_authentication_header(const std::string &username,
  10140. const std::string &password, bool is_proxy) {
  10141. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10142. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10143. return std::make_pair(key, std::move(field));
  10144. }
  10145. inline std::pair<std::string, std::string>
  10146. make_bearer_token_authentication_header(const std::string &token,
  10147. bool is_proxy = false) {
  10148. auto field = "Bearer " + token;
  10149. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10150. return std::make_pair(key, std::move(field));
  10151. }
  10152. namespace detail {
  10153. // Basic auth when a username or password is set, otherwise a bearer token,
  10154. // unless the request already carries the header.
  10155. inline void add_authorization_header(Request &req, const std::string &username,
  10156. const std::string &password,
  10157. const std::string &token, bool is_proxy) {
  10158. if (req.has_header(is_proxy ? "Proxy-Authorization" : "Authorization")) {
  10159. return;
  10160. }
  10161. if (!username.empty() || !password.empty()) {
  10162. req.headers.insert(
  10163. make_basic_authentication_header(username, password, is_proxy));
  10164. } else if (!token.empty()) {
  10165. req.headers.insert(
  10166. make_bearer_token_authentication_header(token, is_proxy));
  10167. }
  10168. }
  10169. } // namespace detail
  10170. // Request implementation
  10171. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10172. size_t id) const {
  10173. return detail::get_header_value_u64(headers, key, def, id);
  10174. }
  10175. inline bool Request::has_header(const std::string &key) const {
  10176. return detail::has_header(headers, key);
  10177. }
  10178. inline std::string Request::get_header_value(const std::string &key,
  10179. const char *def, size_t id) const {
  10180. return detail::get_header_value(headers, key, def, id);
  10181. }
  10182. inline size_t Request::get_header_value_count(const std::string &key) const {
  10183. return detail::get_header_value_count(headers, key);
  10184. }
  10185. inline void Request::set_header(const std::string &key,
  10186. const std::string &val) {
  10187. detail::set_header(headers, key, val);
  10188. }
  10189. inline bool Request::has_trailer(const std::string &key) const {
  10190. return trailers.find(key) != trailers.end();
  10191. }
  10192. inline std::string Request::get_trailer_value(const std::string &key,
  10193. size_t id) const {
  10194. return detail::get_multimap_value(trailers, key, id);
  10195. }
  10196. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10197. return trailers.count(key);
  10198. }
  10199. inline bool Request::has_param(const std::string &key) const {
  10200. return params.find(key) != params.end();
  10201. }
  10202. inline std::string Request::get_param_value(const std::string &key,
  10203. size_t id) const {
  10204. return detail::get_multimap_value(params, key, id);
  10205. }
  10206. inline std::vector<std::string>
  10207. Request::get_param_values(const std::string &key) const {
  10208. auto rng = params.equal_range(key);
  10209. std::vector<std::string> values;
  10210. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10211. for (auto it = rng.first; it != rng.second; ++it) {
  10212. values.push_back(it->second);
  10213. }
  10214. return values;
  10215. }
  10216. inline size_t Request::get_param_value_count(const std::string &key) const {
  10217. return params.count(key);
  10218. }
  10219. inline bool Request::is_multipart_form_data() const {
  10220. const auto &content_type = get_header_value("Content-Type");
  10221. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10222. "multipart/form-data");
  10223. }
  10224. // Multipart FormData implementation
  10225. inline std::string MultipartFormData::get_field(const std::string &key,
  10226. size_t id) const {
  10227. auto rng = fields.equal_range(key);
  10228. auto it = detail::bounded_next(rng.first, id, rng.second);
  10229. if (it != rng.second) { return it->second.content; }
  10230. return std::string();
  10231. }
  10232. inline std::vector<std::string>
  10233. MultipartFormData::get_fields(const std::string &key) const {
  10234. std::vector<std::string> values;
  10235. auto rng = fields.equal_range(key);
  10236. for (auto it = rng.first; it != rng.second; it++) {
  10237. values.push_back(it->second.content);
  10238. }
  10239. return values;
  10240. }
  10241. inline bool MultipartFormData::has_field(const std::string &key) const {
  10242. return fields.find(key) != fields.end();
  10243. }
  10244. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10245. return fields.count(key);
  10246. }
  10247. inline FormData MultipartFormData::get_file(const std::string &key,
  10248. size_t id) const {
  10249. return detail::get_multimap_value(files, key, id);
  10250. }
  10251. inline std::vector<FormData>
  10252. MultipartFormData::get_files(const std::string &key) const {
  10253. std::vector<FormData> values;
  10254. auto rng = files.equal_range(key);
  10255. for (auto it = rng.first; it != rng.second; it++) {
  10256. values.push_back(it->second);
  10257. }
  10258. return values;
  10259. }
  10260. inline bool MultipartFormData::has_file(const std::string &key) const {
  10261. return files.find(key) != files.end();
  10262. }
  10263. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10264. return files.count(key);
  10265. }
  10266. // Multipart FormData writer implementation
  10267. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10268. return detail::is_multipart_boundary_chars_valid(boundary);
  10269. }
  10270. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10271. : boundary_(detail::make_multipart_data_boundary()) {}
  10272. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10273. : boundary_(std::move(boundary)) {}
  10274. inline const std::string &MultipartFormDataWriter::boundary() const {
  10275. return boundary_;
  10276. }
  10277. inline std::string MultipartFormDataWriter::content_type() const {
  10278. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10279. }
  10280. inline std::string
  10281. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10282. return detail::serialize_multipart_formdata(items, boundary_);
  10283. }
  10284. inline size_t MultipartFormDataWriter::content_length(
  10285. const UploadFormDataItems &items) const {
  10286. return detail::get_multipart_content_length(items, boundary_);
  10287. }
  10288. inline std::string
  10289. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10290. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10291. }
  10292. inline std::string MultipartFormDataWriter::item_end() {
  10293. return detail::serialize_multipart_formdata_item_end();
  10294. }
  10295. inline std::string MultipartFormDataWriter::finish() const {
  10296. return detail::serialize_multipart_formdata_finish(boundary_);
  10297. }
  10298. // Response implementation
  10299. namespace detail {
  10300. // A response has one content source: `body`, a content provider, or a file.
  10301. // Each content setter calls this so that the one called last wins.
  10302. inline void clear_content_provider(Response &res) {
  10303. auto releaser = std::move(res.content_provider_resource_releaser_);
  10304. auto success = res.content_provider_success_;
  10305. res.content_length_ = 0;
  10306. res.content_provider_ = nullptr;
  10307. res.content_provider_resource_releaser_ = nullptr;
  10308. res.is_chunked_content_provider_ = false;
  10309. res.is_file_content_provider_ = false;
  10310. res.content_provider_success_ = false;
  10311. res.content_coding_ = EncodingType::None;
  10312. res.file_content_path_.clear();
  10313. res.file_content_content_type_.clear();
  10314. if (releaser) { releaser(success); }
  10315. }
  10316. inline void clear_content(Response &res) {
  10317. res.body.clear();
  10318. clear_content_provider(res);
  10319. }
  10320. // The Content-Type of the old content goes with it.
  10321. inline void set_content_type(Response &res, const std::string &content_type) {
  10322. res.headers.erase("Content-Type");
  10323. res.set_header("Content-Type", content_type);
  10324. }
  10325. // `body` is public, so it can be assigned directly after a provider or a file
  10326. // was set. It came last, so it wins.
  10327. inline void prefer_assigned_body(Response &res) {
  10328. if (!res.body.empty() &&
  10329. (res.content_provider_ || !res.file_content_path_.empty())) {
  10330. clear_content_provider(res);
  10331. }
  10332. }
  10333. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10334. inline bool body_allowed_for_status(int status) {
  10335. return status >= 200 && status != StatusCode::NoContent_204 &&
  10336. status != StatusCode::NotModified_304;
  10337. }
  10338. // Only a 206 response is served as a partial representation. range_error()
  10339. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10340. // status would start from an unchecked offset.
  10341. inline bool is_partial_content(const Request &req, const Response &res) {
  10342. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10343. }
  10344. // Sets the Content-Length or Transfer-Encoding framing the body that
  10345. // Server::write_response_core() writes, or closes the connection after a body
  10346. // that has neither. Only the library sets them: one from a handler would go
  10347. // out next to it, or describe some other body.
  10348. inline void set_framing_headers(const Request &req, Response &res,
  10349. const std::string &boundary,
  10350. const std::string &content_type) {
  10351. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10352. auto head_length = req.method == "HEAD"
  10353. ? res.get_header_value("Content-Length")
  10354. : std::string();
  10355. res.headers.erase("Content-Length");
  10356. res.headers.erase("Transfer-Encoding");
  10357. if (!body_allowed_for_status(res.status)) { return; }
  10358. if (res.content_provider_) {
  10359. if (res.content_length_ == 0) {
  10360. if (res.is_chunked_content_provider_) {
  10361. res.set_header("Transfer-Encoding", "chunked");
  10362. } else if (req.method != "HEAD") {
  10363. // RFC 9112 6.3: a body with neither ends where the connection does.
  10364. res.headers.erase("Keep-Alive");
  10365. if (!has_header_token(res.headers, "Connection", "close")) {
  10366. res.set_header("Connection", "close");
  10367. }
  10368. }
  10369. return;
  10370. }
  10371. // The part Server::write_content_with_provider() writes.
  10372. auto length = res.content_length_;
  10373. if (is_partial_content(req, res)) {
  10374. length = req.ranges.size() == 1
  10375. ? get_range_offset_and_length(req.ranges[0], length).second
  10376. : get_multipart_ranges_data_length(req, boundary,
  10377. content_type, length);
  10378. }
  10379. res.set_header("Content-Length", std::to_string(length));
  10380. } else if (!res.body.empty()) {
  10381. res.set_header("Content-Length", std::to_string(res.body.size()));
  10382. } else {
  10383. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10384. }
  10385. }
  10386. } // namespace detail
  10387. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10388. size_t id) const {
  10389. return detail::get_header_value_u64(headers, key, def, id);
  10390. }
  10391. inline bool Response::has_header(const std::string &key) const {
  10392. return headers.find(key) != headers.end();
  10393. }
  10394. inline std::string Response::get_header_value(const std::string &key,
  10395. const char *def,
  10396. size_t id) const {
  10397. return detail::get_header_value(headers, key, def, id);
  10398. }
  10399. inline size_t Response::get_header_value_count(const std::string &key) const {
  10400. return detail::get_header_value_count(headers, key);
  10401. }
  10402. inline void Response::set_header(const std::string &key,
  10403. const std::string &val) {
  10404. detail::set_header(headers, key, val);
  10405. }
  10406. inline bool Response::has_trailer(const std::string &key) const {
  10407. return trailers.find(key) != trailers.end();
  10408. }
  10409. inline std::string Response::get_trailer_value(const std::string &key,
  10410. size_t id) const {
  10411. return detail::get_multimap_value(trailers, key, id);
  10412. }
  10413. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10414. return trailers.count(key);
  10415. }
  10416. inline void Response::set_redirect(const std::string &url, int stat) {
  10417. if (detail::fields::is_field_value(url)) {
  10418. set_header("Location", url);
  10419. if (300 <= stat && stat < 400) {
  10420. this->status = stat;
  10421. } else {
  10422. this->status = StatusCode::Found_302;
  10423. }
  10424. }
  10425. }
  10426. inline void Response::set_content(const char *s, size_t n,
  10427. const std::string &content_type) {
  10428. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10429. detail::clear_content_provider(*this);
  10430. detail::set_content_type(*this, content_type);
  10431. }
  10432. inline void Response::set_content(const std::string &s,
  10433. const std::string &content_type) {
  10434. set_content(s.data(), s.size(), content_type);
  10435. }
  10436. inline void Response::set_content(std::string &&s,
  10437. const std::string &content_type) {
  10438. body = std::move(s);
  10439. detail::clear_content_provider(*this);
  10440. detail::set_content_type(*this, content_type);
  10441. }
  10442. inline void Response::set_content_provider(
  10443. size_t in_length, const std::string &content_type, ContentProvider provider,
  10444. ContentProviderResourceReleaser resource_releaser) {
  10445. detail::clear_content(*this);
  10446. detail::set_content_type(*this, content_type);
  10447. content_length_ = in_length;
  10448. if (in_length > 0) { content_provider_ = std::move(provider); }
  10449. content_provider_resource_releaser_ = std::move(resource_releaser);
  10450. }
  10451. inline void Response::set_content_provider(
  10452. const std::string &content_type, ContentProviderWithoutLength provider,
  10453. ContentProviderResourceReleaser resource_releaser) {
  10454. detail::clear_content(*this);
  10455. detail::set_content_type(*this, content_type);
  10456. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10457. content_provider_resource_releaser_ = std::move(resource_releaser);
  10458. }
  10459. inline void Response::set_chunked_content_provider(
  10460. const std::string &content_type, ContentProviderWithoutLength provider,
  10461. ContentProviderResourceReleaser resource_releaser) {
  10462. set_content_provider(content_type, std::move(provider),
  10463. std::move(resource_releaser));
  10464. is_chunked_content_provider_ = true;
  10465. }
  10466. inline void Response::set_file_content(const std::string &path,
  10467. const std::string &content_type) {
  10468. detail::clear_content(*this);
  10469. headers.erase("Content-Type");
  10470. file_content_path_ = path;
  10471. file_content_content_type_ = content_type;
  10472. }
  10473. inline void Response::set_file_content(const std::string &path) {
  10474. set_file_content(path, std::string());
  10475. }
  10476. // Result implementation
  10477. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10478. size_t def,
  10479. size_t id) const {
  10480. return detail::get_header_value_u64(request_headers_, key, def, id);
  10481. }
  10482. inline bool Result::has_request_header(const std::string &key) const {
  10483. return request_headers_.find(key) != request_headers_.end();
  10484. }
  10485. inline std::string Result::get_request_header_value(const std::string &key,
  10486. const char *def,
  10487. size_t id) const {
  10488. return detail::get_header_value(request_headers_, key, def, id);
  10489. }
  10490. inline size_t
  10491. Result::get_request_header_value_count(const std::string &key) const {
  10492. return request_headers_.count(key);
  10493. }
  10494. // Stream implementation
  10495. inline ssize_t Stream::write(const char *ptr) {
  10496. return write(ptr, strlen(ptr));
  10497. }
  10498. inline ssize_t Stream::write(const std::string &s) {
  10499. return write(s.data(), s.size());
  10500. }
  10501. // BodyReader implementation
  10502. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10503. if (!stream) {
  10504. last_error = Error::Connection;
  10505. return -1;
  10506. }
  10507. if (eof) { return 0; }
  10508. if (!chunked) {
  10509. // Content-Length based reading
  10510. if (has_content_length && bytes_read >= content_length) {
  10511. eof = true;
  10512. return 0;
  10513. }
  10514. auto to_read = len;
  10515. if (has_content_length) {
  10516. auto remaining = content_length - bytes_read;
  10517. to_read = (std::min)(len, remaining);
  10518. }
  10519. auto n = stream->read(buf, to_read);
  10520. // Without Content-Length the body ends when the connection closes
  10521. // (RFC 9112 §6.3); with one, an EOF here came too early
  10522. if (n < 0 || (n == 0 && has_content_length)) {
  10523. last_error = stream->get_error();
  10524. if (last_error == Error::Success) { last_error = Error::Read; }
  10525. }
  10526. if (n <= 0) {
  10527. eof = true;
  10528. return n;
  10529. }
  10530. bytes_read += static_cast<size_t>(n);
  10531. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10532. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10533. last_error = Error::ExceedMaxPayloadSize;
  10534. eof = true;
  10535. return -1;
  10536. }
  10537. return n;
  10538. }
  10539. // Chunked transfer encoding: delegate to shared decoder instance.
  10540. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10541. size_t chunk_offset = 0;
  10542. size_t chunk_total = 0;
  10543. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10544. if (n < 0) {
  10545. last_error = stream->get_error();
  10546. if (last_error == Error::Success) { last_error = Error::Read; }
  10547. eof = true;
  10548. return n;
  10549. }
  10550. if (n == 0) {
  10551. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10552. eof = true;
  10553. return 0;
  10554. }
  10555. bytes_read += static_cast<size_t>(n);
  10556. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10557. last_error = Error::ExceedMaxPayloadSize;
  10558. eof = true;
  10559. return -1;
  10560. }
  10561. return n;
  10562. }
  10563. // ThreadPool implementation
  10564. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10565. time_t idle_timeout_sec)
  10566. : base_thread_count_(n), max_queued_requests_(mqr),
  10567. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10568. shutdown_(false) {
  10569. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10570. if (max_n != 0 && max_n < n) {
  10571. std::string msg = "max_threads must be >= base_threads";
  10572. throw std::invalid_argument(msg);
  10573. }
  10574. #endif
  10575. max_thread_count_ = max_n == 0 ? n : max_n;
  10576. threads_.reserve(base_thread_count_);
  10577. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10578. try {
  10579. #endif
  10580. for (size_t i = 0; i < base_thread_count_; i++) {
  10581. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10582. }
  10583. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10584. } catch (...) {
  10585. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10586. // signal the workers we already spawned to exit and join them so the
  10587. // vector destructor does not see joinable threads (which would call
  10588. // std::terminate). Then rethrow so the caller learns of the failure.
  10589. {
  10590. std::unique_lock<std::mutex> lock(mutex_);
  10591. shutdown_ = true;
  10592. }
  10593. cond_.notify_all();
  10594. for (auto &t : threads_) {
  10595. if (t.joinable()) { t.join(); }
  10596. }
  10597. throw;
  10598. }
  10599. #endif
  10600. }
  10601. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10602. {
  10603. std::unique_lock<std::mutex> lock(mutex_);
  10604. if (shutdown_) { return false; }
  10605. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10606. return false;
  10607. }
  10608. jobs_.push_back(std::move(fn));
  10609. // Spawn a dynamic thread if jobs outnumber idle threads and under max
  10610. if (jobs_.size() > idle_thread_count_ &&
  10611. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10612. cleanup_finished_threads();
  10613. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10614. }
  10615. }
  10616. cond_.notify_one();
  10617. return true;
  10618. }
  10619. inline void ThreadPool::shutdown() {
  10620. {
  10621. std::unique_lock<std::mutex> lock(mutex_);
  10622. shutdown_ = true;
  10623. }
  10624. cond_.notify_all();
  10625. for (auto &t : threads_) {
  10626. if (t.joinable()) { t.join(); }
  10627. }
  10628. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10629. // with worker threads that call move_to_finished() concurrently.
  10630. std::list<std::thread> remaining_dynamic;
  10631. {
  10632. std::unique_lock<std::mutex> lock(mutex_);
  10633. remaining_dynamic = std::move(dynamic_threads_);
  10634. }
  10635. for (auto &t : remaining_dynamic) {
  10636. if (t.joinable()) { t.join(); }
  10637. }
  10638. std::unique_lock<std::mutex> lock(mutex_);
  10639. cleanup_finished_threads();
  10640. }
  10641. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10642. // Must be called with mutex_ held
  10643. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10644. if (it->get_id() == id) {
  10645. finished_threads_.push_back(std::move(*it));
  10646. dynamic_threads_.erase(it);
  10647. return;
  10648. }
  10649. }
  10650. }
  10651. inline void ThreadPool::cleanup_finished_threads() {
  10652. // Must be called with mutex_ held
  10653. for (auto &t : finished_threads_) {
  10654. if (t.joinable()) { t.join(); }
  10655. }
  10656. finished_threads_.clear();
  10657. }
  10658. inline void ThreadPool::worker(bool is_dynamic) {
  10659. for (;;) {
  10660. std::function<void()> fn;
  10661. {
  10662. std::unique_lock<std::mutex> lock(mutex_);
  10663. idle_thread_count_++;
  10664. if (is_dynamic) {
  10665. auto has_work =
  10666. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10667. [&] { return !jobs_.empty() || shutdown_; });
  10668. if (!has_work) {
  10669. // Timed out with no work - exit this dynamic thread
  10670. idle_thread_count_--;
  10671. move_to_finished(std::this_thread::get_id());
  10672. break;
  10673. }
  10674. } else {
  10675. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10676. }
  10677. idle_thread_count_--;
  10678. if (shutdown_ && jobs_.empty()) { break; }
  10679. fn = std::move(jobs_.front());
  10680. jobs_.pop_front();
  10681. }
  10682. assert(true == static_cast<bool>(fn));
  10683. fn();
  10684. }
  10685. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10686. !defined(LIBRESSL_VERSION_NUMBER)
  10687. OPENSSL_thread_stop();
  10688. #endif
  10689. }
  10690. /*
  10691. * Group 1 (continued): detail namespace - Stream implementations
  10692. */
  10693. namespace detail {
  10694. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10695. time_t timeout_sec, time_t timeout_usec,
  10696. time_t &actual_timeout_sec,
  10697. time_t &actual_timeout_usec) {
  10698. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10699. auto actual_timeout_msec =
  10700. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10701. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10702. actual_timeout_sec = actual_timeout_msec / 1000;
  10703. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10704. }
  10705. // Socket stream implementation
  10706. inline SocketStream::SocketStream(
  10707. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10708. time_t write_timeout_sec, time_t write_timeout_usec,
  10709. time_t max_timeout_msec,
  10710. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10711. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10712. read_timeout_usec_(read_timeout_usec),
  10713. write_timeout_sec_(write_timeout_sec),
  10714. write_timeout_usec_(write_timeout_usec),
  10715. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10716. read_buff_(read_buff_size_, 0) {}
  10717. inline SocketStream::~SocketStream() = default;
  10718. inline bool SocketStream::is_readable() const {
  10719. return read_buff_off_ < read_buff_content_size_;
  10720. }
  10721. inline bool SocketStream::wait_readable() const {
  10722. if (max_timeout_msec_ <= 0) {
  10723. return select_read_interruptible(sock_, read_timeout_sec_,
  10724. read_timeout_usec_, read_interrupted_) > 0;
  10725. }
  10726. time_t read_timeout_sec;
  10727. time_t read_timeout_usec;
  10728. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10729. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10730. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  10731. read_interrupted_) > 0;
  10732. }
  10733. inline bool SocketStream::wait_writable() const {
  10734. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10735. }
  10736. inline bool SocketStream::ensure_readable() {
  10737. if (readable_hint_) {
  10738. readable_hint_ = false;
  10739. return true;
  10740. }
  10741. return wait_readable();
  10742. }
  10743. inline const char *SocketStream::buffered_data(size_t &size) const {
  10744. size = read_buff_content_size_ - read_buff_off_;
  10745. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10746. }
  10747. inline void SocketStream::consume_buffered(size_t size) {
  10748. assert(size <= read_buff_content_size_ - read_buff_off_);
  10749. read_buff_off_ += size;
  10750. }
  10751. inline bool SocketStream::is_peer_alive() const {
  10752. return detail::is_socket_alive(sock_);
  10753. }
  10754. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10755. #ifdef _WIN32
  10756. size =
  10757. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10758. #else
  10759. size = (std::min)(size,
  10760. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10761. #endif
  10762. if (read_buff_off_ < read_buff_content_size_) {
  10763. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10764. if (size <= remaining_size) {
  10765. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10766. read_buff_off_ += size;
  10767. return static_cast<ssize_t>(size);
  10768. } else {
  10769. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10770. read_buff_off_ += remaining_size;
  10771. return static_cast<ssize_t>(remaining_size);
  10772. }
  10773. }
  10774. if (!ensure_readable()) {
  10775. error_ = Error::Timeout;
  10776. return -1;
  10777. }
  10778. read_buff_off_ = 0;
  10779. read_buff_content_size_ = 0;
  10780. if (size < read_buff_size_) {
  10781. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10782. CPPHTTPLIB_RECV_FLAGS);
  10783. if (n <= 0) {
  10784. if (n == 0) {
  10785. error_ = Error::ConnectionClosed;
  10786. } else {
  10787. error_ = Error::Read;
  10788. }
  10789. return n;
  10790. } else if (n <= static_cast<ssize_t>(size)) {
  10791. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10792. return n;
  10793. } else {
  10794. memcpy(ptr, read_buff_.data(), size);
  10795. read_buff_off_ = size;
  10796. read_buff_content_size_ = static_cast<size_t>(n);
  10797. return static_cast<ssize_t>(size);
  10798. }
  10799. } else {
  10800. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10801. if (n <= 0) {
  10802. if (n == 0) {
  10803. error_ = Error::ConnectionClosed;
  10804. } else {
  10805. error_ = Error::Read;
  10806. }
  10807. }
  10808. return n;
  10809. }
  10810. }
  10811. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10812. if (!wait_writable()) { return -1; }
  10813. #if defined(_WIN32) && !defined(_WIN64)
  10814. size =
  10815. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10816. #endif
  10817. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10818. }
  10819. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10820. int &port) const {
  10821. return detail::get_remote_ip_and_port(sock_, ip, port);
  10822. }
  10823. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10824. int &port) const {
  10825. return detail::get_local_ip_and_port(sock_, ip, port);
  10826. }
  10827. inline socket_t SocketStream::socket() const { return sock_; }
  10828. inline time_t SocketStream::duration() const {
  10829. return static_cast<time_t>(
  10830. std::chrono::duration_cast<std::chrono::milliseconds>(
  10831. std::chrono::steady_clock::now() - start_time_)
  10832. .count());
  10833. }
  10834. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10835. read_timeout_sec_ = sec;
  10836. read_timeout_usec_ = usec;
  10837. }
  10838. inline void SocketStream::set_max_timeout(time_t msec) {
  10839. max_timeout_msec_ = msec;
  10840. start_time_ = std::chrono::steady_clock::now();
  10841. }
  10842. inline void
  10843. SocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  10844. read_interrupted_ = std::move(interrupted);
  10845. }
  10846. // Buffer stream implementation
  10847. inline bool BufferStream::is_readable() const { return true; }
  10848. inline bool BufferStream::wait_readable() const { return true; }
  10849. inline bool BufferStream::wait_writable() const { return true; }
  10850. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10851. #if defined(_MSC_VER) && _MSC_VER < 1910
  10852. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10853. #else
  10854. auto len_read = buffer.copy(ptr, size, position);
  10855. #endif
  10856. position += static_cast<size_t>(len_read);
  10857. return static_cast<ssize_t>(len_read);
  10858. }
  10859. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10860. buffer.append(ptr, size);
  10861. return static_cast<ssize_t>(size);
  10862. }
  10863. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10864. int & /*port*/) const {}
  10865. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10866. int & /*port*/) const {}
  10867. inline socket_t BufferStream::socket() const { return 0; }
  10868. inline time_t BufferStream::duration() const { return 0; }
  10869. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10870. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10871. : MatcherBase(pattern) {
  10872. constexpr const char marker[] = "/:";
  10873. // One past the last ending position of a path param substring
  10874. std::size_t last_param_end = 0;
  10875. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10876. // Needed to ensure that parameter names are unique during matcher
  10877. // construction
  10878. // If exceptions are disabled, only last duplicate path
  10879. // parameter will be set
  10880. std::unordered_set<std::string> param_name_set;
  10881. #endif
  10882. while (true) {
  10883. const auto marker_pos = pattern.find(
  10884. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10885. if (marker_pos == std::string::npos) { break; }
  10886. static_fragments_.push_back(
  10887. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10888. const auto param_name_start = marker_pos + str_len(marker);
  10889. auto sep_pos = pattern.find(separator, param_name_start);
  10890. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10891. auto param_name =
  10892. pattern.substr(param_name_start, sep_pos - param_name_start);
  10893. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10894. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10895. std::string msg = "Encountered path parameter '" + param_name +
  10896. "' multiple times in route pattern '" + pattern + "'.";
  10897. throw std::invalid_argument(msg);
  10898. }
  10899. #endif
  10900. param_names_.push_back(std::move(param_name));
  10901. last_param_end = sep_pos + 1;
  10902. }
  10903. if (last_param_end < pattern.length()) {
  10904. static_fragments_.push_back(pattern.substr(last_param_end));
  10905. }
  10906. }
  10907. inline bool PathParamsMatcher::match(Request &request) const {
  10908. request.matches = std::smatch();
  10909. request.path_params.clear();
  10910. // A pattern without parameters is just a literal path to compare against
  10911. if (param_names_.empty()) { return request.path == pattern(); }
  10912. request.path_params.reserve(param_names_.size());
  10913. // One past the position at which the path matched the pattern last time
  10914. std::size_t starting_pos = 0;
  10915. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10916. const auto &fragment = static_fragments_[i];
  10917. if (starting_pos + fragment.length() > request.path.length()) {
  10918. return false;
  10919. }
  10920. // Avoid unnecessary allocation by using strncmp instead of substr +
  10921. // comparison
  10922. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10923. fragment.length()) != 0) {
  10924. return false;
  10925. }
  10926. starting_pos += fragment.length();
  10927. // Should only happen when we have a static fragment after a param
  10928. // Example: '/users/:id/subscriptions'
  10929. // The 'subscriptions' fragment here does not have a corresponding param
  10930. if (i >= param_names_.size()) { continue; }
  10931. auto sep_pos = request.path.find(separator, starting_pos);
  10932. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10933. const auto &param_name = param_names_[i];
  10934. request.path_params.emplace(
  10935. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10936. // Mark everything up to '/' as matched
  10937. starting_pos = sep_pos + 1;
  10938. }
  10939. // Returns false if the path is longer than the pattern
  10940. return starting_pos >= request.path.length();
  10941. }
  10942. inline bool RegexMatcher::match(Request &request) const {
  10943. request.path_params.clear();
  10944. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10945. // a non-match rather than risking a stack overflow in std::regex_match.
  10946. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10947. return false;
  10948. }
  10949. return std::regex_match(request.path, request.matches, regex_);
  10950. }
  10951. // Enclose IPv6 address in brackets if needed
  10952. inline std::string prepare_host_string(const std::string &host) {
  10953. // Enclose IPv6 address in brackets (but not if already enclosed)
  10954. if (host.find(':') == std::string::npos ||
  10955. (!host.empty() && host[0] == '[')) {
  10956. // IPv4, hostname, or already bracketed IPv6
  10957. return host;
  10958. } else {
  10959. // IPv6 address without brackets
  10960. return "[" + host + "]";
  10961. }
  10962. }
  10963. inline std::string make_host_and_port_string(const std::string &host, int port,
  10964. bool is_ssl) {
  10965. auto result = prepare_host_string(host);
  10966. // Append port if not default
  10967. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10968. ; // do nothing
  10969. } else {
  10970. result += ":" + std::to_string(port);
  10971. }
  10972. return result;
  10973. }
  10974. // Create "host:port" string always including port number (for CONNECT method)
  10975. inline std::string
  10976. make_host_and_port_string_always_port(const std::string &host, int port) {
  10977. return prepare_host_string(host) + ":" + std::to_string(port);
  10978. }
  10979. // Value for the Host header a client sends when the caller supplied none.
  10980. // Only the value: callers decide where in their header list it goes.
  10981. inline std::string make_default_host_header_value(const std::string &host,
  10982. int port, bool is_ssl,
  10983. int address_family) {
  10984. if (address_family == AF_UNIX) { return "localhost"; }
  10985. return make_host_and_port_string(host, port, is_ssl);
  10986. }
  10987. inline void add_default_user_agent_header(Request &req) {
  10988. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10989. if (!req.has_header("User-Agent")) {
  10990. req.set_header("User-Agent",
  10991. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10992. }
  10993. #else
  10994. (void)req;
  10995. #endif
  10996. }
  10997. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10998. NormalizedTarget normalize_target(const std::string &host);
  10999. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  11000. bool host_matches_no_proxy(const NormalizedTarget &target,
  11001. const std::vector<NoProxyEntry> &entries);
  11002. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  11003. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  11004. if (prefix_bits == 0) { return true; }
  11005. int full_bytes = prefix_bits / 8;
  11006. int rem_bits = prefix_bits % 8;
  11007. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  11008. static_cast<size_t>(full_bytes)) != 0) {
  11009. return false;
  11010. }
  11011. if (rem_bits == 0) { return true; }
  11012. auto i = static_cast<size_t>(full_bytes);
  11013. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  11014. return (ip[i] & mask) == (net[i] & mask);
  11015. }
  11016. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  11017. if (token.empty()) { return false; }
  11018. if (token == "*") {
  11019. out.kind = NoProxyKind::Wildcard;
  11020. return true;
  11021. }
  11022. auto slash = token.find('/');
  11023. std::string addr_part =
  11024. (slash == std::string::npos) ? token : token.substr(0, slash);
  11025. std::string prefix_part =
  11026. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  11027. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  11028. // don't silently treat it as a /32 (or /128).
  11029. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  11030. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  11031. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  11032. // when brackets are present.
  11033. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  11034. addr_part.back() == ']';
  11035. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  11036. if (!bracketed) {
  11037. struct in_addr v4;
  11038. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  11039. int prefix = 32;
  11040. if (!prefix_part.empty() &&
  11041. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  11042. prefix)) {
  11043. return false;
  11044. }
  11045. out.kind = NoProxyKind::IPv4Cidr;
  11046. std::memcpy(out.net.data(), &v4, sizeof(v4));
  11047. out.prefix_bits = prefix;
  11048. return true;
  11049. }
  11050. }
  11051. struct in6_addr v6;
  11052. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  11053. int prefix = 128;
  11054. if (!prefix_part.empty() &&
  11055. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  11056. prefix)) {
  11057. return false;
  11058. }
  11059. out.kind = NoProxyKind::IPv6Cidr;
  11060. std::memcpy(out.net.data(), &v6, sizeof(v6));
  11061. out.prefix_bits = prefix;
  11062. return true;
  11063. }
  11064. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  11065. // the entry is malformed — don't fall through to the hostname branch.
  11066. if (bracketed) { return false; }
  11067. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  11068. if (slash != std::string::npos) { return false; }
  11069. // Port-specific entries (host:port) are not supported.
  11070. if (token.find(':') != std::string::npos) { return false; }
  11071. std::string hostname = case_ignore::to_lower(token);
  11072. while (!hostname.empty() && hostname.front() == '.') {
  11073. hostname.erase(hostname.begin());
  11074. }
  11075. while (!hostname.empty() && hostname.back() == '.') {
  11076. hostname.pop_back();
  11077. }
  11078. if (hostname.empty()) { return false; }
  11079. out.kind = NoProxyKind::HostnameSuffix;
  11080. out.hostname_pattern = std::move(hostname);
  11081. return true;
  11082. }
  11083. inline std::vector<NoProxyEntry>
  11084. parse_no_proxy_entries(const std::vector<std::string> &patterns) {
  11085. std::vector<NoProxyEntry> entries;
  11086. entries.reserve(patterns.size());
  11087. for (const auto &p : patterns) {
  11088. auto trimmed = trim_copy(p);
  11089. if (trimmed.empty()) { continue; }
  11090. NoProxyEntry entry;
  11091. if (parse_no_proxy_entry(trimmed, entry)) {
  11092. entries.push_back(std::move(entry));
  11093. }
  11094. }
  11095. return entries;
  11096. }
  11097. inline NormalizedTarget normalize_target(const std::string &host) {
  11098. NormalizedTarget t;
  11099. std::string h = host;
  11100. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  11101. h = h.substr(1, h.size() - 2);
  11102. }
  11103. // Strip a single trailing dot so "example.com." canonicalizes to
  11104. // "example.com".
  11105. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  11106. t.hostname = case_ignore::to_lower(h);
  11107. if (!t.hostname.empty()) {
  11108. struct in_addr v4;
  11109. struct in6_addr v6;
  11110. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  11111. t.is_ipv4 = true;
  11112. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  11113. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  11114. t.is_ipv6 = true;
  11115. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  11116. }
  11117. }
  11118. return t;
  11119. }
  11120. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  11121. const std::vector<NoProxyEntry> &entries) {
  11122. if (target.hostname.empty()) { return false; }
  11123. for (const auto &e : entries) {
  11124. switch (e.kind) {
  11125. case NoProxyKind::Wildcard: return true;
  11126. case NoProxyKind::IPv4Cidr:
  11127. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11128. return true;
  11129. }
  11130. break;
  11131. case NoProxyKind::IPv6Cidr:
  11132. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  11133. return true;
  11134. }
  11135. break;
  11136. case NoProxyKind::HostnameSuffix:
  11137. if (target.is_ipv4 || target.is_ipv6) { break; }
  11138. if (target.hostname == e.hostname_pattern) { return true; }
  11139. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  11140. // an entry of "example.com".
  11141. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  11142. auto offset = target.hostname.size() - e.hostname_pattern.size();
  11143. if (target.hostname[offset - 1] == '.' &&
  11144. target.hostname.compare(offset, e.hostname_pattern.size(),
  11145. e.hostname_pattern) == 0) {
  11146. return true;
  11147. }
  11148. }
  11149. break;
  11150. }
  11151. }
  11152. return false;
  11153. }
  11154. template <typename T>
  11155. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  11156. T header_writer, Error &error) {
  11157. for (const auto &h : headers) {
  11158. if (!detail::fields::is_field_valid(h.first, h.second)) {
  11159. error = Error::InvalidHeaders;
  11160. return false;
  11161. }
  11162. }
  11163. if (header_writer(strm, headers) <= 0) {
  11164. error = Error::Write;
  11165. return false;
  11166. }
  11167. return true;
  11168. }
  11169. } // namespace detail
  11170. /*
  11171. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11172. */
  11173. #ifdef CPPHTTPLIB_SSL_ENABLED
  11174. namespace detail {
  11175. // SSL socket stream implementation
  11176. inline SSLSocketStream::SSLSocketStream(
  11177. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11178. time_t read_timeout_usec, time_t write_timeout_sec,
  11179. time_t write_timeout_usec, time_t max_timeout_msec,
  11180. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11181. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11182. read_timeout_usec_(read_timeout_usec),
  11183. write_timeout_sec_(write_timeout_sec),
  11184. write_timeout_usec_(write_timeout_usec),
  11185. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11186. tls_error_.code = tls::ErrorCode::Success;
  11187. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11188. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11189. // Note: create_session() also clears this, but SSLClient currently
  11190. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11191. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11192. // SSL session was created.
  11193. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11194. #endif
  11195. }
  11196. inline SSLSocketStream::~SSLSocketStream() = default;
  11197. inline bool SSLSocketStream::is_readable() const {
  11198. return tls::pending(session_) > 0;
  11199. }
  11200. inline bool SSLSocketStream::wait_readable() const {
  11201. if (max_timeout_msec_ <= 0) {
  11202. return select_read_interruptible(sock_, read_timeout_sec_,
  11203. read_timeout_usec_, read_interrupted_) > 0;
  11204. }
  11205. time_t read_timeout_sec;
  11206. time_t read_timeout_usec;
  11207. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11208. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11209. return select_read_interruptible(sock_, read_timeout_sec, read_timeout_usec,
  11210. read_interrupted_) > 0;
  11211. }
  11212. inline bool SSLSocketStream::wait_writable() const {
  11213. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11214. !tls::is_peer_closed(session_, sock_);
  11215. }
  11216. inline bool SSLSocketStream::ensure_readable() {
  11217. if (readable_hint_) {
  11218. readable_hint_ = false;
  11219. return true;
  11220. }
  11221. return wait_readable();
  11222. }
  11223. inline bool SSLSocketStream::is_peer_alive() const {
  11224. return !tls::is_peer_closed(session_, sock_);
  11225. }
  11226. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11227. if (tls::pending(session_) > 0) {
  11228. tls::TlsError err;
  11229. auto ret = tls::read(session_, ptr, size, err);
  11230. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11231. error_ = Error::ConnectionClosed;
  11232. } else if (ret < 0) {
  11233. tls_error_ = err;
  11234. }
  11235. return ret;
  11236. } else if (ensure_readable()) {
  11237. tls::TlsError err;
  11238. auto ret = tls::read(session_, ptr, size, err);
  11239. if (ret < 0) {
  11240. auto n = 1000;
  11241. #ifdef _WIN32
  11242. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11243. (err.code == tls::ErrorCode::SyscallError &&
  11244. WSAGetLastError() == WSAETIMEDOUT))) {
  11245. #else
  11246. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11247. #endif
  11248. if (tls::pending(session_) > 0) {
  11249. ret = tls::read(session_, ptr, size, err);
  11250. if (ret >= 0) { return ret; }
  11251. break;
  11252. } else if (wait_readable()) {
  11253. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11254. ret = tls::read(session_, ptr, size, err);
  11255. if (ret >= 0) { return ret; }
  11256. } else {
  11257. break;
  11258. }
  11259. }
  11260. assert(ret < 0);
  11261. tls_error_ = err;
  11262. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11263. error_ = Error::ConnectionClosed;
  11264. }
  11265. return ret;
  11266. } else {
  11267. error_ = Error::Timeout;
  11268. return -1;
  11269. }
  11270. }
  11271. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11272. if (wait_writable()) {
  11273. auto handle_size =
  11274. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11275. tls::TlsError err;
  11276. auto ret = tls::write(session_, ptr, handle_size, err);
  11277. if (ret < 0) {
  11278. auto n = 1000;
  11279. #ifdef _WIN32
  11280. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11281. (err.code == tls::ErrorCode::SyscallError &&
  11282. WSAGetLastError() == WSAETIMEDOUT))) {
  11283. #else
  11284. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11285. #endif
  11286. if (wait_writable()) {
  11287. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11288. ret = tls::write(session_, ptr, handle_size, err);
  11289. if (ret >= 0) { return ret; }
  11290. } else {
  11291. break;
  11292. }
  11293. }
  11294. assert(ret < 0);
  11295. tls_error_ = err;
  11296. }
  11297. return ret;
  11298. }
  11299. return -1;
  11300. }
  11301. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11302. int &port) const {
  11303. detail::get_remote_ip_and_port(sock_, ip, port);
  11304. }
  11305. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11306. int &port) const {
  11307. detail::get_local_ip_and_port(sock_, ip, port);
  11308. }
  11309. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11310. inline time_t SSLSocketStream::duration() const {
  11311. return static_cast<time_t>(
  11312. std::chrono::duration_cast<std::chrono::milliseconds>(
  11313. std::chrono::steady_clock::now() - start_time_)
  11314. .count());
  11315. }
  11316. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11317. read_timeout_sec_ = sec;
  11318. read_timeout_usec_ = usec;
  11319. }
  11320. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11321. max_timeout_msec_ = msec;
  11322. start_time_ = std::chrono::steady_clock::now();
  11323. }
  11324. inline void
  11325. SSLSocketStream::set_read_interrupt(std::function<bool()> interrupted) {
  11326. read_interrupted_ = std::move(interrupted);
  11327. }
  11328. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11329. tls::session_t session,
  11330. time_t read_timeout_sec,
  11331. time_t read_timeout_usec,
  11332. time_t write_timeout_sec,
  11333. time_t write_timeout_usec)
  11334. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11335. read_timeout_usec_(read_timeout_usec),
  11336. write_timeout_sec_(write_timeout_sec),
  11337. write_timeout_usec_(write_timeout_usec),
  11338. start_time_(std::chrono::steady_clock::now()) {
  11339. // The receive and send paths run on different threads, so each TLS call is
  11340. // driven in non-blocking mode and readiness is awaited with select()
  11341. // outside the session lock. Set the socket non-blocking once here; it is
  11342. // never flipped back, so no thread races on the flag.
  11343. detail::set_nonblocking(sock_, true);
  11344. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11345. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11346. #endif
  11347. }
  11348. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11349. inline bool WebSocketSSLStream::is_readable() const {
  11350. std::lock_guard<std::mutex> guard(session_mutex_);
  11351. return tls::pending(session_) > 0;
  11352. }
  11353. inline bool WebSocketSSLStream::wait_readable() const {
  11354. return select_read_interruptible(sock_, read_timeout_sec_, read_timeout_usec_,
  11355. read_interrupted_) > 0;
  11356. }
  11357. inline bool WebSocketSSLStream::wait_writable() const {
  11358. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11359. // that probe toggles the socket's blocking flag, which would race with the
  11360. // concurrent reader on a permanently non-blocking socket.
  11361. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11362. }
  11363. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11364. tls::TlsError err;
  11365. auto n = 1000;
  11366. while (--n >= 0) {
  11367. {
  11368. std::lock_guard<std::mutex> guard(session_mutex_);
  11369. auto ret = tls::read(session_, ptr, size, err);
  11370. if (ret > 0) { return ret; }
  11371. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11372. error_ = Error::ConnectionClosed;
  11373. return ret;
  11374. }
  11375. }
  11376. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11377. // direction: the send path shares this session, so output it left pending
  11378. // has to be flushed before more input can be decrypted. Anything else is
  11379. // a hard error.
  11380. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11381. #ifdef _WIN32
  11382. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11383. needs_readable =
  11384. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11385. WSAGetLastError() == WSAETIMEDOUT);
  11386. #endif
  11387. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11388. error_ = Error::Read;
  11389. return -1;
  11390. }
  11391. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11392. error_ = Error::Timeout;
  11393. return -1;
  11394. }
  11395. }
  11396. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11397. // to tell a timeout from a close would otherwise see whatever the previous
  11398. // failure left behind (error_ is never cleared on success).
  11399. error_ = Error::Read;
  11400. return -1;
  11401. }
  11402. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11403. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11404. tls::TlsError err;
  11405. auto n = 1000;
  11406. while (--n >= 0) {
  11407. {
  11408. std::lock_guard<std::mutex> guard(session_mutex_);
  11409. auto ret = tls::write(session_, ptr, handle_size, err);
  11410. if (ret >= 0) { return ret; }
  11411. }
  11412. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11413. // or a post-handshake message must be consumed before the record goes
  11414. // out. Anything else is a hard error.
  11415. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11416. #ifdef _WIN32
  11417. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11418. needs_writable =
  11419. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11420. WSAGetLastError() == WSAETIMEDOUT);
  11421. #endif
  11422. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11423. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11424. }
  11425. return -1;
  11426. }
  11427. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11428. int &port) const {
  11429. detail::get_remote_ip_and_port(sock_, ip, port);
  11430. }
  11431. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11432. int &port) const {
  11433. detail::get_local_ip_and_port(sock_, ip, port);
  11434. }
  11435. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11436. inline time_t WebSocketSSLStream::duration() const {
  11437. return static_cast<time_t>(
  11438. std::chrono::duration_cast<std::chrono::milliseconds>(
  11439. std::chrono::steady_clock::now() - start_time_)
  11440. .count());
  11441. }
  11442. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11443. read_timeout_sec_ = sec;
  11444. read_timeout_usec_ = usec;
  11445. }
  11446. inline void
  11447. WebSocketSSLStream::set_read_interrupt(std::function<bool()> interrupted) {
  11448. read_interrupted_ = std::move(interrupted);
  11449. }
  11450. } // namespace detail
  11451. #endif // CPPHTTPLIB_SSL_ENABLED
  11452. /*
  11453. * Group 4: Server implementation
  11454. */
  11455. // HTTP server implementation
  11456. inline Server::Server()
  11457. : new_task_queue([] {
  11458. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11459. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11460. }) {
  11461. #ifndef _WIN32
  11462. signal(SIGPIPE, SIG_IGN);
  11463. #endif
  11464. }
  11465. inline Server::~Server() = default;
  11466. inline std::unique_ptr<detail::MatcherBase>
  11467. Server::make_matcher(const std::string &pattern) {
  11468. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11469. // a path params pattern
  11470. if (pattern.find("/:") != std::string::npos) {
  11471. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11472. }
  11473. // A pattern with no regex metacharacter only has to be compared literally,
  11474. // which is what PathParamsMatcher already does when it captures no
  11475. // parameter, so std::regex is only worth building for the patterns that
  11476. // actually need it
  11477. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11478. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11479. }
  11480. return detail::make_unique<detail::RegexMatcher>(pattern);
  11481. }
  11482. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11483. return add_handler(get_handlers_, pattern, std::move(handler));
  11484. }
  11485. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11486. return add_handler(post_handlers_, pattern, std::move(handler));
  11487. }
  11488. inline Server &Server::Post(const std::string &pattern,
  11489. HandlerWithContentReader handler) {
  11490. return add_handler(post_handlers_for_content_reader_, pattern,
  11491. std::move(handler));
  11492. }
  11493. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11494. return add_handler(put_handlers_, pattern, std::move(handler));
  11495. }
  11496. inline Server &Server::Put(const std::string &pattern,
  11497. HandlerWithContentReader handler) {
  11498. return add_handler(put_handlers_for_content_reader_, pattern,
  11499. std::move(handler));
  11500. }
  11501. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11502. return add_handler(patch_handlers_, pattern, std::move(handler));
  11503. }
  11504. inline Server &Server::Patch(const std::string &pattern,
  11505. HandlerWithContentReader handler) {
  11506. return add_handler(patch_handlers_for_content_reader_, pattern,
  11507. std::move(handler));
  11508. }
  11509. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11510. return add_handler(delete_handlers_, pattern, std::move(handler));
  11511. }
  11512. inline Server &Server::Delete(const std::string &pattern,
  11513. HandlerWithContentReader handler) {
  11514. return add_handler(delete_handlers_for_content_reader_, pattern,
  11515. std::move(handler));
  11516. }
  11517. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11518. return add_handler(options_handlers_, pattern, std::move(handler));
  11519. }
  11520. inline const std::set<std::string> &Server::builtin_methods() {
  11521. thread_local const std::set<std::string> methods{
  11522. "GET", "HEAD", "POST", "PUT", "DELETE",
  11523. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11524. return methods;
  11525. }
  11526. inline Server::CustomHandlerEntry *
  11527. Server::custom_entry_for_registration(const std::string &method) {
  11528. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11529. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11530. // routing() before the custom tables are consulted, so a route registered
  11531. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11532. // there and would be reachable, but they carry protocol-level meaning
  11533. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11534. // library does not route.
  11535. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11536. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11537. has_invalid_registration_ = true;
  11538. return nullptr;
  11539. }
  11540. return &custom_handlers_[method];
  11541. }
  11542. inline Server &Server::CustomRoute(const std::string &method,
  11543. const std::string &pattern,
  11544. Handler handler) {
  11545. auto *entry = custom_entry_for_registration(method);
  11546. if (!entry) { return *this; }
  11547. return add_handler(entry->handlers, pattern, std::move(handler));
  11548. }
  11549. inline Server &Server::CustomRoute(const std::string &method,
  11550. const std::string &pattern,
  11551. HandlerWithContentReader handler) {
  11552. auto *entry = custom_entry_for_registration(method);
  11553. if (!entry) { return *this; }
  11554. return add_handler(entry->handlers_for_content_reader, pattern,
  11555. std::move(handler));
  11556. }
  11557. inline const Server::CustomHandlerEntry *
  11558. Server::find_custom_entry(const std::string &method) const {
  11559. // find() alone would be correct here. The empty() check is what keeps the
  11560. // per-request cost off servers that never call CustomRoute(), which is the
  11561. // overwhelmingly common case; keep it rather than walking into the tree.
  11562. if (custom_handlers_.empty()) { return nullptr; }
  11563. auto it = custom_handlers_.find(method);
  11564. return it == custom_handlers_.end() ? nullptr : &it->second;
  11565. }
  11566. inline Server &Server::WebSocket(const std::string &pattern,
  11567. WebSocketHandler handler) {
  11568. websocket_handlers_.push_back(
  11569. {make_matcher(pattern), std::move(handler), nullptr});
  11570. return *this;
  11571. }
  11572. inline Server &Server::WebSocket(const std::string &pattern,
  11573. WebSocketHandler handler,
  11574. SubProtocolSelector sub_protocol_selector) {
  11575. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11576. std::move(sub_protocol_selector)});
  11577. return *this;
  11578. }
  11579. inline bool Server::set_base_dir(const std::string &dir,
  11580. const std::string &mount_point) {
  11581. return set_mount_point(mount_point, dir);
  11582. }
  11583. inline bool Server::set_mount_point(const std::string &mount_point,
  11584. const std::string &dir, Headers headers) {
  11585. detail::FileStat stat(dir);
  11586. if (stat.is_dir()) {
  11587. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11588. if (!mnt.empty() && mnt[0] == '/') {
  11589. // Without the resolved directory, a file could not be checked to be
  11590. // inside it.
  11591. std::string resolved_base;
  11592. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11593. return false;
  11594. }
  11595. #if defined(_WIN32)
  11596. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11597. resolved_base += '\\';
  11598. }
  11599. #else
  11600. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11601. #endif
  11602. base_dirs_.push_back(
  11603. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11604. return true;
  11605. }
  11606. }
  11607. return false;
  11608. }
  11609. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11610. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11611. if (it->mount_point == mount_point) {
  11612. base_dirs_.erase(it);
  11613. return true;
  11614. }
  11615. }
  11616. return false;
  11617. }
  11618. inline Server &
  11619. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11620. const std::string &mime) {
  11621. file_extension_and_mimetype_map_[ext] = mime;
  11622. return *this;
  11623. }
  11624. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11625. default_file_mimetype_ = mime;
  11626. return *this;
  11627. }
  11628. inline Server &Server::set_file_request_handler(Handler handler) {
  11629. file_request_handler_ = std::move(handler);
  11630. return *this;
  11631. }
  11632. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11633. std::true_type) {
  11634. error_handler_ = std::move(handler);
  11635. return *this;
  11636. }
  11637. inline Server &Server::set_error_handler_core(Handler handler,
  11638. std::false_type) {
  11639. error_handler_ = [handler](const Request &req, Response &res) {
  11640. handler(req, res);
  11641. return HandlerResponse::Handled;
  11642. };
  11643. return *this;
  11644. }
  11645. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11646. exception_handler_ = std::move(handler);
  11647. return *this;
  11648. }
  11649. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11650. pre_routing_handler_ = std::move(handler);
  11651. return *this;
  11652. }
  11653. inline Server &Server::set_post_routing_handler(Handler handler) {
  11654. post_routing_handler_ = std::move(handler);
  11655. return *this;
  11656. }
  11657. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11658. pre_request_handler_ = std::move(handler);
  11659. return *this;
  11660. }
  11661. inline Server &Server::set_logger(Logger logger) {
  11662. logger_ = std::move(logger);
  11663. return *this;
  11664. }
  11665. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11666. error_logger_ = std::move(error_logger);
  11667. return *this;
  11668. }
  11669. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11670. pre_compression_logger_ = std::move(logger);
  11671. return *this;
  11672. }
  11673. inline Server &
  11674. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11675. expect_100_continue_handler_ = std::move(handler);
  11676. return *this;
  11677. }
  11678. inline Server &Server::set_start_handler(StartHandler handler) {
  11679. start_handler_ = std::move(handler);
  11680. return *this;
  11681. }
  11682. inline Server &Server::set_address_family(int family) {
  11683. address_family_ = family;
  11684. return *this;
  11685. }
  11686. inline Server &Server::set_tcp_nodelay(bool on) {
  11687. tcp_nodelay_ = on;
  11688. return *this;
  11689. }
  11690. inline Server &Server::set_ipv6_v6only(bool on) {
  11691. ipv6_v6only_ = on;
  11692. return *this;
  11693. }
  11694. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11695. socket_options_ = std::move(socket_options);
  11696. return *this;
  11697. }
  11698. inline Server &Server::set_default_headers(Headers headers) {
  11699. default_headers_ = std::move(headers);
  11700. return *this;
  11701. }
  11702. inline Server &Server::set_header_writer(
  11703. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11704. header_writer_ = writer;
  11705. return *this;
  11706. }
  11707. inline Server &
  11708. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11709. trusted_proxies_ = proxies;
  11710. return *this;
  11711. }
  11712. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11713. keep_alive_max_count_ = count;
  11714. return *this;
  11715. }
  11716. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11717. keep_alive_timeout_sec_ = sec;
  11718. return *this;
  11719. }
  11720. template <class Rep, class Period>
  11721. inline Server &Server::set_keep_alive_timeout(
  11722. const std::chrono::duration<Rep, Period> &duration) {
  11723. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11724. set_keep_alive_timeout(sec);
  11725. });
  11726. return *this;
  11727. }
  11728. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11729. read_timeout_sec_ = sec;
  11730. read_timeout_usec_ = usec;
  11731. return *this;
  11732. }
  11733. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11734. write_timeout_sec_ = sec;
  11735. write_timeout_usec_ = usec;
  11736. return *this;
  11737. }
  11738. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11739. idle_interval_sec_ = sec;
  11740. idle_interval_usec_ = usec;
  11741. return *this;
  11742. }
  11743. inline Server &Server::set_payload_max_length(size_t length) {
  11744. payload_max_length_ = length;
  11745. return *this;
  11746. }
  11747. inline Server &Server::set_static_file_compression(bool on) {
  11748. static_file_compression_ = on;
  11749. return *this;
  11750. }
  11751. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11752. static_file_compression_min_length_ = length;
  11753. return *this;
  11754. }
  11755. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11756. static_file_compression_max_length_ = length;
  11757. return *this;
  11758. }
  11759. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11760. websocket_max_missed_pongs_ = count;
  11761. return *this;
  11762. }
  11763. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11764. websocket_ping_interval_sec_ = sec;
  11765. return *this;
  11766. }
  11767. template <class Rep, class Period>
  11768. inline Server &Server::set_websocket_ping_interval(
  11769. const std::chrono::duration<Rep, Period> &duration) {
  11770. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11771. set_websocket_ping_interval(sec);
  11772. });
  11773. return *this;
  11774. }
  11775. inline bool Server::bind_to_port(const std::string &host, int port,
  11776. int socket_flags) {
  11777. auto ret = bind_internal(host, port, socket_flags);
  11778. if (ret == -1) { is_decommissioned = true; }
  11779. return ret >= 0;
  11780. }
  11781. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11782. auto ret = bind_internal(host, 0, socket_flags);
  11783. if (ret == -1) { is_decommissioned = true; }
  11784. return ret;
  11785. }
  11786. inline bool Server::listen_after_bind() { return listen_internal(); }
  11787. inline bool Server::listen(const std::string &host, int port,
  11788. int socket_flags) {
  11789. return bind_to_port(host, port, socket_flags) && listen_internal();
  11790. }
  11791. inline bool Server::is_running() const { return is_running_; }
  11792. inline void Server::wait_until_ready() const {
  11793. while (!is_running_ && !is_decommissioned) {
  11794. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11795. }
  11796. }
  11797. inline void Server::stop() noexcept {
  11798. // Release the listening socket whether or not the accept loop is running:
  11799. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11800. // exchange is what makes this safe to call concurrently with the accept loop.
  11801. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11802. if (sock != INVALID_SOCKET) {
  11803. detail::shutdown_socket(sock);
  11804. detail::close_socket(sock);
  11805. }
  11806. is_decommissioned = false;
  11807. }
  11808. inline void Server::decommission() { is_decommissioned = true; }
  11809. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11810. auto len = strlen(s);
  11811. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11812. len -= 2;
  11813. {
  11814. // RFC 9112 §3: exactly one SP between the method, the target and the
  11815. // version. Taking other whitespace as a separator too lets recipients
  11816. // that parse more strictly see a different request.
  11817. auto end = s + len;
  11818. if (std::count(s, end, ' ') != 2) { return false; }
  11819. auto sp1 = std::find(s, end, ' ');
  11820. auto sp2 = std::find(sp1 + 1, end, ' ');
  11821. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11822. req.method.assign(s, sp1);
  11823. req.target.assign(sp1 + 1, sp2);
  11824. req.version.assign(sp2 + 1, end);
  11825. }
  11826. // A method outside the built-in set is accepted only when a handler has been
  11827. // registered for it with CustomRoute().
  11828. const auto &methods = builtin_methods();
  11829. if (methods.find(req.method) == methods.end() &&
  11830. !find_custom_entry(req.method)) {
  11831. output_error_log(Error::InvalidHTTPMethod, &req);
  11832. return false;
  11833. }
  11834. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11835. output_error_log(Error::InvalidHTTPVersion, &req);
  11836. return false;
  11837. }
  11838. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11839. // would leave this server routing a different path than a cache or a
  11840. // filter in front of it sees.
  11841. if (!detail::fields::is_request_target(req.target) ||
  11842. req.target.find('#') != std::string::npos) {
  11843. return false;
  11844. }
  11845. {
  11846. detail::divide(req.target, '?',
  11847. [&](const char *lhs_data, std::size_t lhs_size,
  11848. const char *rhs_data, std::size_t rhs_size) {
  11849. req.path =
  11850. decode_path_component(std::string(lhs_data, lhs_size));
  11851. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11852. });
  11853. }
  11854. return true;
  11855. }
  11856. inline bool Server::write_response(Stream &strm, bool close_connection,
  11857. Request &req, Response &res) {
  11858. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11859. // incorrectly to the error content.
  11860. req.ranges.clear();
  11861. return write_response_core(strm, close_connection, req, res, false);
  11862. }
  11863. inline bool Server::write_response_with_content(Stream &strm,
  11864. bool close_connection,
  11865. const Request &req,
  11866. Response &res) {
  11867. return write_response_core(strm, close_connection, req, res, true);
  11868. }
  11869. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11870. const Request &req, Response &res,
  11871. bool need_apply_ranges) {
  11872. assert(res.status != -1);
  11873. if (400 <= res.status && error_handler_ &&
  11874. error_handler_(req, res) == HandlerResponse::Handled) {
  11875. need_apply_ranges = true;
  11876. }
  11877. // Before anything below reads res.headers, which the handlers may have
  11878. // filled directly
  11879. detail::erase_invalid_fields(res.headers);
  11880. if (!detail::body_allowed_for_status(res.status)) {
  11881. detail::clear_content(res);
  11882. }
  11883. detail::prefer_assigned_body(res);
  11884. std::string content_type;
  11885. std::string boundary;
  11886. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11887. // Prepare additional headers
  11888. if (close_connection ||
  11889. detail::has_header_token(req.headers, "Connection", "close") ||
  11890. 400 <= res.status || // Don't leave connections open after errors
  11891. // The client withholds the body until `100 Continue`, which was never
  11892. // sent, so whether and when the body follows is unknown.
  11893. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11894. // The body was left partway, e.g. by a content receiver that returned
  11895. // false, so the rest of it cannot be told from the next request.
  11896. (req.body_read_started_ && !req.body_consumed_)) {
  11897. res.set_header("Connection", "close");
  11898. } else {
  11899. std::string s = "timeout=";
  11900. s += std::to_string(keep_alive_timeout_sec_);
  11901. if (keep_alive_max_count_ > 0) {
  11902. s += ", max=";
  11903. s += std::to_string(keep_alive_max_count_);
  11904. }
  11905. res.set_header("Keep-Alive", s);
  11906. }
  11907. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11908. !res.has_header("Content-Type")) {
  11909. res.set_header("Content-Type", "text/plain");
  11910. }
  11911. detail::set_framing_headers(req, res, boundary, content_type);
  11912. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11913. res.set_header("Accept-Ranges", "bytes");
  11914. }
  11915. if (post_routing_handler_) {
  11916. post_routing_handler_(req, res);
  11917. detail::erase_invalid_fields(res.headers);
  11918. // Again, for a body or framing headers the handler changed.
  11919. detail::set_framing_headers(req, res, boundary, content_type);
  11920. }
  11921. // Response line and headers
  11922. detail::BufferStream bstrm;
  11923. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11924. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11925. // Combine a small body with the headers so the whole response leaves in a
  11926. // single write. A large body is written on its own instead: a copy of it
  11927. // costs more than the extra write saves.
  11928. auto send_body =
  11929. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11930. auto body_is_separate = false;
  11931. auto provider_done = false;
  11932. if (send_body && !res.body.empty() && !res.content_provider_) {
  11933. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11934. bstrm.write(res.body.data(), res.body.size());
  11935. } else {
  11936. body_is_separate = true;
  11937. }
  11938. } else if (send_body && res.content_provider_ &&
  11939. res.is_file_content_provider_ &&
  11940. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11941. // A small file is read into the same buffer. Other providers may produce
  11942. // their data over time, so they are never held back.
  11943. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11944. return false;
  11945. }
  11946. provider_done = true;
  11947. }
  11948. // Log before writing to avoid race condition with client-side code that
  11949. // accesses logger-captured data immediately after receiving the response.
  11950. output_log(req, res);
  11951. // Flush buffer
  11952. auto &data = bstrm.get_buffer();
  11953. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11954. if (body_is_separate) {
  11955. return detail::write_data(strm, res.body.data(), res.body.size());
  11956. }
  11957. // Streaming body
  11958. if (send_body && res.content_provider_) {
  11959. if (!provider_done &&
  11960. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11961. return false;
  11962. }
  11963. res.content_provider_success_ = true;
  11964. }
  11965. return true;
  11966. }
  11967. inline bool
  11968. Server::write_content_with_provider(Stream &strm, const Request &req,
  11969. Response &res, const std::string &boundary,
  11970. const std::string &content_type) {
  11971. auto is_shutting_down = [this]() {
  11972. return this->svr_sock_ == INVALID_SOCKET;
  11973. };
  11974. if (res.content_length_ > 0) {
  11975. if (!detail::is_partial_content(req, res)) {
  11976. return detail::write_content(strm, res.content_provider_, 0,
  11977. res.content_length_, is_shutting_down);
  11978. } else if (req.ranges.size() == 1) {
  11979. auto offset_and_length = detail::get_range_offset_and_length(
  11980. req.ranges[0], res.content_length_);
  11981. return detail::write_content(strm, res.content_provider_,
  11982. offset_and_length.first,
  11983. offset_and_length.second, is_shutting_down);
  11984. } else {
  11985. return detail::write_multipart_ranges_data(
  11986. strm, req, res, boundary, content_type, res.content_length_,
  11987. is_shutting_down);
  11988. }
  11989. } else {
  11990. if (res.is_chunked_content_provider_) {
  11991. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11992. // re-negotiating here would disagree with them, e.g. once a handler's
  11993. // own Content-Encoding header suppresses the negotiation.
  11994. auto compressor = detail::make_compressor(res.content_coding_);
  11995. if (!compressor) {
  11996. compressor = detail::make_unique<detail::nocompressor>();
  11997. }
  11998. return detail::write_content_chunked(strm, res.content_provider_,
  11999. is_shutting_down, *compressor);
  12000. } else {
  12001. return detail::write_content_without_length(strm, res.content_provider_,
  12002. is_shutting_down);
  12003. }
  12004. }
  12005. }
  12006. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  12007. FormFields::iterator cur_field;
  12008. FormFiles::iterator cur_file;
  12009. auto is_text_field = false;
  12010. size_t count = 0;
  12011. if (read_content_core(
  12012. strm, req, res,
  12013. // Regular
  12014. [&](const char *buf, size_t n) {
  12015. // Prevent arithmetic overflow when checking sizes.
  12016. // Avoid computing (req.body.size() + n) directly because
  12017. // adding two unsigned `size_t` values can wrap around and
  12018. // produce a small result instead of indicating overflow.
  12019. // Instead, check using subtraction: ensure `n` does not
  12020. // exceed the remaining capacity `max_size() - size()`.
  12021. if (req.body.size() >= req.body.max_size() ||
  12022. n > req.body.max_size() - req.body.size()) {
  12023. return false;
  12024. }
  12025. // Limit decompressed body size to payload_max_length_ to protect
  12026. // against "zip bomb" attacks where a small compressed payload
  12027. // decompresses to a massive size.
  12028. if (payload_max_length_ > 0 &&
  12029. (req.body.size() >= payload_max_length_ ||
  12030. n > payload_max_length_ - req.body.size())) {
  12031. return false;
  12032. }
  12033. req.body.append(buf, n);
  12034. return true;
  12035. },
  12036. // Multipart FormData
  12037. [&](const FormData &file) {
  12038. if (CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT > 0 &&
  12039. count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  12040. output_error_log(Error::TooManyFormDataFiles, &req);
  12041. return false;
  12042. }
  12043. if (file.filename.empty()) {
  12044. cur_field = req.form.fields.emplace(
  12045. file.name, FormField{file.name, file.content, file.headers});
  12046. is_text_field = true;
  12047. } else {
  12048. cur_file = req.form.files.emplace(file.name, file);
  12049. is_text_field = false;
  12050. }
  12051. return true;
  12052. },
  12053. [&](const char *buf, size_t n) {
  12054. if (is_text_field) {
  12055. auto &content = cur_field->second.content;
  12056. if (content.size() + n > content.max_size()) { return false; }
  12057. content.append(buf, n);
  12058. } else {
  12059. auto &content = cur_file->second.content;
  12060. if (content.size() + n > content.max_size()) { return false; }
  12061. content.append(buf, n);
  12062. }
  12063. return true;
  12064. })) {
  12065. const auto &content_type = req.get_header_value("Content-Type");
  12066. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  12067. "application/x-www-form-urlencoded")) {
  12068. if (CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH > 0 &&
  12069. req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  12070. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  12071. output_error_log(Error::ExceedMaxPayloadSize, &req);
  12072. return false;
  12073. }
  12074. detail::parse_query_text(req.body, req.params);
  12075. }
  12076. return true;
  12077. }
  12078. return false;
  12079. }
  12080. inline bool Server::read_content_with_content_receiver(
  12081. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12082. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  12083. return read_content_core(strm, req, res, std::move(receiver),
  12084. std::move(multipart_header),
  12085. std::move(multipart_receiver));
  12086. }
  12087. inline bool Server::read_content_core(
  12088. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  12089. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  12090. detail::FormDataParser multipart_form_data_parser;
  12091. ContentReceiverWithProgress out;
  12092. if (req.is_multipart_form_data()) {
  12093. const auto &content_type = req.get_header_value("Content-Type");
  12094. std::string boundary;
  12095. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  12096. res.status = StatusCode::BadRequest_400;
  12097. output_error_log(Error::MultipartParsing, &req);
  12098. return false;
  12099. }
  12100. multipart_form_data_parser.set_boundary(std::move(boundary));
  12101. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  12102. return multipart_form_data_parser.parse(buf, n, multipart_header,
  12103. multipart_receiver);
  12104. };
  12105. } else {
  12106. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  12107. size_t /*len*/) { return receiver(buf, n); };
  12108. }
  12109. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  12110. // For non-SSL builds we still scan non-persistent connections for stray
  12111. // body bytes so the payload limit is enforced (413). On keep-alive,
  12112. // pending bytes may be the next request (issue #2450), so skip.
  12113. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  12114. if (!req.has_header("Content-Length") &&
  12115. !detail::is_chunked_transfer_encoding(req.headers)) {
  12116. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  12117. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  12118. auto has_data = strm.is_readable();
  12119. if (!has_data) {
  12120. auto s = strm.socket();
  12121. if (s != INVALID_SOCKET) {
  12122. has_data = detail::select_read(s, 0, 0) > 0;
  12123. }
  12124. }
  12125. if (has_data) {
  12126. // Route through the same decompressing reader used by the
  12127. // length-framed and chunked paths below, so payload_max_length_ is
  12128. // enforced on the decompressed size here too instead of only on the
  12129. // compressed wire bytes.
  12130. return detail::read_content(strm, req, payload_max_length_, res.status,
  12131. nullptr, out, true);
  12132. }
  12133. }
  12134. return true;
  12135. }
  12136. #else
  12137. if (!req.has_header("Content-Length") &&
  12138. !detail::is_chunked_transfer_encoding(req.headers)) {
  12139. return true;
  12140. }
  12141. #endif
  12142. // A second read would start where the first one stopped, or in the next
  12143. // request.
  12144. if (req.body_read_started_) { return false; }
  12145. // The client is waiting for this before it sends the body.
  12146. if (req.expect_100_continue_pending_) {
  12147. req.expect_100_continue_pending_ = false;
  12148. detail::write_response_line(strm, StatusCode::Continue_100);
  12149. strm.write("\r\n");
  12150. }
  12151. // Set before reading, since a receiver may also stop by throwing.
  12152. req.body_read_started_ = true;
  12153. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  12154. out, true)) {
  12155. return false;
  12156. }
  12157. req.body_consumed_ = true;
  12158. if (req.is_multipart_form_data()) {
  12159. if (!multipart_form_data_parser.is_valid()) {
  12160. res.status = StatusCode::BadRequest_400;
  12161. output_error_log(Error::MultipartParsing, &req);
  12162. return false;
  12163. }
  12164. }
  12165. return true;
  12166. }
  12167. inline bool Server::handle_file_request(Request &req, Response &res) {
  12168. if (!detail::is_valid_path(req.path)) { return false; }
  12169. for (const auto &entry : base_dirs_) {
  12170. // Prefix match, on a path segment boundary. A mount point of "/mount"
  12171. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  12172. // One that already ends in '/' (the root mount among them) carries its own
  12173. // boundary; set_mount_point() guarantees the mount point is not empty.
  12174. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  12175. (entry.mount_point.back() == '/' ||
  12176. req.path.size() == entry.mount_point.size() ||
  12177. req.path[entry.mount_point.size()] == '/')) {
  12178. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  12179. auto path = entry.base_dir + sub_path;
  12180. if (path.back() == '/') { path += "index.html"; }
  12181. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  12182. // but symlinks/junctions can still escape the base directory. A path
  12183. // that cannot be resolved, which includes one that does not exist, is
  12184. // not served from here.
  12185. std::string resolved_path;
  12186. if (!detail::canonicalize_path(path.c_str(), resolved_path)) { continue; }
  12187. if (!detail::is_path_within_base(resolved_path,
  12188. entry.resolved_base_dir)) {
  12189. res.status = StatusCode::Forbidden_403;
  12190. return true;
  12191. }
  12192. detail::FileStat stat(path);
  12193. if (stat.is_dir()) {
  12194. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12195. // in the name from reading as a scheme.
  12196. auto name = req.path.substr(req.path.rfind('/') + 1);
  12197. res.set_redirect("./" + encode_path_component(name) + "/",
  12198. StatusCode::MovedPermanently_301);
  12199. return true;
  12200. }
  12201. if (stat.is_file()) {
  12202. for (const auto &kv : entry.headers) {
  12203. res.set_header(kv.first, kv.second);
  12204. }
  12205. auto content_type = detail::find_content_type(
  12206. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12207. auto encoding = detail::EncodingType::None;
  12208. if (static_file_compression_) {
  12209. encoding = static_file_encoding(req, res, content_type, stat.size());
  12210. }
  12211. // The ETag names the representation actually sent, so a client that
  12212. // cached the compressed form revalidates against the compressed ETag
  12213. // and still gets a 304, while one that took identity keeps the plain
  12214. // ETag.
  12215. auto etag = detail::compute_etag(
  12216. stat, encoding == detail::EncodingType::None
  12217. ? std::string()
  12218. : std::string("-") + detail::encoding_name(encoding));
  12219. if (!etag.empty()) { res.set_header("ETag", etag); }
  12220. auto mtime = stat.mtime();
  12221. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12222. if (!last_modified.empty()) {
  12223. res.set_header("Last-Modified", last_modified);
  12224. }
  12225. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12226. check_if_range(req, etag, mtime);
  12227. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12228. if (!mm->is_open()) {
  12229. output_error_log(Error::OpenFile, &req);
  12230. return false;
  12231. }
  12232. detail::set_file_content_provider(res, mm, content_type, encoding);
  12233. if (req.method != "HEAD" && file_request_handler_) {
  12234. file_request_handler_(req, res);
  12235. }
  12236. return true;
  12237. } else {
  12238. output_error_log(Error::OpenFile, &req);
  12239. }
  12240. }
  12241. }
  12242. return false;
  12243. }
  12244. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12245. const std::string &etag,
  12246. time_t mtime) const {
  12247. // Handle conditional GET:
  12248. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12249. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12250. if (req.has_header("If-None-Match")) {
  12251. if (!etag.empty()) {
  12252. auto val =
  12253. detail::get_combined_header_value(req.headers, "If-None-Match");
  12254. // NOTE: We use exact string matching here. This works correctly
  12255. // because our server always generates weak ETags (W/"..."), and
  12256. // clients typically send back the same ETag they received.
  12257. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12258. // If-None-Match, where W/"x" and "x" would match, but this
  12259. // simplified implementation requires exact matches.
  12260. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12261. [&](const char *b, const char *e) {
  12262. auto seg_len = static_cast<size_t>(e - b);
  12263. return (seg_len == 1 && *b == '*') ||
  12264. (seg_len == etag.size() &&
  12265. std::equal(b, e, etag.begin()));
  12266. });
  12267. if (ret) {
  12268. res.status = StatusCode::NotModified_304;
  12269. return true;
  12270. }
  12271. }
  12272. } else if (req.has_header("If-Modified-Since")) {
  12273. auto val = req.get_header_value("If-Modified-Since");
  12274. auto t = detail::parse_http_date(val);
  12275. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12276. res.status = StatusCode::NotModified_304;
  12277. return true;
  12278. }
  12279. }
  12280. return false;
  12281. }
  12282. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12283. time_t mtime) const {
  12284. // Handle If-Range for partial content requests (RFC 9110
  12285. // Section 13.1.5). If-Range is only evaluated when Range header is
  12286. // present. If the validator matches, serve partial content; otherwise
  12287. // serve full content.
  12288. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12289. auto val = req.get_header_value("If-Range");
  12290. auto is_valid_range = [&]() {
  12291. if (detail::is_strong_etag(val)) {
  12292. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12293. // comparison.
  12294. return (!etag.empty() && val == etag);
  12295. } else if (detail::is_weak_etag(val)) {
  12296. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12297. return false;
  12298. } else {
  12299. // HTTP-date comparison
  12300. auto t = detail::parse_http_date(val);
  12301. return (t != static_cast<time_t>(-1) && mtime <= t);
  12302. }
  12303. };
  12304. if (!is_valid_range()) {
  12305. // Validator doesn't match: ignore Range and serve full content
  12306. req.ranges.clear();
  12307. return false;
  12308. }
  12309. }
  12310. return true;
  12311. }
  12312. inline socket_t
  12313. Server::create_server_socket(const std::string &host, int port,
  12314. int socket_flags,
  12315. SocketOptions socket_options) const {
  12316. return detail::create_socket(
  12317. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12318. ipv6_v6only_, std::move(socket_options),
  12319. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12320. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12321. output_error_log(Error::BindIPAddress, nullptr);
  12322. return false;
  12323. }
  12324. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12325. output_error_log(Error::Listen, nullptr);
  12326. return false;
  12327. }
  12328. return true;
  12329. });
  12330. }
  12331. inline int Server::bind_internal(const std::string &host, int port,
  12332. int socket_flags) {
  12333. if (is_decommissioned) { return -1; }
  12334. if (!is_valid()) { return -1; }
  12335. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12336. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12337. if (port == 0) {
  12338. struct sockaddr_storage addr;
  12339. socklen_t addr_len = sizeof(addr);
  12340. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12341. &addr_len) == -1) {
  12342. output_error_log(Error::GetSockName, nullptr);
  12343. return -1;
  12344. }
  12345. if (addr.ss_family == AF_INET) {
  12346. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12347. } else if (addr.ss_family == AF_INET6) {
  12348. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12349. } else {
  12350. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12351. return -1;
  12352. }
  12353. } else {
  12354. return port;
  12355. }
  12356. }
  12357. inline bool Server::listen_internal() {
  12358. // A stop() between bind and listen leaves nothing to accept on. Report
  12359. // failure instead of returning success without ever serving, and mark the
  12360. // server decommissioned the way any failed listen does so that a concurrent
  12361. // wait_until_ready() wakes up instead of spinning forever.
  12362. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12363. is_decommissioned = true;
  12364. return false;
  12365. }
  12366. auto ret = true;
  12367. is_running_ = true;
  12368. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12369. if (start_handler_) { start_handler_(); }
  12370. {
  12371. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12372. while (svr_sock_ != INVALID_SOCKET) {
  12373. #ifndef _WIN32
  12374. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12375. #endif
  12376. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12377. idle_interval_usec_);
  12378. if (val == 0) { // Timeout
  12379. task_queue->on_idle();
  12380. continue;
  12381. }
  12382. #ifndef _WIN32
  12383. }
  12384. #endif
  12385. #if defined _WIN32
  12386. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12387. // OVERLAPPED
  12388. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12389. #elif defined SOCK_CLOEXEC
  12390. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12391. #else
  12392. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12393. #endif
  12394. if (sock == INVALID_SOCKET) {
  12395. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12396. // touches the CRT errno, so the two have to be asked platform by
  12397. // platform rather than by testing errno here.
  12398. if (detail::is_accept_resource_error()) {
  12399. // The per-process descriptor limit or the network stack's buffer
  12400. // space has been reached. Try to accept new connections after a
  12401. // short sleep.
  12402. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12403. continue;
  12404. } else if (detail::is_accept_transient_error()) {
  12405. continue;
  12406. }
  12407. // Take the descriptor out of svr_sock_ before closing it: a later
  12408. // stop() would otherwise shutdown()/close() a value the OS may have
  12409. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12410. // gone. The exchange also settles the race with a concurrent stop(),
  12411. // since whichever side takes the descriptor closes it exactly once.
  12412. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12413. if (listen_sock != INVALID_SOCKET) {
  12414. detail::close_socket(listen_sock);
  12415. ret = false;
  12416. output_error_log(Error::Connection, nullptr);
  12417. } else {
  12418. ; // The server socket was closed by user.
  12419. }
  12420. break;
  12421. }
  12422. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12423. read_timeout_sec_, read_timeout_usec_);
  12424. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12425. write_timeout_sec_, write_timeout_usec_);
  12426. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12427. if (!task_queue->enqueue(
  12428. [this, sock]() { process_and_close_socket(sock); })) {
  12429. output_error_log(Error::ResourceExhaustion, nullptr);
  12430. detail::shutdown_socket(sock);
  12431. detail::close_socket(sock);
  12432. }
  12433. }
  12434. task_queue->shutdown();
  12435. }
  12436. is_decommissioned = !ret;
  12437. return ret;
  12438. }
  12439. inline bool Server::routing(Request &req, Response &res, Stream &strm,
  12440. bool skip_pre_routing) {
  12441. if (!skip_pre_routing && pre_routing_handler_ &&
  12442. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12443. return true;
  12444. }
  12445. // File handler
  12446. if ((req.method == "GET" || req.method == "HEAD") &&
  12447. handle_file_request(req, res)) {
  12448. return true;
  12449. }
  12450. const auto *custom = find_custom_entry(req.method);
  12451. // The second clause mirrors what expect_content() does unconditionally for
  12452. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12453. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12454. // `allprop`) would skip its handler and fall through to 404.
  12455. if (detail::expect_content(req) ||
  12456. (custom && !custom->handlers_for_content_reader.empty())) {
  12457. // Content reader handler
  12458. {
  12459. // Track whether the ContentReader was aborted due to the decompressed
  12460. // payload exceeding `payload_max_length_`.
  12461. // The user handler runs after the lambda returns, so we must restore the
  12462. // 413 status if the handler overwrites it.
  12463. bool content_reader_payload_too_large = false;
  12464. ContentReader reader(
  12465. [&](ContentReceiver receiver) {
  12466. auto result = read_content_with_content_receiver(
  12467. strm, req, res, std::move(receiver), nullptr, nullptr);
  12468. if (!result) {
  12469. output_error_log(Error::Read, &req);
  12470. if (res.status == StatusCode::PayloadTooLarge_413) {
  12471. content_reader_payload_too_large = true;
  12472. }
  12473. }
  12474. return result;
  12475. },
  12476. [&](FormDataHeader header, ContentReceiver receiver) {
  12477. auto result = read_content_with_content_receiver(
  12478. strm, req, res, nullptr, std::move(header),
  12479. std::move(receiver));
  12480. if (!result) {
  12481. output_error_log(Error::Read, &req);
  12482. if (res.status == StatusCode::PayloadTooLarge_413) {
  12483. content_reader_payload_too_large = true;
  12484. }
  12485. }
  12486. return result;
  12487. });
  12488. bool dispatched = false;
  12489. if (req.method == "POST") {
  12490. dispatched = dispatch_request_for_content_reader(
  12491. req, res, std::move(reader), post_handlers_for_content_reader_);
  12492. } else if (req.method == "PUT") {
  12493. dispatched = dispatch_request_for_content_reader(
  12494. req, res, std::move(reader), put_handlers_for_content_reader_);
  12495. } else if (req.method == "PATCH") {
  12496. dispatched = dispatch_request_for_content_reader(
  12497. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12498. } else if (req.method == "DELETE") {
  12499. dispatched = dispatch_request_for_content_reader(
  12500. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12501. } else if (custom) {
  12502. dispatched = dispatch_request_for_content_reader(
  12503. req, res, std::move(reader), custom->handlers_for_content_reader);
  12504. }
  12505. if (dispatched) {
  12506. if (content_reader_payload_too_large) {
  12507. // Enforce the limit: override any status the handler may have set
  12508. // and return false so the error path sends a plain 413 response.
  12509. res.status = StatusCode::PayloadTooLarge_413;
  12510. detail::clear_content(res);
  12511. return false;
  12512. }
  12513. return true;
  12514. }
  12515. }
  12516. // NOTE: `req.body` is not read here. For a regular handler the body is
  12517. // read inside dispatch_request(), after the route has matched and the
  12518. // pre-request handler has approved the request, so that a rejected
  12519. // request (e.g. failed authentication) never forces us to buffer a
  12520. // potentially large body.
  12521. }
  12522. // Regular handler
  12523. if (req.method == "GET" || req.method == "HEAD") {
  12524. return dispatch_request(req, res, get_handlers_, strm);
  12525. } else if (req.method == "POST") {
  12526. return dispatch_request(req, res, post_handlers_, strm);
  12527. } else if (req.method == "PUT") {
  12528. return dispatch_request(req, res, put_handlers_, strm);
  12529. } else if (req.method == "DELETE") {
  12530. return dispatch_request(req, res, delete_handlers_, strm);
  12531. } else if (req.method == "OPTIONS") {
  12532. return dispatch_request(req, res, options_handlers_, strm);
  12533. } else if (req.method == "PATCH") {
  12534. return dispatch_request(req, res, patch_handlers_, strm);
  12535. } else if (custom) {
  12536. return dispatch_request(req, res, custom->handlers, strm);
  12537. }
  12538. res.status = StatusCode::BadRequest_400;
  12539. return false;
  12540. }
  12541. inline bool Server::dispatch_request(Request &req, Response &res,
  12542. const Handlers &handlers, Stream &strm) {
  12543. for (const auto &x : handlers) {
  12544. const auto &matcher = x.first;
  12545. const auto &handler = x.second;
  12546. if (matcher->match(req)) {
  12547. req.matched_route = matcher->pattern();
  12548. // Run the pre-request handler before reading the body so a rejected
  12549. // request (e.g. failed authentication) never forces us to buffer a
  12550. // potentially large body. `req.matched_route` is available here.
  12551. if (pre_request_handler_ &&
  12552. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12553. return true;
  12554. }
  12555. // The route matched and the request was approved; read the body now.
  12556. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12557. output_error_log(Error::Read, &req);
  12558. return false;
  12559. }
  12560. handler(req, res);
  12561. return true;
  12562. }
  12563. }
  12564. return false;
  12565. }
  12566. // Decides the content coding for a response served straight from a file. Both
  12567. // the ETag, which has to name the representation actually sent, and
  12568. // `apply_static_file_compression()` go through this, so the two cannot drift
  12569. // apart.
  12570. inline detail::EncodingType
  12571. Server::static_file_encoding(const Request &req, const Response &res,
  12572. const std::string &content_type,
  12573. size_t length) const {
  12574. if (!static_file_compression_) { return detail::EncodingType::None; }
  12575. // Nothing to compress, and an empty file already answers with
  12576. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12577. // turn an empty body into a 20-byte gzip stream.
  12578. if (length == 0) { return detail::EncodingType::None; }
  12579. // A file that already fits in a single packet gains nothing from being made
  12580. // smaller, since it still travels in that one segment, and a file of a few
  12581. // bytes comes out larger than it went in.
  12582. if (length < static_file_compression_min_length_) {
  12583. return detail::EncodingType::None;
  12584. }
  12585. // RFC 9110 applies Range to the representation after content coding, so a
  12586. // compressed 206 would mean compressing the whole file and then slicing it.
  12587. // Serve ranges from the identity representation instead.
  12588. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12589. if (static_file_compression_max_length_ > 0 &&
  12590. length > static_file_compression_max_length_) {
  12591. return detail::EncodingType::None;
  12592. }
  12593. return detail::encoding_type(req, res, content_type);
  12594. }
  12595. // Compresses a file-backed content provider into `res.body`. Returns false when
  12596. // the response is left untouched.
  12597. inline bool Server::apply_static_file_compression(const Request &req,
  12598. Response &res) const {
  12599. auto type = res.content_coding_;
  12600. if (type == detail::EncodingType::None || !res.content_provider_) {
  12601. return false;
  12602. }
  12603. auto compressor = detail::make_compressor(type);
  12604. if (!compressor) { return false; }
  12605. output_pre_compression_log(req, res);
  12606. std::string compressed;
  12607. if (!detail::compress_content_provider(res.content_provider_,
  12608. res.content_length_, *compressor,
  12609. compressed)) {
  12610. return false;
  12611. }
  12612. res.body.swap(compressed);
  12613. // The provider was consumed in full, so its releaser hears about a success.
  12614. res.content_provider_success_ = true;
  12615. detail::clear_content_provider(res);
  12616. res.set_header("Content-Encoding", detail::encoding_name(type));
  12617. res.set_header("Vary", "Accept-Encoding");
  12618. return true;
  12619. }
  12620. inline void Server::apply_ranges(const Request &req, Response &res,
  12621. std::string &content_type,
  12622. std::string &boundary) const {
  12623. // A known-length content provider leaves `res.body` empty, so the compressor
  12624. // at the end of this function never runs for one (issue #2545). A file-backed
  12625. // provider is fully readable right here, so compress it and answer with an
  12626. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12627. // takes the same path as `set_content()` from here on. Range requests never
  12628. // get a content coding, so `Content-Range` still names identity bytes and
  12629. // none of the range handling below applies.
  12630. if (apply_static_file_compression(req, res)) { return; }
  12631. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12632. auto it = res.headers.find("Content-Type");
  12633. if (it != res.headers.end()) {
  12634. content_type = it->second;
  12635. res.headers.erase(it);
  12636. }
  12637. boundary = detail::make_multipart_data_boundary();
  12638. res.set_header("Content-Type",
  12639. "multipart/byteranges; boundary=" + boundary);
  12640. }
  12641. auto type = detail::encoding_type(req, res);
  12642. if (res.body.empty()) {
  12643. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12644. res.status == StatusCode::PartialContent_206) {
  12645. auto offset_and_length = detail::get_range_offset_and_length(
  12646. req.ranges[0], res.content_length_);
  12647. auto content_range = detail::make_content_range_header_field(
  12648. offset_and_length, res.content_length_);
  12649. res.set_header("Content-Range", content_range);
  12650. } else if (res.is_chunked_content_provider_) {
  12651. res.content_coding_ = type;
  12652. if (type != detail::EncodingType::None) {
  12653. res.set_header("Content-Encoding", detail::encoding_name(type));
  12654. res.set_header("Vary", "Accept-Encoding");
  12655. }
  12656. }
  12657. } else {
  12658. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12659. ;
  12660. } else if (req.ranges.size() == 1) {
  12661. auto offset_and_length =
  12662. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12663. auto offset = offset_and_length.first;
  12664. auto length = offset_and_length.second;
  12665. auto content_range = detail::make_content_range_header_field(
  12666. offset_and_length, res.body.size());
  12667. res.set_header("Content-Range", content_range);
  12668. assert(offset + length <= res.body.size());
  12669. res.body = res.body.substr(offset, length);
  12670. } else {
  12671. std::string data;
  12672. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12673. res.body.size(), data);
  12674. res.body.swap(data);
  12675. }
  12676. if (type != detail::EncodingType::None) {
  12677. output_pre_compression_log(req, res);
  12678. if (auto compressor = detail::make_compressor(type)) {
  12679. std::string compressed;
  12680. if (compressor->compress(res.body.data(), res.body.size(), true,
  12681. [&](const char *data, size_t data_len) {
  12682. compressed.append(data, data_len);
  12683. return true;
  12684. })) {
  12685. res.body.swap(compressed);
  12686. res.set_header("Content-Encoding", detail::encoding_name(type));
  12687. res.set_header("Vary", "Accept-Encoding");
  12688. }
  12689. }
  12690. }
  12691. res.content_length_ = res.body.size();
  12692. }
  12693. }
  12694. inline bool Server::dispatch_request_for_content_reader(
  12695. Request &req, Response &res, ContentReader content_reader,
  12696. const HandlersForContentReader &handlers) const {
  12697. for (const auto &x : handlers) {
  12698. const auto &matcher = x.first;
  12699. const auto &handler = x.second;
  12700. if (matcher->match(req)) {
  12701. req.matched_route = matcher->pattern();
  12702. if (!pre_request_handler_ ||
  12703. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12704. handler(req, res, content_reader);
  12705. }
  12706. return true;
  12707. }
  12708. }
  12709. return false;
  12710. }
  12711. inline std::string
  12712. get_client_ip(const std::string &x_forwarded_for,
  12713. const std::vector<std::string> &trusted_proxies) {
  12714. // X-Forwarded-For is a comma-separated list per RFC 7239
  12715. std::vector<std::string> ip_list;
  12716. detail::split(x_forwarded_for.data(),
  12717. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12718. [&](const char *b, const char *e) {
  12719. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12720. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12721. });
  12722. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12723. // no segments. Signal "no client IP derived" with an empty string so the
  12724. // caller can fall back to the connection-level remote address.
  12725. if (ip_list.empty()) { return std::string(); }
  12726. // Each hop appends the address it received the request from, so the rightmost
  12727. // entries are the ones written by our own infrastructure while the leftmost
  12728. // are whatever the original client chose to send. Walk from the right and
  12729. // skip trusted proxies; the first address that is not a trusted proxy is the
  12730. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12731. // from the left instead lets a client forge an arbitrary address by following
  12732. // it with a trusted proxy's address, which the left-to-right scan then
  12733. // returned as the client.
  12734. for (size_t i = ip_list.size(); i-- > 0;) {
  12735. const auto &ip = ip_list[i];
  12736. auto is_trusted_proxy =
  12737. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12738. [&](const std::string &proxy) { return ip == proxy; });
  12739. if (!is_trusted_proxy) { return ip; }
  12740. }
  12741. // Every hop was a trusted proxy; fall back to the first entry.
  12742. return ip_list.front();
  12743. }
  12744. inline bool
  12745. Server::process_request(Stream &strm, const std::string &remote_addr,
  12746. int remote_port, const std::string &local_addr,
  12747. int local_port, bool close_connection,
  12748. bool &connection_closed,
  12749. const std::function<void(Request &)> &setup_request,
  12750. bool *websocket_upgraded) {
  12751. std::array<char, 2048> buf{};
  12752. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12753. // The read timeout bounds the request line and headers as a whole, so a
  12754. // client sending them a byte at a time cannot hold the worker any longer.
  12755. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12756. // Connection has been closed on client
  12757. if (!line_reader.getline()) { return false; }
  12758. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12759. // clients send an extra CRLF after a request body, which would otherwise be
  12760. // parsed as the next request on a persistent connection.
  12761. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12762. return false;
  12763. }
  12764. Request req;
  12765. req.start_time_ = std::chrono::steady_clock::now();
  12766. req.remote_addr = remote_addr;
  12767. req.remote_port = remote_port;
  12768. req.local_addr = local_addr;
  12769. req.local_port = local_port;
  12770. Response res;
  12771. res.version = "HTTP/1.1";
  12772. res.headers = default_headers_;
  12773. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12774. // close the connection after that response, whichever path wrote it (an
  12775. // error status, a handler, or a rejected request). Reading on would also
  12776. // parse whatever the client sent next on a connection it considers done.
  12777. auto honor_connection_close = detail::scope_exit([&] {
  12778. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12779. connection_closed = true;
  12780. }
  12781. });
  12782. // Request line and headers. A rejected message leaves the rest of it (and
  12783. // any body) unread, so the connection cannot be reused: the leftover bytes
  12784. // would be parsed as the next request.
  12785. if (!parse_request_line(line_reader.ptr(), req)) {
  12786. connection_closed = true;
  12787. res.status = StatusCode::BadRequest_400;
  12788. output_error_log(Error::InvalidRequestLine, &req);
  12789. return write_response(strm, close_connection, req, res);
  12790. }
  12791. // Request headers
  12792. if (!detail::read_headers(strm, req.headers)) {
  12793. connection_closed = true;
  12794. res.status = StatusCode::BadRequest_400;
  12795. output_error_log(Error::InvalidHeaders, &req);
  12796. return write_response(strm, close_connection, req, res);
  12797. }
  12798. strm.set_max_timeout(0);
  12799. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12800. // which would otherwise let an intermediary and this parser disagree on
  12801. // where the body ends and enable request smuggling. Three cases: a
  12802. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12803. // or empty), which would otherwise be read as "no body"; a non-zero
  12804. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12805. // tolerated for compatibility with existing clients); and a
  12806. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12807. // length undeterminable. None of them may fall through to the "no body"
  12808. // path, or the body bytes are parsed as the next request on a persistent
  12809. // connection.
  12810. auto is_invalid_content_length = false;
  12811. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12812. is_invalid_content_length);
  12813. if (is_invalid_content_length ||
  12814. detail::has_conflicting_content_length(req.headers) ||
  12815. (req.has_header("Transfer-Encoding") &&
  12816. !detail::is_chunked_transfer_encoding(req.headers))) {
  12817. connection_closed = true;
  12818. res.status = StatusCode::BadRequest_400;
  12819. return write_response(strm, close_connection, req, res);
  12820. }
  12821. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12822. // HTTP/1.0 request, is honoured, but the connection closes after the
  12823. // response.
  12824. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12825. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12826. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12827. // the same authority.
  12828. auto host_count = req.get_header_value_count("Host");
  12829. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12830. !detail::fields::is_host(req.get_header_value("Host"))) {
  12831. connection_closed = true;
  12832. res.status = StatusCode::BadRequest_400;
  12833. output_error_log(Error::InvalidHeaders, &req);
  12834. return write_response(strm, close_connection, req, res);
  12835. }
  12836. // Check if the request URI doesn't exceed the limit
  12837. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12838. connection_closed = true;
  12839. res.status = StatusCode::UriTooLong_414;
  12840. output_error_log(Error::ExceedUriMaxLength, &req);
  12841. return write_response(strm, close_connection, req, res);
  12842. }
  12843. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12844. connection_closed = true;
  12845. }
  12846. if (req.version == "HTTP/1.0" &&
  12847. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12848. connection_closed = true;
  12849. }
  12850. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12851. // itself a trusted proxy. Otherwise any direct client could spoof
  12852. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12853. auto is_trusted_peer = std::any_of(
  12854. trusted_proxies_.begin(), trusted_proxies_.end(),
  12855. [&](const std::string &proxy) { return proxy == remote_addr; });
  12856. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12857. // Some proxies append the address they observed as a separate
  12858. // X-Forwarded-For field line instead of extending the one the client sent
  12859. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12860. // be scanned. Reading only the first occurrence would hand back the
  12861. // client-supplied, and therefore forgeable, value.
  12862. auto x_forwarded_for =
  12863. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12864. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12865. req.remote_addr = derived.empty() ? remote_addr : derived;
  12866. } else {
  12867. req.remote_addr = remote_addr;
  12868. }
  12869. req.remote_port = remote_port;
  12870. req.local_addr = local_addr;
  12871. req.local_port = local_port;
  12872. if (req.has_header("Accept")) {
  12873. auto accept_header =
  12874. detail::get_combined_header_value(req.headers, "Accept");
  12875. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12876. connection_closed = true;
  12877. res.status = StatusCode::BadRequest_400;
  12878. output_error_log(Error::HTTPParsing, &req);
  12879. return write_response(strm, close_connection, req, res);
  12880. }
  12881. }
  12882. if (req.has_header("Range")) {
  12883. const auto &range_header_value = req.get_header_value("Range");
  12884. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12885. connection_closed = true;
  12886. res.status = StatusCode::RangeNotSatisfiable_416;
  12887. output_error_log(Error::InvalidRangeHeader, &req);
  12888. return write_response(strm, close_connection, req, res);
  12889. }
  12890. }
  12891. if (setup_request) { setup_request(req); }
  12892. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12893. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12894. // must be ignored. An expectation we do not recognize is left alone; the
  12895. // 417 the section allows for one is a MAY, not a requirement.
  12896. //
  12897. // `100 Continue` itself is deferred until the body is actually read (see
  12898. // read_content_core), so a request rejected by a later handler never
  12899. // invites the client to send a body nobody will read.
  12900. if (req.version != "HTTP/1.0" &&
  12901. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12902. int status = StatusCode::Continue_100;
  12903. if (expect_100_continue_handler_) {
  12904. status = expect_100_continue_handler_(req, res);
  12905. }
  12906. if (status == StatusCode::Continue_100) {
  12907. req.expect_100_continue_pending_ = true;
  12908. } else {
  12909. if (res.status == -1) { res.status = status; }
  12910. connection_closed = true;
  12911. return write_response(strm, true, req, res);
  12912. }
  12913. }
  12914. // Setup `is_connection_closed` method
  12915. auto sock = strm.socket();
  12916. req.is_connection_closed = [sock]() {
  12917. return !detail::is_socket_alive(sock);
  12918. };
  12919. // WebSocket upgrade
  12920. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12921. // that authentication and other middleware can reject the request with an
  12922. // HTTP response (e.g., 401) before the protocol switches.
  12923. // The response says so when this connection closes after it.
  12924. auto close_after_response = close_connection || connection_closed;
  12925. // An upgrade request has been through pre-routing before it reaches routing()
  12926. auto is_upgrade = detail::is_websocket_upgrade(req);
  12927. if (is_upgrade) {
  12928. // A response given here leaves the body unread, and it would be parsed as
  12929. // the next request.
  12930. auto close_if_answered =
  12931. close_after_response || detail::has_framed_body(req);
  12932. if (pre_routing_handler_ &&
  12933. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12934. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12935. return write_response_with_content(strm, close_if_answered, req, res);
  12936. }
  12937. // Find matching WebSocket handler
  12938. for (const auto &entry : websocket_handlers_) {
  12939. if (entry.matcher->match(req)) {
  12940. req.matched_route = entry.matcher->pattern();
  12941. if (pre_request_handler_ &&
  12942. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12943. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12944. return write_response_with_content(strm, close_if_answered, req, res);
  12945. }
  12946. // Compute accept key
  12947. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12948. auto accept_key = detail::websocket_accept_key(client_key);
  12949. // Negotiate subprotocol
  12950. std::string selected_subprotocol;
  12951. if (entry.sub_protocol_selector) {
  12952. auto protocol_header = detail::get_combined_header_value(
  12953. req.headers, "Sec-WebSocket-Protocol");
  12954. if (!protocol_header.empty()) {
  12955. std::vector<std::string> protocols;
  12956. detail::split(protocol_header.data(),
  12957. protocol_header.data() + protocol_header.size(), ',',
  12958. [&](const char *b, const char *e) {
  12959. protocols.emplace_back(b, e);
  12960. });
  12961. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12962. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12963. if (std::find(protocols.begin(), protocols.end(),
  12964. selected_subprotocol) == protocols.end()) {
  12965. selected_subprotocol.clear();
  12966. }
  12967. }
  12968. }
  12969. // Send 101 Switching Protocols
  12970. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12971. "Upgrade: websocket\r\n"
  12972. "Connection: Upgrade\r\n"
  12973. "Sec-WebSocket-Accept: " +
  12974. accept_key + "\r\n";
  12975. if (!selected_subprotocol.empty()) {
  12976. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12977. return false;
  12978. }
  12979. handshake_response +=
  12980. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12981. }
  12982. handshake_response += "\r\n";
  12983. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12984. 0) {
  12985. return false;
  12986. }
  12987. connection_closed = true;
  12988. if (websocket_upgraded) { *websocket_upgraded = true; }
  12989. {
  12990. #ifdef CPPHTTPLIB_SSL_ENABLED
  12991. if (req.ssl) {
  12992. // wss: the heartbeat ping thread and the read path enter the same
  12993. // TLS session from different threads. Hand the WebSocket a stream
  12994. // that serializes every TLS call, so the shared SSLSocketStream on
  12995. // the plain HTTP/HTTPS paths stays untouched.
  12996. auto ws_strm =
  12997. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12998. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12999. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  13000. write_timeout_sec_, write_timeout_usec_));
  13001. ws::WebSocket ws(std::move(ws_strm), req, true,
  13002. websocket_ping_interval_sec_,
  13003. websocket_max_missed_pongs_);
  13004. entry.handler(req, ws);
  13005. return true;
  13006. }
  13007. #endif
  13008. // Use WebSocket-specific read timeout instead of HTTP timeout
  13009. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  13010. 0);
  13011. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  13012. websocket_max_missed_pongs_);
  13013. entry.handler(req, ws);
  13014. }
  13015. return true;
  13016. }
  13017. }
  13018. // No WebSocket route: route it as a plain HTTP request
  13019. }
  13020. // Routing
  13021. auto routed = false;
  13022. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  13023. routed = routing(req, res, strm, is_upgrade);
  13024. #else
  13025. try {
  13026. routed = routing(req, res, strm, is_upgrade);
  13027. } catch (std::exception &) {
  13028. if (exception_handler_) {
  13029. auto ep = std::current_exception();
  13030. exception_handler_(req, res, ep);
  13031. routed = true;
  13032. } else {
  13033. res.status = StatusCode::InternalServerError_500;
  13034. }
  13035. } catch (...) {
  13036. if (exception_handler_) {
  13037. auto ep = std::current_exception();
  13038. exception_handler_(req, res, ep);
  13039. routed = true;
  13040. } else {
  13041. res.status = StatusCode::InternalServerError_500;
  13042. }
  13043. }
  13044. #endif
  13045. auto ret = false;
  13046. if (routed) {
  13047. if (res.status == -1) {
  13048. res.status = req.ranges.empty() ? StatusCode::OK_200
  13049. : StatusCode::PartialContent_206;
  13050. }
  13051. // Before the Range checks below, so they see the body's own length.
  13052. detail::prefer_assigned_body(res);
  13053. // Serve file content by using a content provider
  13054. auto file_open_error = false;
  13055. if (!res.file_content_path_.empty()) {
  13056. const auto &path = res.file_content_path_;
  13057. auto mm = std::make_shared<detail::mmap>(path.c_str());
  13058. if (!mm->is_open()) {
  13059. res.status = StatusCode::NotFound_404;
  13060. output_error_log(Error::OpenFile, &req);
  13061. file_open_error = true;
  13062. } else {
  13063. auto content_type = res.file_content_content_type_;
  13064. if (content_type.empty()) {
  13065. // One the handler set after set_file_content()
  13066. content_type = res.get_header_value("Content-Type");
  13067. }
  13068. if (content_type.empty()) {
  13069. content_type = detail::find_content_type(
  13070. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  13071. }
  13072. detail::set_file_content_provider(
  13073. res, mm, content_type,
  13074. static_file_encoding(req, res, content_type, mm->size()));
  13075. }
  13076. }
  13077. if (file_open_error) {
  13078. ret = write_response(strm, close_after_response, req, res);
  13079. } else if (detail::range_error(req, res)) {
  13080. detail::clear_content(res);
  13081. res.status = StatusCode::RangeNotSatisfiable_416;
  13082. ret = write_response(strm, close_after_response, req, res);
  13083. } else {
  13084. ret = write_response_with_content(strm, close_after_response, req, res);
  13085. }
  13086. } else {
  13087. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  13088. ret = write_response(strm, close_after_response, req, res);
  13089. }
  13090. // Drain any unconsumed framed body to prevent request smuggling on
  13091. // keep-alive. Without framing there is no body to drain — reading would
  13092. // consume the next request (issue #2450). If the response has committed the
  13093. // connection to close, there is no next request to protect. A body read in
  13094. // part cannot be drained from where it stopped, so the connection closes.
  13095. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  13096. !detail::has_header_token(res.headers, "Connection", "close")) {
  13097. int dummy_status;
  13098. if (req.body_read_started_ ||
  13099. !detail::read_content(
  13100. strm, req, payload_max_length_, dummy_status, nullptr,
  13101. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  13102. connection_closed = true;
  13103. }
  13104. }
  13105. return ret;
  13106. }
  13107. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  13108. inline bool Server::process_and_close_socket(socket_t sock) {
  13109. std::string remote_addr;
  13110. int remote_port = 0;
  13111. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  13112. std::string local_addr;
  13113. int local_port = 0;
  13114. detail::get_local_ip_and_port(sock, local_addr, local_port);
  13115. bool websocket_upgraded = false;
  13116. auto ret = serve_guarded([&]() {
  13117. return detail::process_server_socket(
  13118. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  13119. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13120. write_timeout_usec_,
  13121. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  13122. return process_request(strm, remote_addr, remote_port, local_addr,
  13123. local_port, close_connection,
  13124. connection_closed, nullptr,
  13125. &websocket_upgraded);
  13126. });
  13127. });
  13128. detail::drain_and_close_socket(sock);
  13129. return ret;
  13130. }
  13131. inline void Server::output_log(const Request &req, const Response &res) const {
  13132. if (logger_) {
  13133. std::lock_guard<std::mutex> guard(logger_mutex_);
  13134. logger_(req, res);
  13135. }
  13136. }
  13137. inline void Server::output_pre_compression_log(const Request &req,
  13138. const Response &res) const {
  13139. if (pre_compression_logger_) {
  13140. std::lock_guard<std::mutex> guard(logger_mutex_);
  13141. pre_compression_logger_(req, res);
  13142. }
  13143. }
  13144. inline void Server::output_error_log(const Error &err,
  13145. const Request *req) const {
  13146. if (error_logger_) {
  13147. std::lock_guard<std::mutex> guard(logger_mutex_);
  13148. error_logger_(err, req);
  13149. }
  13150. }
  13151. /*
  13152. * Group 5: ClientImpl and Client (Universal) implementation
  13153. */
  13154. // HTTP client implementation
  13155. inline ClientImpl::ClientImpl(const std::string &host)
  13156. : ClientImpl(host, 80, std::string(), std::string()) {}
  13157. inline ClientImpl::ClientImpl(const std::string &host, int port)
  13158. : ClientImpl(host, port, std::string(), std::string()) {}
  13159. inline ClientImpl::ClientImpl(const std::string &host, int port,
  13160. const std::string &client_cert_path,
  13161. const std::string &client_key_path)
  13162. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  13163. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  13164. inline ClientImpl::~ClientImpl() {
  13165. // Wait until all the requests in flight are handled.
  13166. size_t retry_count = 10;
  13167. while (retry_count-- > 0) {
  13168. {
  13169. std::lock_guard<std::mutex> guard(socket_mutex_);
  13170. if (socket_requests_in_flight_ == 0) { break; }
  13171. }
  13172. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  13173. }
  13174. std::lock_guard<std::mutex> guard(socket_mutex_);
  13175. shutdown_socket(socket_);
  13176. close_socket(socket_);
  13177. }
  13178. inline bool ClientImpl::is_valid() const { return true; }
  13179. inline bool
  13180. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  13181. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  13182. if (no_proxy_entries_.empty()) { return true; }
  13183. // host_ is const so its normalized form is invariant; cache it. The
  13184. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  13185. if (host == host_) {
  13186. if (!host_normalized_valid_) {
  13187. host_normalized_ = detail::normalize_target(host_);
  13188. host_normalized_valid_ = true;
  13189. }
  13190. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  13191. }
  13192. auto target = detail::normalize_target(host);
  13193. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  13194. }
  13195. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  13196. if (is_proxy_enabled_for_host(host_)) {
  13197. return detail::create_client_socket(
  13198. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13199. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13200. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13201. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13202. }
  13203. // Check is custom IP or hostname specified for host_
  13204. std::string connect_host;
  13205. std::string ip;
  13206. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13207. return detail::create_client_socket(
  13208. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13209. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13210. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13211. write_timeout_usec_, interface_, error);
  13212. }
  13213. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13214. Error &error) {
  13215. auto sock = create_client_socket(error);
  13216. if (sock == INVALID_SOCKET) { return false; }
  13217. socket.sock = sock;
  13218. return true;
  13219. }
  13220. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13221. return create_and_connect_socket(socket, error);
  13222. }
  13223. inline bool ClientImpl::setup_proxy_connection(
  13224. Socket & /*socket*/,
  13225. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13226. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13227. return true;
  13228. }
  13229. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13230. bool /*shutdown_gracefully*/) {
  13231. // If there are any requests in flight from threads other than us, then it's
  13232. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13233. assert(socket_requests_in_flight_ == 0 ||
  13234. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13235. }
  13236. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13237. if (socket.sock == INVALID_SOCKET) { return; }
  13238. detail::shutdown_socket(socket.sock);
  13239. }
  13240. inline void ClientImpl::close_socket(Socket &socket) {
  13241. // If there are requests in flight in another thread, usually closing
  13242. // the socket will be fine and they will simply receive an error when
  13243. // using the closed socket, but it is still a bug since rarely the OS
  13244. // may reassign the socket id to be used for a new socket, and then
  13245. // suddenly they will be operating on a live socket that is different
  13246. // than the one they intended!
  13247. assert(socket_requests_in_flight_ == 0 ||
  13248. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13249. // It is also a bug if this happens while SSL is still active
  13250. #ifdef CPPHTTPLIB_SSL_ENABLED
  13251. assert(socket.ssl == nullptr);
  13252. #endif
  13253. if (socket.sock == INVALID_SOCKET) { return; }
  13254. detail::close_socket(socket.sock);
  13255. socket.sock = INVALID_SOCKET;
  13256. }
  13257. inline void ClientImpl::disconnect(bool gracefully) {
  13258. shutdown_ssl(socket_, gracefully);
  13259. shutdown_socket(socket_);
  13260. close_socket(socket_);
  13261. }
  13262. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13263. Response &res,
  13264. bool skip_100_continue) const {
  13265. std::array<char, 2048> buf{};
  13266. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13267. if (!line_reader.getline()) { return false; }
  13268. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13269. res.reason)) {
  13270. return req.method == "CONNECT";
  13271. }
  13272. // Skip interim (1xx) responses along with their header fields, except a 100
  13273. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13274. // HTTP on the connection, so it is final. A server sending them without end
  13275. // would hold the client, so there may be only so many.
  13276. size_t interim_count = 0;
  13277. while (100 <= res.status && res.status < 200 &&
  13278. res.status != StatusCode::SwitchingProtocol_101 &&
  13279. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13280. if (++interim_count > CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT) {
  13281. return false;
  13282. }
  13283. Headers interim_headers;
  13284. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13285. if (!line_reader.getline()) { return false; } // next response line
  13286. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13287. res.reason)) {
  13288. return false;
  13289. }
  13290. }
  13291. return true;
  13292. }
  13293. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13294. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13295. // A same-origin redirect and a digest retry send through here again. Only
  13296. // the call the caller made reports a failure, once, with its request.
  13297. auto outermost = send_depth_++ == 0;
  13298. auto se = detail::scope_exit([&] { send_depth_--; });
  13299. if (outermost) { error = Error::Success; }
  13300. auto ret = send_(req, res, error);
  13301. if (error == Error::SSLPeerCouldBeClosed_) {
  13302. assert(!ret);
  13303. ret = send_(req, res, error);
  13304. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13305. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13306. }
  13307. // Also an answer that carries an error, such as a proxy's 407
  13308. if (outermost && error != Error::Success) { output_error_log(error, &req); }
  13309. return ret;
  13310. }
  13311. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13312. #ifdef CPPHTTPLIB_SSL_ENABLED
  13313. // Don't let an earlier attempt's TLS error show up in this one's Result. A
  13314. // client that failed to set up its TLS context keeps reporting why.
  13315. if (is_valid()) {
  13316. last_ssl_error_ = 0;
  13317. last_backend_error_ = 0;
  13318. }
  13319. #endif
  13320. {
  13321. std::lock_guard<std::mutex> guard(socket_mutex_);
  13322. // Set this to false immediately - if it ever gets set to true by the end
  13323. // of the request, we know another thread instructed us to close the
  13324. // socket.
  13325. socket_should_be_closed_when_request_is_done_ = false;
  13326. auto is_alive = false;
  13327. if (socket_.is_open()) {
  13328. is_alive = detail::is_socket_alive(socket_.sock);
  13329. #ifdef CPPHTTPLIB_SSL_ENABLED
  13330. if (is_alive && is_ssl()) {
  13331. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13332. is_alive = false;
  13333. }
  13334. }
  13335. #endif
  13336. if (!is_alive) {
  13337. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13338. disconnect(/*gracefully=*/false);
  13339. }
  13340. }
  13341. if (!is_alive) {
  13342. if (!ensure_socket_connection(socket_, error)) { return false; }
  13343. {
  13344. auto success = true;
  13345. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13346. error)) {
  13347. return success;
  13348. }
  13349. }
  13350. }
  13351. // Mark the current socket as being in use so that it cannot be closed by
  13352. // anyone else while this request is ongoing, even though we will be
  13353. // releasing the mutex.
  13354. if (socket_requests_in_flight_ > 1) {
  13355. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13356. }
  13357. socket_requests_in_flight_ += 1;
  13358. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13359. }
  13360. for (const auto &header : default_headers_) {
  13361. if (req.headers.find(header.first) == req.headers.end()) {
  13362. req.headers.insert(header);
  13363. }
  13364. }
  13365. auto ret = false;
  13366. auto close_connection = !keep_alive_;
  13367. auto se = detail::scope_exit([&]() {
  13368. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13369. std::lock_guard<std::mutex> guard(socket_mutex_);
  13370. socket_requests_in_flight_ -= 1;
  13371. if (socket_requests_in_flight_ <= 0) {
  13372. assert(socket_requests_in_flight_ == 0);
  13373. socket_requests_are_from_thread_ = std::thread::id();
  13374. }
  13375. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13376. !ret) {
  13377. disconnect(/*gracefully=*/true);
  13378. }
  13379. });
  13380. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13381. return handle_request(strm, req, res, close_connection, error);
  13382. });
  13383. if (!ret) {
  13384. if (error == Error::Success) { error = Error::Unknown; }
  13385. }
  13386. return ret;
  13387. }
  13388. inline Result ClientImpl::send(const Request &req) {
  13389. auto req2 = req;
  13390. return send_(std::move(req2));
  13391. }
  13392. inline Result ClientImpl::send_(Request &&req) {
  13393. auto res = detail::make_unique<Response>();
  13394. auto error = Error::Success;
  13395. #ifdef CPPHTTPLIB_SSL_ENABLED
  13396. // Hold the request lock until the Result has read this request's TLS error
  13397. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13398. #endif
  13399. auto ret = send(req, *res, error);
  13400. #ifdef CPPHTTPLIB_SSL_ENABLED
  13401. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13402. last_ssl_error_, last_backend_error_};
  13403. #else
  13404. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13405. #endif
  13406. }
  13407. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13408. const std::string &ct) {
  13409. (void)for_stream;
  13410. // Default headers are meant for the origin and may carry its credentials, so
  13411. // keep them off the CONNECT request the proxy reads.
  13412. if (r.method != "CONNECT") {
  13413. for (const auto &header : default_headers_) {
  13414. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13415. }
  13416. }
  13417. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13418. // prepend it rather than appending it after the caller's own fields.
  13419. if (!r.has_header("Host")) {
  13420. r.headers.emplace_front(
  13421. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13422. address_family_));
  13423. }
  13424. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13425. if (!r.content_receiver) {
  13426. if (!r.has_header("Accept-Encoding")) {
  13427. std::string accept_encoding;
  13428. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13429. accept_encoding = "br";
  13430. #endif
  13431. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13432. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13433. accept_encoding += "gzip, deflate";
  13434. #endif
  13435. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13436. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13437. accept_encoding += "zstd";
  13438. #endif
  13439. r.set_header("Accept-Encoding", accept_encoding);
  13440. }
  13441. detail::add_default_user_agent_header(r);
  13442. }
  13443. if (!r.body.empty()) {
  13444. if (!ct.empty() && !r.has_header("Content-Type")) {
  13445. r.headers.emplace("Content-Type", ct);
  13446. }
  13447. if (!r.has_header("Content-Length")) {
  13448. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13449. }
  13450. }
  13451. }
  13452. inline ClientImpl::StreamHandle
  13453. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13454. const Params &params, const Headers &headers,
  13455. const std::string &body,
  13456. const std::string &content_type) {
  13457. // Encode the target exactly like the buffered send path does, so that the
  13458. // same `path` produces the same request line through either API.
  13459. auto raw_query_path =
  13460. params.empty() ? path : append_query_params(path, params);
  13461. Request req;
  13462. req.method = method;
  13463. req.path = detail::encode_request_target(raw_query_path, path_encode_);
  13464. req.headers = headers;
  13465. req.body = body;
  13466. prepare_default_headers(req, true, content_type);
  13467. auto handle = open_stream_(req);
  13468. // Like a buffered request, a stream that fails to open is reported once
  13469. if (handle.error != Error::Success) { output_error_log(handle.error, &req); }
  13470. return handle;
  13471. }
  13472. inline ClientImpl::StreamHandle ClientImpl::open_stream_(Request &req) {
  13473. StreamHandle handle;
  13474. handle.response = detail::make_unique<Response>();
  13475. handle.error = Error::Success;
  13476. handle.connection_ = detail::make_unique<ClientConnection>();
  13477. {
  13478. std::lock_guard<std::mutex> guard(socket_mutex_);
  13479. auto is_alive = false;
  13480. if (socket_.is_open()) {
  13481. is_alive = detail::is_socket_alive(socket_.sock);
  13482. #ifdef CPPHTTPLIB_SSL_ENABLED
  13483. if (is_alive && is_ssl()) {
  13484. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13485. is_alive = false;
  13486. }
  13487. }
  13488. #endif
  13489. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13490. }
  13491. if (!is_alive) {
  13492. if (!ensure_socket_connection(socket_, handle.error)) {
  13493. handle.response.reset();
  13494. return handle;
  13495. }
  13496. {
  13497. auto success = true;
  13498. auto start_time = std::chrono::steady_clock::now();
  13499. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13500. success, handle.error)) {
  13501. if (!success) { handle.response.reset(); }
  13502. return handle;
  13503. }
  13504. }
  13505. }
  13506. transfer_socket_ownership_to_handle(handle);
  13507. }
  13508. #ifdef CPPHTTPLIB_SSL_ENABLED
  13509. if (is_ssl() && handle.connection_->session) {
  13510. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13511. handle.connection_->sock, handle.connection_->session,
  13512. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13513. write_timeout_usec_);
  13514. } else {
  13515. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13516. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13517. write_timeout_sec_, write_timeout_usec_);
  13518. }
  13519. #else
  13520. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13521. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13522. write_timeout_sec_, write_timeout_usec_);
  13523. #endif
  13524. handle.stream_ = handle.socket_stream_.get();
  13525. auto &strm = *handle.stream_;
  13526. // After connecting, as for a buffered request
  13527. add_credential_headers(req);
  13528. // Build the request line and headers in memory first, like write_request()
  13529. // does, so that a rejected header leaves nothing on the wire.
  13530. {
  13531. detail::BufferStream bstrm;
  13532. if (detail::write_request_line(bstrm, req.method,
  13533. proxy_target_prefix() + req.path) < 0) {
  13534. handle.error = Error::Write;
  13535. handle.response.reset();
  13536. return handle;
  13537. }
  13538. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13539. handle.error)) {
  13540. handle.response.reset();
  13541. return handle;
  13542. }
  13543. const auto &data = bstrm.get_buffer();
  13544. if (!detail::write_data(strm, data.data(), data.size())) {
  13545. handle.error = Error::Write;
  13546. handle.response.reset();
  13547. return handle;
  13548. }
  13549. }
  13550. if (!req.body.empty()) {
  13551. if (strm.write(req.body.data(), req.body.size()) < 0) {
  13552. handle.error = Error::Write;
  13553. handle.response.reset();
  13554. return handle;
  13555. }
  13556. }
  13557. if (!read_response_line(strm, req, *handle.response) ||
  13558. !detail::read_headers(strm, handle.response->headers)) {
  13559. handle.error = Error::Read;
  13560. handle.response.reset();
  13561. return handle;
  13562. }
  13563. handle.body_reader_.stream = handle.stream_;
  13564. handle.body_reader_.payload_max_length = payload_max_length_;
  13565. // RFC 9112 6.3: a response to HEAD, and a 204 or 304 response, ends with its
  13566. // header section, so none of its framing or coding headers apply.
  13567. if (req.method == "HEAD" ||
  13568. handle.response->status == StatusCode::NoContent_204 ||
  13569. handle.response->status == StatusCode::NotModified_304) {
  13570. handle.body_reader_.eof = true;
  13571. return handle;
  13572. }
  13573. // Same framing check as ClientImpl::process_request()
  13574. if (detail::has_conflicting_content_length(handle.response->headers)) {
  13575. handle.error = Error::Read;
  13576. handle.response.reset();
  13577. return handle;
  13578. }
  13579. if (handle.response->has_header("Content-Length")) {
  13580. bool is_invalid = false;
  13581. auto content_length = detail::get_header_value_u64(
  13582. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13583. if (is_invalid) {
  13584. handle.error = Error::Read;
  13585. handle.response.reset();
  13586. return handle;
  13587. }
  13588. handle.body_reader_.has_content_length = true;
  13589. handle.body_reader_.content_length = content_length;
  13590. }
  13591. handle.body_reader_.chunked =
  13592. detail::is_chunked_transfer_encoding(handle.response->headers);
  13593. auto content_encoding = detail::get_combined_header_value(
  13594. handle.response->headers, "Content-Encoding");
  13595. if (!content_encoding.empty()) {
  13596. // Same policy as prepare_content_receiver(): reject a coding we know about
  13597. // but were not built with, pass an unrecognized one through as-is.
  13598. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13599. if (!handle.decompressor_) {
  13600. if (detail::is_known_content_encoding(content_encoding)) {
  13601. handle.error = Error::UnsupportedContentEncoding;
  13602. handle.response.reset();
  13603. return handle;
  13604. }
  13605. } else if (!handle.decompressor_->is_valid()) {
  13606. handle.error = Error::Compression;
  13607. handle.response.reset();
  13608. return handle;
  13609. }
  13610. }
  13611. return handle;
  13612. }
  13613. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13614. if (!is_valid() || !response) { return -1; }
  13615. auto n = decompressor_
  13616. ? read_with_decompression(buf, len)
  13617. : detail::read_body_content(stream_, body_reader_, buf, len);
  13618. if (n == 0) { parse_trailers_if_needed(); }
  13619. return n;
  13620. }
  13621. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13622. size_t len) {
  13623. if (decompress_offset_ < decompress_buffer_.size()) {
  13624. auto available = decompress_buffer_.size() - decompress_offset_;
  13625. auto to_copy = (std::min)(len, available);
  13626. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13627. decompress_offset_ += to_copy;
  13628. decompressed_bytes_read_ += to_copy;
  13629. return static_cast<ssize_t>(to_copy);
  13630. }
  13631. decompress_buffer_.clear();
  13632. decompress_offset_ = 0;
  13633. constexpr size_t kDecompressionBufferSize = 8192;
  13634. char compressed_buf[kDecompressionBufferSize];
  13635. while (true) {
  13636. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13637. sizeof(compressed_buf));
  13638. if (n <= 0) { return n; }
  13639. auto exceeded = false;
  13640. bool decompress_ok = decompressor_->decompress(
  13641. compressed_buf, static_cast<size_t>(n),
  13642. [&](const char *data, size_t data_len) {
  13643. decompress_buffer_.append(data, data_len);
  13644. auto limit = body_reader_.payload_max_length;
  13645. exceeded =
  13646. limit > 0 &&
  13647. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13648. return !exceeded;
  13649. });
  13650. if (!decompress_ok) {
  13651. body_reader_.last_error =
  13652. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13653. return -1;
  13654. }
  13655. if (!decompress_buffer_.empty()) { break; }
  13656. }
  13657. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13658. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13659. decompress_offset_ = to_copy;
  13660. decompressed_bytes_read_ += to_copy;
  13661. return static_cast<ssize_t>(to_copy);
  13662. }
  13663. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13664. // The trailers follow the last chunk, so there are none before it
  13665. auto &decoder = body_reader_.chunked_decoder;
  13666. if (!response || trailers_parsed_ || !decoder || !decoder->finished) {
  13667. return;
  13668. }
  13669. trailers_parsed_ = true;
  13670. decoder->parse_trailers_into(response->trailers, response->headers);
  13671. }
  13672. namespace detail {
  13673. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13674. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13675. size_t &out_chunk_offset,
  13676. size_t &out_chunk_total) {
  13677. if (finished) { return 0; }
  13678. if (chunk_remaining == 0) {
  13679. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13680. if (!lr.getline()) { return -1; }
  13681. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13682. // the line terminator is never mistaken for line content.
  13683. const char *eol = lr.ptr() + lr.size();
  13684. if (lr.end_with_crlf()) {
  13685. eol -= 2;
  13686. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13687. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13688. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13689. // has to come off here or the check below would reject the line.
  13690. eol -= 1;
  13691. }
  13692. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13693. const char *p = lr.ptr();
  13694. int v = 0;
  13695. if (p == eol || !is_hex(*p, v)) { return -1; }
  13696. size_t chunk_len = 0;
  13697. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13698. for (; p < eol && is_hex(*p, v); ++p) {
  13699. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13700. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13701. }
  13702. while (p < eol && is_space_or_tab(*p)) {
  13703. ++p;
  13704. }
  13705. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13706. // terminator, and it is built from tokens and quoted-strings, so it never
  13707. // holds a CR, LF or any other control character. getline() reads up to the
  13708. // CRLF, so a bare LF left in here would be swallowed as extension text
  13709. // while an intermediary that ends the line on it delimits the chunks
  13710. // differently, and the two disagree on where the body ends (request
  13711. // smuggling).
  13712. if (p < eol && *p != ';') { return -1; }
  13713. for (; p < eol; ++p) {
  13714. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13715. }
  13716. // The bytes around the data are no payload, so they are counted on their
  13717. // own, as Go does: each chunk may spend 16 bytes and twice its data on
  13718. // them, which lets a stream send a byte at a time, and what goes past that
  13719. // in padding, leading zeros and extensions builds up to one header field.
  13720. overhead += lr.size() + 2;
  13721. overhead = overhead > 16 ? overhead - 16 : 0;
  13722. overhead = chunk_len > overhead / 2 ? 0 : overhead - 2 * chunk_len;
  13723. if (overhead > CPPHTTPLIB_HEADER_MAX_LENGTH) { return -1; }
  13724. if (chunk_len == 0) {
  13725. chunk_remaining = 0;
  13726. finished = true;
  13727. out_chunk_offset = 0;
  13728. out_chunk_total = 0;
  13729. return 0;
  13730. }
  13731. chunk_remaining = chunk_len;
  13732. last_chunk_total = chunk_remaining;
  13733. last_chunk_offset = 0;
  13734. }
  13735. auto to_read = (std::min)(chunk_remaining, len);
  13736. auto n = strm.read(buf, to_read);
  13737. if (n <= 0) { return -1; }
  13738. auto offset_before = last_chunk_offset;
  13739. last_chunk_offset += static_cast<size_t>(n);
  13740. chunk_remaining -= static_cast<size_t>(n);
  13741. out_chunk_offset = offset_before;
  13742. out_chunk_total = last_chunk_total;
  13743. if (chunk_remaining == 0) {
  13744. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13745. if (!lr.getline()) { return -1; }
  13746. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13747. }
  13748. return n;
  13749. }
  13750. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13751. const Headers &src_headers) {
  13752. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13753. if (!lr.getline()) { return false; }
  13754. return parse_trailers(lr, dest, src_headers);
  13755. }
  13756. // A 3xx without a Location, such as a 304, is a final response
  13757. inline bool is_redirect(const Response &res) {
  13758. return 300 < res.status && res.status < 400 &&
  13759. !res.get_header_value("Location").empty();
  13760. }
  13761. } // namespace detail
  13762. inline void
  13763. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13764. handle.connection_->sock = socket_.sock;
  13765. #ifdef CPPHTTPLIB_SSL_ENABLED
  13766. handle.connection_->session = socket_.ssl;
  13767. socket_.ssl = nullptr;
  13768. #endif
  13769. socket_.sock = INVALID_SOCKET;
  13770. }
  13771. // A plain HTTP proxy reads the target in absolute-form (RFC 9112 3.2.2)
  13772. inline std::string ClientImpl::proxy_target_prefix() const {
  13773. if (is_ssl() || !is_proxy_enabled_for_host(host_)) { return std::string(); }
  13774. return "http://" + detail::make_host_and_port_string(host_, port_, false);
  13775. }
  13776. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13777. Response &res, bool close_connection,
  13778. Error &error) {
  13779. if (req.path.empty()) {
  13780. error = Error::Connection;
  13781. return false;
  13782. }
  13783. auto req_save = req;
  13784. bool ret;
  13785. auto prefix = proxy_target_prefix();
  13786. if (!prefix.empty()) {
  13787. auto req2 = req;
  13788. req2.path = prefix + req.path;
  13789. ret = process_request(strm, req2, res, close_connection, error);
  13790. req = std::move(req2);
  13791. req.path = req_save.path;
  13792. } else {
  13793. ret = process_request(strm, req, res, close_connection, error);
  13794. }
  13795. if (!ret) { return false; }
  13796. {
  13797. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13798. // for this to be safe.
  13799. // This is safe to call because handle_request is only called by send_
  13800. // which locks the request mutex during the process. It would be a bug
  13801. // to call it from a different thread since it's a thread-safety issue
  13802. // to do these things to the socket if another thread is using the socket.
  13803. std::lock_guard<std::mutex> guard(socket_mutex_);
  13804. // Also when the request asked for it (e.g. a body that was never sent),
  13805. // so that a redirect or an auth retry below does not reuse the socket.
  13806. if (socket_should_be_closed_when_request_is_done_ ||
  13807. detail::has_header_token(res.headers, "Connection", "close") ||
  13808. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13809. disconnect(/*gracefully=*/true);
  13810. }
  13811. }
  13812. if (follow_location_ && detail::is_redirect(res)) {
  13813. req = std::move(req_save);
  13814. // The client that followed the redirect has answered any challenge it
  13815. // could. Retrying below would sign another host's challenge and send it
  13816. // here.
  13817. return redirect(req, res, error);
  13818. }
  13819. #ifdef CPPHTTPLIB_SSL_ENABLED
  13820. if ((res.status == StatusCode::Unauthorized_401 ||
  13821. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13822. req.authorization_count_ < 5) {
  13823. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13824. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13825. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13826. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13827. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13828. return ret;
  13829. }
  13830. const auto &username =
  13831. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13832. const auto &password =
  13833. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13834. if (!username.empty() && !password.empty()) {
  13835. std::map<std::string, std::string> auth;
  13836. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13837. Request new_req = req;
  13838. new_req.authorization_count_ += 1;
  13839. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13840. : "Authorization");
  13841. new_req.headers.insert(detail::make_digest_authentication_header(
  13842. req, make_request_target(req), auth, new_req.authorization_count_,
  13843. detail::random_string(10), username, password, is_proxy));
  13844. Response new_res;
  13845. ret = send(new_req, new_res, error);
  13846. if (ret) { res = std::move(new_res); }
  13847. }
  13848. }
  13849. }
  13850. #endif
  13851. return ret;
  13852. }
  13853. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13854. if (req.redirect_count_ == 0) {
  13855. error = Error::ExceedRedirectCount;
  13856. return false;
  13857. }
  13858. auto location = res.get_header_value("location");
  13859. if (location.empty()) { return false; }
  13860. detail::UrlComponents uc;
  13861. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13862. uc)) {
  13863. return false;
  13864. }
  13865. // Only follow http/https redirects
  13866. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13867. return false;
  13868. }
  13869. auto scheme = is_ssl() ? "https" : "http";
  13870. auto next_scheme = std::move(uc.scheme);
  13871. auto next_host = std::move(uc.host);
  13872. auto port_str = std::move(uc.port);
  13873. auto next_path = std::move(uc.path);
  13874. auto next_query = std::move(uc.query);
  13875. auto next_port = port_;
  13876. if (!port_str.empty()) {
  13877. if (!detail::parse_port(port_str, next_port)) { return false; }
  13878. } else if (!next_scheme.empty()) {
  13879. next_port = next_scheme == "https" ? 443 : 80;
  13880. }
  13881. if (next_scheme.empty()) { next_scheme = scheme; }
  13882. if (next_host.empty()) { next_host = host_; }
  13883. if (next_path.empty()) { next_path = "/"; }
  13884. auto path = std::move(next_path) + next_query;
  13885. // Same host redirect - use current client
  13886. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13887. return detail::redirect(*this, req, res, path, location, error);
  13888. }
  13889. // Cross-host/scheme redirect - create new client with robust setup
  13890. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13891. path, location, error);
  13892. }
  13893. // New method for robust redirect client creation
  13894. inline bool ClientImpl::create_redirect_client(
  13895. const std::string &scheme, const std::string &host, int port, Request &req,
  13896. Response &res, const std::string &path, const std::string &location,
  13897. Error &error) {
  13898. // Determine if we need SSL
  13899. auto need_ssl = (scheme == "https");
  13900. // Clean up request headers that are host/client specific
  13901. // Remove headers that should not be carried over to new host
  13902. auto headers_to_remove = std::vector<std::string>{
  13903. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13904. for (const auto &header_name : headers_to_remove) {
  13905. auto it = req.headers.find(header_name);
  13906. while (it != req.headers.end()) {
  13907. it = req.headers.erase(it);
  13908. it = req.headers.find(header_name);
  13909. }
  13910. }
  13911. // Create appropriate client type and handle redirect
  13912. if (need_ssl) {
  13913. #ifdef CPPHTTPLIB_SSL_ENABLED
  13914. // Create SSL client for HTTPS redirect
  13915. SSLClient redirect_client(host, port);
  13916. // Setup basic client configuration first
  13917. setup_redirect_client(redirect_client);
  13918. redirect_client.enable_server_certificate_verification(
  13919. server_certificate_verification_);
  13920. redirect_client.enable_server_hostname_verification(
  13921. server_hostname_verification_);
  13922. redirect_client.system_ca_mode_ = system_ca_mode_;
  13923. // Transfer CA certificate to redirect client
  13924. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13925. if (is_ssl()) {
  13926. auto &self = static_cast<SSLClient &>(*this);
  13927. // A store given to set_ca_cert_store() lives only in this client's
  13928. // context, which then holds all that is trusted.
  13929. if (self.ca_cert_store_set_) {
  13930. std::string pem;
  13931. {
  13932. std::lock_guard<std::mutex> guard(self.ctx_mutex_);
  13933. pem = detail::ca_certs_to_pem(self.ctx_);
  13934. }
  13935. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13936. redirect_client.ca_cert_store_set_ = true;
  13937. } else if (self.custom_ca_loaded_) {
  13938. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13939. ca_cert_pem_.size());
  13940. }
  13941. redirect_client.set_session_verifier(self.session_verifier_);
  13942. if (self.server_certificate_verifier_) {
  13943. redirect_client.set_server_certificate_verifier(
  13944. self.server_certificate_verifier_);
  13945. }
  13946. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13947. redirect_client.enable_windows_cert_verification_ =
  13948. self.enable_windows_cert_verification_;
  13949. #endif
  13950. }
  13951. // Client certificates are set through constructor for SSLClient
  13952. // NOTE: SSLClient constructor already takes client_cert_path and
  13953. // client_key_path so we need to create it properly if client certs are
  13954. // needed
  13955. // Execute the redirect
  13956. return detail::redirect(redirect_client, req, res, path, location, error);
  13957. #else
  13958. // SSL not supported - set appropriate error
  13959. error = Error::SSLConnection;
  13960. return false;
  13961. #endif
  13962. } else {
  13963. // HTTP redirect
  13964. ClientImpl redirect_client(host, port);
  13965. // Setup client with robust configuration
  13966. setup_redirect_client(redirect_client);
  13967. // Execute the redirect
  13968. return detail::redirect(redirect_client, req, res, path, location, error);
  13969. }
  13970. }
  13971. // New method for robust client setup (based on basic_manual_redirect.cpp
  13972. // logic)
  13973. template <typename ClientType>
  13974. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13975. // Copy basic settings first
  13976. client.set_connection_timeout(connection_timeout_sec_,
  13977. connection_timeout_usec_);
  13978. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13979. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13980. client.set_max_timeout(max_timeout_msec_);
  13981. if (has_payload_max_length_) {
  13982. client.set_payload_max_length(payload_max_length_);
  13983. }
  13984. client.set_keep_alive(keep_alive_);
  13985. client.set_follow_location(
  13986. true); // Enable redirects to handle multi-step redirects
  13987. client.set_path_encode(path_encode_);
  13988. client.set_compress(compress_);
  13989. client.set_decompress(decompress_);
  13990. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13991. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13992. // 15.4, credentials must not be forwarded when redirecting to a different
  13993. // host. This function is only called for cross-host redirects; same-host
  13994. // redirects are handled directly in ClientImpl::redirect().
  13995. // Copy the proxy configuration unconditionally; the per-target bypass is
  13996. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13997. // still use the proxy.
  13998. client.no_proxy_entries_ = no_proxy_entries_;
  13999. if (!proxy_host_.empty() && proxy_port_ != -1) {
  14000. client.set_proxy(proxy_host_, proxy_port_);
  14001. if (!proxy_basic_auth_username_.empty() ||
  14002. !proxy_basic_auth_password_.empty()) {
  14003. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  14004. proxy_basic_auth_password_);
  14005. }
  14006. if (!proxy_bearer_token_auth_token_.empty()) {
  14007. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  14008. }
  14009. #ifdef CPPHTTPLIB_SSL_ENABLED
  14010. if (!proxy_digest_auth_username_.empty()) {
  14011. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  14012. proxy_digest_auth_password_);
  14013. }
  14014. #endif
  14015. }
  14016. // Copy network and socket settings
  14017. client.addr_map_ = addr_map_;
  14018. client.set_address_family(address_family_);
  14019. client.set_tcp_nodelay(tcp_nodelay_);
  14020. client.set_ipv6_v6only(ipv6_v6only_);
  14021. if (socket_options_) { client.set_socket_options(socket_options_); }
  14022. if (!interface_.empty()) { client.set_interface(interface_); }
  14023. // Copy logging and headers. Not the error logger: a failure comes back to
  14024. // this client's send(), which reports it with the caller's request.
  14025. if (logger_) { client.set_logger(logger_); }
  14026. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  14027. // Each new client should generate its own headers based on its target host
  14028. }
  14029. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  14030. const Request &req,
  14031. Error &error) const {
  14032. auto is_shutting_down = []() { return false; };
  14033. if (req.is_chunked_content_provider_) {
  14034. auto compressor = compress_ ? detail::create_compressor().first
  14035. : std::unique_ptr<detail::compressor>();
  14036. if (!compressor) {
  14037. compressor = detail::make_unique<detail::nocompressor>();
  14038. }
  14039. return detail::write_content_chunked(strm, req.content_provider_,
  14040. is_shutting_down, *compressor, error);
  14041. } else {
  14042. return detail::write_content_with_progress(
  14043. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  14044. req.upload_progress, error);
  14045. }
  14046. }
  14047. // What goes on the request line for req: its path, encoded and without the
  14048. // fragment, with `req.params` as the query when the path has none.
  14049. inline std::string ClientImpl::make_request_target(const Request &req) const {
  14050. auto target = detail::encode_request_target(req.path, path_encode_);
  14051. if (detail::query_of(req.path).empty() && !req.params.empty()) {
  14052. target = append_query_params(target, req.params);
  14053. }
  14054. return target;
  14055. }
  14056. inline void ClientImpl::add_credential_headers(Request &req) {
  14057. // A CONNECT request is read by the proxy; everything sent through the tunnel
  14058. // it opens is read by the origin. Each credential goes only to its own hop.
  14059. auto is_connect = req.method == "CONNECT";
  14060. if (!is_connect) {
  14061. detail::add_authorization_header(req, basic_auth_username_,
  14062. basic_auth_password_,
  14063. bearer_token_auth_token_, false);
  14064. }
  14065. // Proxy-Authorization is only sent when the proxy reads this message —
  14066. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  14067. // would leak proxy credentials to the destination server.
  14068. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  14069. detail::add_authorization_header(req, proxy_basic_auth_username_,
  14070. proxy_basic_auth_password_,
  14071. proxy_bearer_token_auth_token_, true);
  14072. }
  14073. }
  14074. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  14075. bool close_connection, Error &error,
  14076. bool skip_body, bool &rejected_locally) {
  14077. rejected_locally = false;
  14078. // Prepare additional headers
  14079. if (close_connection) {
  14080. if (!req.has_header("Connection")) {
  14081. req.set_header("Connection", "close");
  14082. }
  14083. }
  14084. std::string ct_for_defaults;
  14085. if (!req.has_header("Content-Type") && !req.body.empty()) {
  14086. ct_for_defaults = "text/plain";
  14087. }
  14088. prepare_default_headers(req, false, ct_for_defaults);
  14089. if (req.body.empty()) {
  14090. if (req.content_provider_) {
  14091. if (!req.is_chunked_content_provider_) {
  14092. if (!req.has_header("Content-Length")) {
  14093. auto length = std::to_string(req.content_length_);
  14094. req.set_header("Content-Length", length);
  14095. }
  14096. }
  14097. } else {
  14098. if (req.method == "POST" || req.method == "PUT" ||
  14099. req.method == "PATCH") {
  14100. req.set_header("Content-Length", "0");
  14101. }
  14102. }
  14103. }
  14104. add_credential_headers(req);
  14105. // Request line and headers
  14106. {
  14107. detail::BufferStream bstrm;
  14108. auto path_with_query = make_request_target(req);
  14109. // The query already came in through `req.path`; still populate
  14110. // `req.params` for handlers/users who read them.
  14111. auto query_part = detail::query_of(req.path);
  14112. if (!query_part.empty()) {
  14113. detail::parse_query_text(query_part, req.params);
  14114. }
  14115. // Write request line and headers
  14116. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  14117. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  14118. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  14119. // fail the request cleanly instead of emitting a request-line-less,
  14120. // header-injecting request.
  14121. error = Error::Write;
  14122. rejected_locally = true;
  14123. return false;
  14124. }
  14125. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  14126. error)) {
  14127. rejected_locally = true;
  14128. return false;
  14129. }
  14130. // Flush buffer
  14131. auto &data = bstrm.get_buffer();
  14132. if (!detail::write_data(strm, data.data(), data.size())) {
  14133. error = Error::Write;
  14134. return false;
  14135. }
  14136. }
  14137. // After sending request line and headers, wait briefly for an early server
  14138. // response (e.g. 4xx) and avoid sending a potentially large request body
  14139. // unnecessarily. This workaround is only enabled on Windows because Unix
  14140. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  14141. // buffering can accept large writes even when the peer already responded.
  14142. // Check the stream first (which covers SSL via `is_readable()`), then
  14143. // fall back to select on the socket. Only perform the wait for very large
  14144. // request bodies to avoid interfering with normal small requests and
  14145. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  14146. // response. Skip this check when using Expect: 100-continue, as the protocol
  14147. // handles early responses properly.
  14148. #if defined(_WIN32)
  14149. if (!skip_body &&
  14150. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  14151. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  14152. auto start = std::chrono::high_resolution_clock::now();
  14153. for (;;) {
  14154. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  14155. // from SSL internals. If the underlying socket is readable, assume an
  14156. // early response may be present.
  14157. auto sock = strm.socket();
  14158. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  14159. return false;
  14160. }
  14161. // Fallback to stream-level check for non-socket streams or when the
  14162. // socket isn't reporting readable. Avoid using `is_readable()` for
  14163. // SSL, since `SSL_pending()` may report buffered records that do not
  14164. // indicate a complete application-level response yet.
  14165. if (!is_ssl() && strm.is_readable()) { return false; }
  14166. auto now = std::chrono::high_resolution_clock::now();
  14167. auto elapsed =
  14168. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  14169. .count();
  14170. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  14171. break;
  14172. }
  14173. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  14174. }
  14175. }
  14176. #endif
  14177. // Body
  14178. if (skip_body) { return true; }
  14179. return write_request_body(strm, req, error);
  14180. }
  14181. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  14182. Error &error) {
  14183. if (req.body.empty()) {
  14184. return write_content_with_provider(strm, req, error);
  14185. }
  14186. if (req.upload_progress) {
  14187. auto body_size = req.body.size();
  14188. size_t written = 0;
  14189. auto data = req.body.data();
  14190. while (written < body_size) {
  14191. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  14192. if (!detail::write_data(strm, data + written, to_write)) {
  14193. error = Error::Write;
  14194. return false;
  14195. }
  14196. written += to_write;
  14197. if (!req.upload_progress(written, body_size)) {
  14198. error = Error::Canceled;
  14199. return false;
  14200. }
  14201. }
  14202. } else {
  14203. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  14204. error = Error::Write;
  14205. return false;
  14206. }
  14207. }
  14208. return true;
  14209. }
  14210. inline std::unique_ptr<Response>
  14211. ClientImpl::send_with_content_provider_and_receiver(
  14212. Request &req, const char *body, size_t content_length,
  14213. ContentProvider content_provider,
  14214. ContentProviderWithoutLength content_provider_without_length,
  14215. const std::string &content_type, ContentReceiver content_receiver,
  14216. Error &error) {
  14217. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14218. auto enc = compress_
  14219. ? detail::create_compressor()
  14220. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14221. nullptr, nullptr);
  14222. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14223. if (enc.first && !content_provider_without_length) {
  14224. auto &compressor = enc.first;
  14225. if (content_provider) {
  14226. auto ok = true;
  14227. auto finished = false;
  14228. size_t offset = 0;
  14229. DataSink data_sink;
  14230. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14231. if (ok) {
  14232. auto last = offset + data_len == content_length;
  14233. auto ret = compressor->compress(
  14234. data, data_len, last,
  14235. [&](const char *compressed_data, size_t compressed_data_len) {
  14236. req.body.append(compressed_data, compressed_data_len);
  14237. return true;
  14238. });
  14239. if (ret) {
  14240. offset += data_len;
  14241. } else {
  14242. ok = false;
  14243. }
  14244. }
  14245. return ok;
  14246. };
  14247. // As in detail::write_content_with_progress(): the body is framed by
  14248. // content_length, so a provider that finishes early has truncated it.
  14249. // Stop and report that instead of calling the provider forever.
  14250. data_sink.done = [&]() { finished = true; };
  14251. while (ok && !finished && offset < content_length) {
  14252. if (!content_provider(offset, content_length - offset, data_sink)) {
  14253. error = Error::Canceled;
  14254. output_error_log(error, &req);
  14255. return nullptr;
  14256. }
  14257. }
  14258. // A short body here means either the provider stopped early or the
  14259. // compressor gave up. The branch below reports a failing compressor as
  14260. // Error::Compression, so keep the two distinguishable.
  14261. if (offset < content_length) {
  14262. error = ok ? Error::Write : Error::Compression;
  14263. output_error_log(error, &req);
  14264. return nullptr;
  14265. }
  14266. } else {
  14267. if (!compressor->compress(body, content_length, true,
  14268. [&](const char *data, size_t data_len) {
  14269. req.body.append(data, data_len);
  14270. return true;
  14271. })) {
  14272. error = Error::Compression;
  14273. output_error_log(error, &req);
  14274. return nullptr;
  14275. }
  14276. }
  14277. } else {
  14278. if (content_provider) {
  14279. req.content_length_ = content_length;
  14280. req.content_provider_ = std::move(content_provider);
  14281. req.is_chunked_content_provider_ = false;
  14282. } else if (content_provider_without_length) {
  14283. req.content_length_ = 0;
  14284. req.content_provider_ = detail::ContentProviderAdapter(
  14285. std::move(content_provider_without_length));
  14286. req.is_chunked_content_provider_ = true;
  14287. req.set_header("Transfer-Encoding", "chunked");
  14288. } else {
  14289. req.body.assign(body, content_length);
  14290. }
  14291. }
  14292. if (content_receiver) {
  14293. req.content_receiver =
  14294. [content_receiver](const char *data, size_t data_length,
  14295. size_t /*offset*/, size_t /*total_length*/) {
  14296. return content_receiver(data, data_length);
  14297. };
  14298. }
  14299. auto res = detail::make_unique<Response>();
  14300. return send(req, *res, error) ? std::move(res) : nullptr;
  14301. }
  14302. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14303. const std::string &method, const std::string &path, const Headers &headers,
  14304. const char *body, size_t content_length, ContentProvider content_provider,
  14305. ContentProviderWithoutLength content_provider_without_length,
  14306. const std::string &content_type, ContentReceiver content_receiver,
  14307. UploadProgress progress) {
  14308. Request req;
  14309. req.method = method;
  14310. req.headers = headers;
  14311. req.path = path;
  14312. req.upload_progress = std::move(progress);
  14313. if (max_timeout_msec_ > 0) {
  14314. req.start_time_ = std::chrono::steady_clock::now();
  14315. }
  14316. auto error = Error::Success;
  14317. #ifdef CPPHTTPLIB_SSL_ENABLED
  14318. // Hold the request lock until the Result has read this request's TLS error
  14319. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  14320. #endif
  14321. auto res = send_with_content_provider_and_receiver(
  14322. req, body, content_length, std::move(content_provider),
  14323. std::move(content_provider_without_length), content_type,
  14324. std::move(content_receiver), error);
  14325. #ifdef CPPHTTPLIB_SSL_ENABLED
  14326. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14327. last_backend_error_};
  14328. #else
  14329. return Result{std::move(res), error, std::move(req.headers)};
  14330. #endif
  14331. }
  14332. inline void ClientImpl::output_log(const Request &req,
  14333. const Response &res) const {
  14334. if (logger_) {
  14335. std::lock_guard<std::mutex> guard(logger_mutex_);
  14336. logger_(req, res);
  14337. }
  14338. }
  14339. inline void ClientImpl::output_error_log(const Error &err,
  14340. const Request *req) const {
  14341. if (error_logger_) {
  14342. std::lock_guard<std::mutex> guard(logger_mutex_);
  14343. error_logger_(err, req);
  14344. }
  14345. }
  14346. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14347. Response &res, bool close_connection,
  14348. Error &error) {
  14349. // Auto-add Expect: 100-continue for large bodies
  14350. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14351. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14352. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14353. req.set_header("Expect", "100-continue");
  14354. }
  14355. }
  14356. // Check for Expect: 100-continue
  14357. auto expect_100_continue =
  14358. detail::has_header_token(req.headers, "Expect", "100-continue");
  14359. // Send request (skip body if using Expect: 100-continue)
  14360. auto rejected_locally = false;
  14361. auto write_request_success =
  14362. write_request(strm, req, close_connection, error, expect_100_continue,
  14363. rejected_locally);
  14364. // A failed write normally still reads the response below, since the server
  14365. // may have answered early (e.g. 413/414) and closed while the body was being
  14366. // sent. A request rejected before any byte reached the socket gets no such
  14367. // response, and waiting for one would block until the read timeout.
  14368. if (rejected_locally) { return false; }
  14369. #ifdef CPPHTTPLIB_SSL_ENABLED
  14370. if (is_ssl() && !expect_100_continue) {
  14371. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14372. if (!is_proxy_enabled) {
  14373. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14374. error = Error::SSLPeerCouldBeClosed_;
  14375. return false;
  14376. }
  14377. }
  14378. }
  14379. #endif
  14380. // Handle Expect: 100-continue.
  14381. //
  14382. // Wait for an interim/early response by attempting to read the status line
  14383. // under a short timeout, instead of trusting raw socket readability. Over
  14384. // TLS, post-handshake records (e.g. session tickets) make the socket
  14385. // readable without any HTTP response being available; relying on
  14386. // `select_read` there caused the body to be withheld forever and the
  14387. // request to fail with `Read` (#2458). If no status line arrives within the
  14388. // timeout, send the body anyway (matching curl's behavior).
  14389. auto status_line_read = false;
  14390. if (expect_100_continue && write_request_success) {
  14391. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14392. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14393. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14394. strm.set_read_timeout(sec, usec);
  14395. status_line_read = read_response_line(strm, req, res, false);
  14396. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14397. }
  14398. if (!status_line_read) {
  14399. // No interim response within the timeout: send the body and handle the
  14400. // response as usual.
  14401. if (!write_request_body(strm, req, error)) { return false; }
  14402. expect_100_continue = false; // Switch to normal response handling
  14403. }
  14404. }
  14405. // Receive response and headers
  14406. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14407. if ((!status_line_read &&
  14408. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14409. !detail::read_headers(strm, res.headers)) {
  14410. if (write_request_success) { error = Error::Read; }
  14411. return false;
  14412. }
  14413. if (!write_request_success) { return false; }
  14414. // Handle Expect: 100-continue response
  14415. if (expect_100_continue) {
  14416. if (res.status == StatusCode::Continue_100) {
  14417. // Server accepted, send the body
  14418. if (!write_request_body(strm, req, error)) { return false; }
  14419. // Read the actual response
  14420. res.headers.clear();
  14421. res.body.clear();
  14422. if (!read_response_line(strm, req, res) ||
  14423. !detail::read_headers(strm, res.headers)) {
  14424. error = Error::Read;
  14425. return false;
  14426. }
  14427. } else {
  14428. // A final response came first, so the body this request declared was
  14429. // never sent, and the server may still be waiting for it. The
  14430. // connection cannot carry another request.
  14431. std::lock_guard<std::mutex> guard(socket_mutex_);
  14432. socket_should_be_closed_when_request_is_done_ = true;
  14433. }
  14434. }
  14435. // Body
  14436. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14437. req.method != "CONNECT") {
  14438. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14439. // whose final transfer coding is not chunked is not ambiguous: its body
  14440. // runs until the server closes the connection, so it is not rejected.
  14441. // HEAD/204 are excluded above and a 304 carries no body.
  14442. if (res.status != StatusCode::NotModified_304) {
  14443. if (detail::has_conflicting_content_length(res.headers)) {
  14444. error = Error::Read;
  14445. return false;
  14446. }
  14447. if (detail::has_faulty_transfer_encoding(res)) {
  14448. std::lock_guard<std::mutex> guard(socket_mutex_);
  14449. socket_should_be_closed_when_request_is_done_ = true;
  14450. }
  14451. }
  14452. auto redirect = follow_location_ && detail::is_redirect(res) &&
  14453. res.status != StatusCode::NotModified_304;
  14454. if (req.response_handler && !redirect) {
  14455. if (!req.response_handler(res)) {
  14456. error = Error::Canceled;
  14457. return false;
  14458. }
  14459. }
  14460. auto out =
  14461. req.content_receiver
  14462. ? static_cast<ContentReceiverWithProgress>(
  14463. [&](const char *buf, size_t n, size_t off, size_t len) {
  14464. if (redirect) { return true; }
  14465. auto ret = req.content_receiver(buf, n, off, len);
  14466. if (!ret) { error = Error::Canceled; }
  14467. return ret;
  14468. })
  14469. : static_cast<ContentReceiverWithProgress>(
  14470. [&](const char *buf, size_t n, size_t /*off*/,
  14471. size_t /*len*/) {
  14472. assert(res.body.size() + n <= res.body.max_size());
  14473. if (payload_max_length_ > 0 &&
  14474. (res.body.size() >= payload_max_length_ ||
  14475. n > payload_max_length_ - res.body.size())) {
  14476. return false;
  14477. }
  14478. res.body.append(buf, n);
  14479. return true;
  14480. });
  14481. auto progress = [&](size_t current, size_t total) {
  14482. if (!req.download_progress || redirect) { return true; }
  14483. auto ret = req.download_progress(current, total);
  14484. if (!ret) { error = Error::Canceled; }
  14485. return ret;
  14486. };
  14487. if (res.has_header("Content-Length")) {
  14488. if (!req.content_receiver) {
  14489. auto len = res.get_header_value_u64("Content-Length");
  14490. if (len > res.body.max_size()) {
  14491. error = Error::Read;
  14492. return false;
  14493. }
  14494. // Content-Length is only the server's claim, so reserve no more than
  14495. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14496. // body has arrived. A longer body grows as it is read.
  14497. auto reserve_len =
  14498. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14499. if (payload_max_length_ > 0) {
  14500. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14501. }
  14502. res.body.reserve(reserve_len);
  14503. }
  14504. }
  14505. if (res.status != StatusCode::NotModified_304) {
  14506. auto content_status = 0;
  14507. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14508. ? (std::numeric_limits<size_t>::max)()
  14509. : payload_max_length_;
  14510. if (!detail::read_content(strm, res, max_length, content_status,
  14511. std::move(progress), std::move(out),
  14512. decompress_)) {
  14513. if (error != Error::Canceled) {
  14514. // Tell the caller apart from a plain read failure when the body was
  14515. // over the payload limit or could not be decoded because of its
  14516. // Content-Encoding.
  14517. switch (content_status) {
  14518. case StatusCode::PayloadTooLarge_413:
  14519. error = Error::ExceedMaxPayloadSize;
  14520. break;
  14521. case StatusCode::UnsupportedMediaType_415:
  14522. error = Error::UnsupportedContentEncoding;
  14523. break;
  14524. case StatusCode::InternalServerError_500:
  14525. error = Error::Compression;
  14526. break;
  14527. default: error = Error::Read; break;
  14528. }
  14529. }
  14530. return false;
  14531. }
  14532. }
  14533. }
  14534. // Log
  14535. output_log(req, res);
  14536. return true;
  14537. }
  14538. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14539. const std::string &boundary, const UploadFormDataItems &items,
  14540. const FormDataProviderItems &provider_items) const {
  14541. size_t cur_item = 0;
  14542. size_t cur_start = 0;
  14543. // cur_item and cur_start are copied to within the std::function and
  14544. // maintain state between successive calls
  14545. return [&, cur_item, cur_start](size_t offset,
  14546. DataSink &sink) mutable -> bool {
  14547. if (!offset && !items.empty()) {
  14548. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14549. return true;
  14550. } else if (cur_item < provider_items.size()) {
  14551. if (!cur_start) {
  14552. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14553. provider_items[cur_item], boundary);
  14554. offset += begin.size();
  14555. cur_start = offset;
  14556. sink.os << begin;
  14557. }
  14558. DataSink cur_sink;
  14559. auto has_data = true;
  14560. cur_sink.write = sink.write;
  14561. // Forward is_writable so a provider item asking whether it may keep
  14562. // going gets the outer sink's answer rather than the default `true`.
  14563. cur_sink.is_writable = sink.is_writable;
  14564. cur_sink.done = [&]() { has_data = false; };
  14565. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14566. return false;
  14567. }
  14568. if (!has_data) {
  14569. sink.os << detail::serialize_multipart_formdata_item_end();
  14570. cur_item++;
  14571. cur_start = 0;
  14572. }
  14573. return true;
  14574. } else {
  14575. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14576. sink.done();
  14577. return true;
  14578. }
  14579. };
  14580. }
  14581. inline bool ClientImpl::process_socket(
  14582. const Socket &socket,
  14583. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14584. std::function<bool(Stream &strm)> callback) {
  14585. return detail::process_client_socket(
  14586. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14587. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14588. }
  14589. inline bool ClientImpl::is_ssl() const { return false; }
  14590. inline Result ClientImpl::Get(const std::string &path,
  14591. DownloadProgress progress) {
  14592. return Get(path, Headers(), std::move(progress));
  14593. }
  14594. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14595. DownloadProgress progress) {
  14596. return Get(path, params, Headers(), std::move(progress));
  14597. }
  14598. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14599. const Headers &headers,
  14600. DownloadProgress progress) {
  14601. if (params.empty()) { return Get(path, headers); }
  14602. std::string path_with_query = append_query_params(path, params);
  14603. return Get(path_with_query, headers, std::move(progress));
  14604. }
  14605. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14606. DownloadProgress progress) {
  14607. Request req;
  14608. req.method = "GET";
  14609. req.path = path;
  14610. req.headers = headers;
  14611. req.download_progress = std::move(progress);
  14612. if (max_timeout_msec_ > 0) {
  14613. req.start_time_ = std::chrono::steady_clock::now();
  14614. }
  14615. return send_(std::move(req));
  14616. }
  14617. inline Result ClientImpl::Get(const std::string &path,
  14618. ContentReceiver content_receiver,
  14619. DownloadProgress progress) {
  14620. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14621. std::move(progress));
  14622. }
  14623. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14624. ContentReceiver content_receiver,
  14625. DownloadProgress progress) {
  14626. return Get(path, headers, nullptr, std::move(content_receiver),
  14627. std::move(progress));
  14628. }
  14629. inline Result ClientImpl::Get(const std::string &path,
  14630. ResponseHandler response_handler,
  14631. ContentReceiver content_receiver,
  14632. DownloadProgress progress) {
  14633. return Get(path, Headers(), std::move(response_handler),
  14634. std::move(content_receiver), std::move(progress));
  14635. }
  14636. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14637. ResponseHandler response_handler,
  14638. ContentReceiver content_receiver,
  14639. DownloadProgress progress) {
  14640. Request req;
  14641. req.method = "GET";
  14642. req.path = path;
  14643. req.headers = headers;
  14644. req.response_handler = std::move(response_handler);
  14645. req.content_receiver =
  14646. [content_receiver](const char *data, size_t data_length,
  14647. size_t /*offset*/, size_t /*total_length*/) {
  14648. return content_receiver(data, data_length);
  14649. };
  14650. req.download_progress = std::move(progress);
  14651. if (max_timeout_msec_ > 0) {
  14652. req.start_time_ = std::chrono::steady_clock::now();
  14653. }
  14654. return send_(std::move(req));
  14655. }
  14656. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14657. const Headers &headers,
  14658. ContentReceiver content_receiver,
  14659. DownloadProgress progress) {
  14660. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14661. std::move(progress));
  14662. }
  14663. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14664. const Headers &headers,
  14665. ResponseHandler response_handler,
  14666. ContentReceiver content_receiver,
  14667. DownloadProgress progress) {
  14668. if (params.empty()) {
  14669. return Get(path, headers, std::move(response_handler),
  14670. std::move(content_receiver), std::move(progress));
  14671. }
  14672. std::string path_with_query = append_query_params(path, params);
  14673. return Get(path_with_query, headers, std::move(response_handler),
  14674. std::move(content_receiver), std::move(progress));
  14675. }
  14676. inline Result ClientImpl::Head(const std::string &path) {
  14677. return Head(path, Headers());
  14678. }
  14679. inline Result ClientImpl::Head(const std::string &path,
  14680. const Headers &headers) {
  14681. Request req;
  14682. req.method = "HEAD";
  14683. req.headers = headers;
  14684. req.path = path;
  14685. if (max_timeout_msec_ > 0) {
  14686. req.start_time_ = std::chrono::steady_clock::now();
  14687. }
  14688. return send_(std::move(req));
  14689. }
  14690. inline Result ClientImpl::Post(const std::string &path) {
  14691. return Post(path, std::string(), std::string());
  14692. }
  14693. inline Result ClientImpl::Post(const std::string &path,
  14694. const Headers &headers) {
  14695. return Post(path, headers, nullptr, 0, std::string());
  14696. }
  14697. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14698. size_t content_length,
  14699. const std::string &content_type,
  14700. UploadProgress progress) {
  14701. return Post(path, Headers(), body, content_length, content_type, progress);
  14702. }
  14703. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14704. const std::string &content_type,
  14705. UploadProgress progress) {
  14706. return Post(path, Headers(), body, content_type, progress);
  14707. }
  14708. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14709. return Post(path, Headers(), params);
  14710. }
  14711. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14712. ContentProvider content_provider,
  14713. const std::string &content_type,
  14714. UploadProgress progress) {
  14715. return Post(path, Headers(), content_length, std::move(content_provider),
  14716. content_type, progress);
  14717. }
  14718. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14719. ContentProvider content_provider,
  14720. const std::string &content_type,
  14721. ContentReceiver content_receiver,
  14722. UploadProgress progress) {
  14723. return Post(path, Headers(), content_length, std::move(content_provider),
  14724. content_type, std::move(content_receiver), progress);
  14725. }
  14726. inline Result ClientImpl::Post(const std::string &path,
  14727. ContentProviderWithoutLength content_provider,
  14728. const std::string &content_type,
  14729. UploadProgress progress) {
  14730. return Post(path, Headers(), std::move(content_provider), content_type,
  14731. progress);
  14732. }
  14733. inline Result ClientImpl::Post(const std::string &path,
  14734. ContentProviderWithoutLength content_provider,
  14735. const std::string &content_type,
  14736. ContentReceiver content_receiver,
  14737. UploadProgress progress) {
  14738. return Post(path, Headers(), std::move(content_provider), content_type,
  14739. std::move(content_receiver), progress);
  14740. }
  14741. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14742. const Params &params) {
  14743. auto query = detail::params_to_query_str(params);
  14744. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14745. }
  14746. inline Result ClientImpl::Post(const std::string &path,
  14747. const UploadFormDataItems &items,
  14748. UploadProgress progress) {
  14749. return Post(path, Headers(), items, progress);
  14750. }
  14751. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14752. const UploadFormDataItems &items,
  14753. UploadProgress progress) {
  14754. const auto &boundary = detail::make_multipart_data_boundary();
  14755. const auto &content_type =
  14756. detail::serialize_multipart_formdata_get_content_type(boundary);
  14757. auto content_length = detail::get_multipart_content_length(items, boundary);
  14758. return Post(path, headers, content_length,
  14759. detail::make_multipart_content_provider(items, boundary),
  14760. content_type, progress);
  14761. }
  14762. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14763. const UploadFormDataItems &items,
  14764. const std::string &boundary,
  14765. UploadProgress progress) {
  14766. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14767. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14768. }
  14769. const auto &content_type =
  14770. detail::serialize_multipart_formdata_get_content_type(boundary);
  14771. auto content_length = detail::get_multipart_content_length(items, boundary);
  14772. return Post(path, headers, content_length,
  14773. detail::make_multipart_content_provider(items, boundary),
  14774. content_type, progress);
  14775. }
  14776. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14777. const char *body, size_t content_length,
  14778. const std::string &content_type,
  14779. UploadProgress progress) {
  14780. return send_with_content_provider_and_receiver(
  14781. "POST", path, headers, body, content_length, nullptr, nullptr,
  14782. content_type, nullptr, progress);
  14783. }
  14784. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14785. const std::string &body,
  14786. const std::string &content_type,
  14787. UploadProgress progress) {
  14788. return send_with_content_provider_and_receiver(
  14789. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14790. content_type, nullptr, progress);
  14791. }
  14792. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14793. size_t content_length,
  14794. ContentProvider content_provider,
  14795. const std::string &content_type,
  14796. UploadProgress progress) {
  14797. return send_with_content_provider_and_receiver(
  14798. "POST", path, headers, nullptr, content_length,
  14799. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14800. }
  14801. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14802. size_t content_length,
  14803. ContentProvider content_provider,
  14804. const std::string &content_type,
  14805. ContentReceiver content_receiver,
  14806. DownloadProgress progress) {
  14807. return send_with_content_provider_and_receiver(
  14808. "POST", path, headers, nullptr, content_length,
  14809. std::move(content_provider), nullptr, content_type,
  14810. std::move(content_receiver), std::move(progress));
  14811. }
  14812. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14813. ContentProviderWithoutLength content_provider,
  14814. const std::string &content_type,
  14815. UploadProgress progress) {
  14816. return send_with_content_provider_and_receiver(
  14817. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14818. content_type, nullptr, progress);
  14819. }
  14820. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14821. ContentProviderWithoutLength content_provider,
  14822. const std::string &content_type,
  14823. ContentReceiver content_receiver,
  14824. DownloadProgress progress) {
  14825. return send_with_content_provider_and_receiver(
  14826. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14827. content_type, std::move(content_receiver), std::move(progress));
  14828. }
  14829. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14830. const UploadFormDataItems &items,
  14831. const FormDataProviderItems &provider_items,
  14832. UploadProgress progress) {
  14833. const auto &boundary = detail::make_multipart_data_boundary();
  14834. const auto &content_type =
  14835. detail::serialize_multipart_formdata_get_content_type(boundary);
  14836. return send_with_content_provider_and_receiver(
  14837. "POST", path, headers, nullptr, 0, nullptr,
  14838. get_multipart_content_provider(boundary, items, provider_items),
  14839. content_type, nullptr, progress);
  14840. }
  14841. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14842. const std::string &body,
  14843. const std::string &content_type,
  14844. ContentReceiver content_receiver,
  14845. DownloadProgress progress) {
  14846. Request req;
  14847. req.method = "POST";
  14848. req.path = path;
  14849. req.headers = headers;
  14850. req.body = body;
  14851. req.content_receiver =
  14852. [content_receiver](const char *data, size_t data_length,
  14853. size_t /*offset*/, size_t /*total_length*/) {
  14854. return content_receiver(data, data_length);
  14855. };
  14856. req.download_progress = std::move(progress);
  14857. if (max_timeout_msec_ > 0) {
  14858. req.start_time_ = std::chrono::steady_clock::now();
  14859. }
  14860. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14861. return send_(std::move(req));
  14862. }
  14863. inline Result ClientImpl::Put(const std::string &path) {
  14864. return Put(path, std::string(), std::string());
  14865. }
  14866. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14867. return Put(path, headers, nullptr, 0, std::string());
  14868. }
  14869. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14870. size_t content_length,
  14871. const std::string &content_type,
  14872. UploadProgress progress) {
  14873. return Put(path, Headers(), body, content_length, content_type, progress);
  14874. }
  14875. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14876. const std::string &content_type,
  14877. UploadProgress progress) {
  14878. return Put(path, Headers(), body, content_type, progress);
  14879. }
  14880. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14881. return Put(path, Headers(), params);
  14882. }
  14883. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14884. ContentProvider content_provider,
  14885. const std::string &content_type,
  14886. UploadProgress progress) {
  14887. return Put(path, Headers(), content_length, std::move(content_provider),
  14888. content_type, progress);
  14889. }
  14890. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14891. ContentProvider content_provider,
  14892. const std::string &content_type,
  14893. ContentReceiver content_receiver,
  14894. UploadProgress progress) {
  14895. return Put(path, Headers(), content_length, std::move(content_provider),
  14896. content_type, std::move(content_receiver), progress);
  14897. }
  14898. inline Result ClientImpl::Put(const std::string &path,
  14899. ContentProviderWithoutLength content_provider,
  14900. const std::string &content_type,
  14901. UploadProgress progress) {
  14902. return Put(path, Headers(), std::move(content_provider), content_type,
  14903. progress);
  14904. }
  14905. inline Result ClientImpl::Put(const std::string &path,
  14906. ContentProviderWithoutLength content_provider,
  14907. const std::string &content_type,
  14908. ContentReceiver content_receiver,
  14909. UploadProgress progress) {
  14910. return Put(path, Headers(), std::move(content_provider), content_type,
  14911. std::move(content_receiver), progress);
  14912. }
  14913. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14914. const Params &params) {
  14915. auto query = detail::params_to_query_str(params);
  14916. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14917. }
  14918. inline Result ClientImpl::Put(const std::string &path,
  14919. const UploadFormDataItems &items,
  14920. UploadProgress progress) {
  14921. return Put(path, Headers(), items, progress);
  14922. }
  14923. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14924. const UploadFormDataItems &items,
  14925. UploadProgress progress) {
  14926. const auto &boundary = detail::make_multipart_data_boundary();
  14927. const auto &content_type =
  14928. detail::serialize_multipart_formdata_get_content_type(boundary);
  14929. auto content_length = detail::get_multipart_content_length(items, boundary);
  14930. return Put(path, headers, content_length,
  14931. detail::make_multipart_content_provider(items, boundary),
  14932. content_type, progress);
  14933. }
  14934. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14935. const UploadFormDataItems &items,
  14936. const std::string &boundary,
  14937. UploadProgress progress) {
  14938. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14939. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14940. }
  14941. const auto &content_type =
  14942. detail::serialize_multipart_formdata_get_content_type(boundary);
  14943. auto content_length = detail::get_multipart_content_length(items, boundary);
  14944. return Put(path, headers, content_length,
  14945. detail::make_multipart_content_provider(items, boundary),
  14946. content_type, progress);
  14947. }
  14948. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14949. const char *body, size_t content_length,
  14950. const std::string &content_type,
  14951. UploadProgress progress) {
  14952. return send_with_content_provider_and_receiver(
  14953. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14954. content_type, nullptr, progress);
  14955. }
  14956. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14957. const std::string &body,
  14958. const std::string &content_type,
  14959. UploadProgress progress) {
  14960. return send_with_content_provider_and_receiver(
  14961. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14962. content_type, nullptr, progress);
  14963. }
  14964. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14965. size_t content_length,
  14966. ContentProvider content_provider,
  14967. const std::string &content_type,
  14968. UploadProgress progress) {
  14969. return send_with_content_provider_and_receiver(
  14970. "PUT", path, headers, nullptr, content_length,
  14971. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14972. }
  14973. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14974. size_t content_length,
  14975. ContentProvider content_provider,
  14976. const std::string &content_type,
  14977. ContentReceiver content_receiver,
  14978. UploadProgress progress) {
  14979. return send_with_content_provider_and_receiver(
  14980. "PUT", path, headers, nullptr, content_length,
  14981. std::move(content_provider), nullptr, content_type,
  14982. std::move(content_receiver), progress);
  14983. }
  14984. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14985. ContentProviderWithoutLength content_provider,
  14986. const std::string &content_type,
  14987. UploadProgress progress) {
  14988. return send_with_content_provider_and_receiver(
  14989. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14990. content_type, nullptr, progress);
  14991. }
  14992. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14993. ContentProviderWithoutLength content_provider,
  14994. const std::string &content_type,
  14995. ContentReceiver content_receiver,
  14996. UploadProgress progress) {
  14997. return send_with_content_provider_and_receiver(
  14998. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14999. content_type, std::move(content_receiver), progress);
  15000. }
  15001. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15002. const UploadFormDataItems &items,
  15003. const FormDataProviderItems &provider_items,
  15004. UploadProgress progress) {
  15005. const auto &boundary = detail::make_multipart_data_boundary();
  15006. const auto &content_type =
  15007. detail::serialize_multipart_formdata_get_content_type(boundary);
  15008. return send_with_content_provider_and_receiver(
  15009. "PUT", path, headers, nullptr, 0, nullptr,
  15010. get_multipart_content_provider(boundary, items, provider_items),
  15011. content_type, nullptr, progress);
  15012. }
  15013. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  15014. const std::string &body,
  15015. const std::string &content_type,
  15016. ContentReceiver content_receiver,
  15017. DownloadProgress progress) {
  15018. Request req;
  15019. req.method = "PUT";
  15020. req.path = path;
  15021. req.headers = headers;
  15022. req.body = body;
  15023. req.content_receiver =
  15024. [content_receiver](const char *data, size_t data_length,
  15025. size_t /*offset*/, size_t /*total_length*/) {
  15026. return content_receiver(data, data_length);
  15027. };
  15028. req.download_progress = std::move(progress);
  15029. if (max_timeout_msec_ > 0) {
  15030. req.start_time_ = std::chrono::steady_clock::now();
  15031. }
  15032. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15033. return send_(std::move(req));
  15034. }
  15035. inline Result ClientImpl::Patch(const std::string &path) {
  15036. return Patch(path, std::string(), std::string());
  15037. }
  15038. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15039. UploadProgress progress) {
  15040. return Patch(path, headers, nullptr, 0, std::string(), progress);
  15041. }
  15042. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  15043. size_t content_length,
  15044. const std::string &content_type,
  15045. UploadProgress progress) {
  15046. return Patch(path, Headers(), body, content_length, content_type, progress);
  15047. }
  15048. inline Result ClientImpl::Patch(const std::string &path,
  15049. const std::string &body,
  15050. const std::string &content_type,
  15051. UploadProgress progress) {
  15052. return Patch(path, Headers(), body, content_type, progress);
  15053. }
  15054. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  15055. return Patch(path, Headers(), params);
  15056. }
  15057. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15058. ContentProvider content_provider,
  15059. const std::string &content_type,
  15060. UploadProgress progress) {
  15061. return Patch(path, Headers(), content_length, std::move(content_provider),
  15062. content_type, progress);
  15063. }
  15064. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  15065. ContentProvider content_provider,
  15066. const std::string &content_type,
  15067. ContentReceiver content_receiver,
  15068. UploadProgress progress) {
  15069. return Patch(path, Headers(), content_length, std::move(content_provider),
  15070. content_type, std::move(content_receiver), progress);
  15071. }
  15072. inline Result ClientImpl::Patch(const std::string &path,
  15073. ContentProviderWithoutLength content_provider,
  15074. const std::string &content_type,
  15075. UploadProgress progress) {
  15076. return Patch(path, Headers(), std::move(content_provider), content_type,
  15077. progress);
  15078. }
  15079. inline Result ClientImpl::Patch(const std::string &path,
  15080. ContentProviderWithoutLength content_provider,
  15081. const std::string &content_type,
  15082. ContentReceiver content_receiver,
  15083. UploadProgress progress) {
  15084. return Patch(path, Headers(), std::move(content_provider), content_type,
  15085. std::move(content_receiver), progress);
  15086. }
  15087. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15088. const Params &params) {
  15089. auto query = detail::params_to_query_str(params);
  15090. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  15091. }
  15092. inline Result ClientImpl::Patch(const std::string &path,
  15093. const UploadFormDataItems &items,
  15094. UploadProgress progress) {
  15095. return Patch(path, Headers(), items, progress);
  15096. }
  15097. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15098. const UploadFormDataItems &items,
  15099. UploadProgress progress) {
  15100. const auto &boundary = detail::make_multipart_data_boundary();
  15101. const auto &content_type =
  15102. detail::serialize_multipart_formdata_get_content_type(boundary);
  15103. auto content_length = detail::get_multipart_content_length(items, boundary);
  15104. return Patch(path, headers, content_length,
  15105. detail::make_multipart_content_provider(items, boundary),
  15106. content_type, progress);
  15107. }
  15108. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15109. const UploadFormDataItems &items,
  15110. const std::string &boundary,
  15111. UploadProgress progress) {
  15112. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  15113. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  15114. }
  15115. const auto &content_type =
  15116. detail::serialize_multipart_formdata_get_content_type(boundary);
  15117. auto content_length = detail::get_multipart_content_length(items, boundary);
  15118. return Patch(path, headers, content_length,
  15119. detail::make_multipart_content_provider(items, boundary),
  15120. content_type, progress);
  15121. }
  15122. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15123. const char *body, size_t content_length,
  15124. const std::string &content_type,
  15125. UploadProgress progress) {
  15126. return send_with_content_provider_and_receiver(
  15127. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  15128. content_type, nullptr, progress);
  15129. }
  15130. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15131. const std::string &body,
  15132. const std::string &content_type,
  15133. UploadProgress progress) {
  15134. return send_with_content_provider_and_receiver(
  15135. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  15136. content_type, nullptr, progress);
  15137. }
  15138. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15139. size_t content_length,
  15140. ContentProvider content_provider,
  15141. const std::string &content_type,
  15142. UploadProgress progress) {
  15143. return send_with_content_provider_and_receiver(
  15144. "PATCH", path, headers, nullptr, content_length,
  15145. std::move(content_provider), nullptr, content_type, nullptr, progress);
  15146. }
  15147. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15148. size_t content_length,
  15149. ContentProvider content_provider,
  15150. const std::string &content_type,
  15151. ContentReceiver content_receiver,
  15152. UploadProgress progress) {
  15153. return send_with_content_provider_and_receiver(
  15154. "PATCH", path, headers, nullptr, content_length,
  15155. std::move(content_provider), nullptr, content_type,
  15156. std::move(content_receiver), progress);
  15157. }
  15158. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15159. ContentProviderWithoutLength content_provider,
  15160. const std::string &content_type,
  15161. UploadProgress progress) {
  15162. return send_with_content_provider_and_receiver(
  15163. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15164. content_type, nullptr, progress);
  15165. }
  15166. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15167. ContentProviderWithoutLength content_provider,
  15168. const std::string &content_type,
  15169. ContentReceiver content_receiver,
  15170. UploadProgress progress) {
  15171. return send_with_content_provider_and_receiver(
  15172. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  15173. content_type, std::move(content_receiver), progress);
  15174. }
  15175. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15176. const UploadFormDataItems &items,
  15177. const FormDataProviderItems &provider_items,
  15178. UploadProgress progress) {
  15179. const auto &boundary = detail::make_multipart_data_boundary();
  15180. const auto &content_type =
  15181. detail::serialize_multipart_formdata_get_content_type(boundary);
  15182. return send_with_content_provider_and_receiver(
  15183. "PATCH", path, headers, nullptr, 0, nullptr,
  15184. get_multipart_content_provider(boundary, items, provider_items),
  15185. content_type, nullptr, progress);
  15186. }
  15187. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  15188. const std::string &body,
  15189. const std::string &content_type,
  15190. ContentReceiver content_receiver,
  15191. DownloadProgress progress) {
  15192. Request req;
  15193. req.method = "PATCH";
  15194. req.path = path;
  15195. req.headers = headers;
  15196. req.body = body;
  15197. req.content_receiver =
  15198. [content_receiver](const char *data, size_t data_length,
  15199. size_t /*offset*/, size_t /*total_length*/) {
  15200. return content_receiver(data, data_length);
  15201. };
  15202. req.download_progress = std::move(progress);
  15203. if (max_timeout_msec_ > 0) {
  15204. req.start_time_ = std::chrono::steady_clock::now();
  15205. }
  15206. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15207. return send_(std::move(req));
  15208. }
  15209. inline Result ClientImpl::Delete(const std::string &path,
  15210. DownloadProgress progress) {
  15211. return Delete(path, Headers(), std::string(), std::string(), progress);
  15212. }
  15213. inline Result ClientImpl::Delete(const std::string &path,
  15214. const Headers &headers,
  15215. DownloadProgress progress) {
  15216. return Delete(path, headers, std::string(), std::string(), progress);
  15217. }
  15218. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15219. size_t content_length,
  15220. const std::string &content_type,
  15221. DownloadProgress progress) {
  15222. return Delete(path, Headers(), body, content_length, content_type, progress);
  15223. }
  15224. inline Result ClientImpl::Delete(const std::string &path,
  15225. const std::string &body,
  15226. const std::string &content_type,
  15227. DownloadProgress progress) {
  15228. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15229. progress);
  15230. }
  15231. inline Result ClientImpl::Delete(const std::string &path,
  15232. const Headers &headers,
  15233. const std::string &body,
  15234. const std::string &content_type,
  15235. DownloadProgress progress) {
  15236. return Delete(path, headers, body.data(), body.size(), content_type,
  15237. progress);
  15238. }
  15239. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15240. DownloadProgress progress) {
  15241. return Delete(path, Headers(), params, progress);
  15242. }
  15243. inline Result ClientImpl::Delete(const std::string &path,
  15244. const Headers &headers, const Params &params,
  15245. DownloadProgress progress) {
  15246. auto query = detail::params_to_query_str(params);
  15247. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15248. progress);
  15249. }
  15250. inline Result ClientImpl::Delete(const std::string &path,
  15251. const Headers &headers, const char *body,
  15252. size_t content_length,
  15253. const std::string &content_type,
  15254. DownloadProgress progress) {
  15255. Request req;
  15256. req.method = "DELETE";
  15257. req.headers = headers;
  15258. req.path = path;
  15259. req.download_progress = std::move(progress);
  15260. if (max_timeout_msec_ > 0) {
  15261. req.start_time_ = std::chrono::steady_clock::now();
  15262. }
  15263. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15264. req.body.assign(body, content_length);
  15265. return send_(std::move(req));
  15266. }
  15267. inline Result ClientImpl::Options(const std::string &path) {
  15268. return Options(path, Headers());
  15269. }
  15270. inline Result ClientImpl::Options(const std::string &path,
  15271. const Headers &headers) {
  15272. Request req;
  15273. req.method = "OPTIONS";
  15274. req.headers = headers;
  15275. req.path = path;
  15276. if (max_timeout_msec_ > 0) {
  15277. req.start_time_ = std::chrono::steady_clock::now();
  15278. }
  15279. return send_(std::move(req));
  15280. }
  15281. inline void ClientImpl::stop() {
  15282. std::lock_guard<std::mutex> guard(socket_mutex_);
  15283. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15284. // do is to shutdown_socket, so that threads using this socket suddenly
  15285. // discover they can't read/write any more and error out. Everything else
  15286. // (closing the socket, shutting ssl down) is unsafe because these actions
  15287. // are not thread-safe.
  15288. if (socket_requests_in_flight_ > 0) {
  15289. shutdown_socket(socket_);
  15290. // Aside from that, we set a flag for the socket to be closed when we're
  15291. // done.
  15292. socket_should_be_closed_when_request_is_done_ = true;
  15293. return;
  15294. }
  15295. disconnect(/*gracefully=*/true);
  15296. }
  15297. inline std::string ClientImpl::host() const { return host_; }
  15298. inline int ClientImpl::port() const { return port_; }
  15299. inline size_t ClientImpl::is_socket_open() const {
  15300. std::lock_guard<std::mutex> guard(socket_mutex_);
  15301. return socket_.is_open();
  15302. }
  15303. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15304. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15305. connection_timeout_sec_ = sec;
  15306. connection_timeout_usec_ = usec;
  15307. }
  15308. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15309. read_timeout_sec_ = sec;
  15310. read_timeout_usec_ = usec;
  15311. }
  15312. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15313. write_timeout_sec_ = sec;
  15314. write_timeout_usec_ = usec;
  15315. }
  15316. inline void ClientImpl::set_max_timeout(time_t msec) {
  15317. max_timeout_msec_ = msec;
  15318. }
  15319. inline void ClientImpl::set_basic_auth(const std::string &username,
  15320. const std::string &password) {
  15321. basic_auth_username_ = username;
  15322. basic_auth_password_ = password;
  15323. }
  15324. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15325. bearer_token_auth_token_ = token;
  15326. }
  15327. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15328. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15329. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15330. inline void
  15331. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15332. addr_map_ = std::move(addr_map);
  15333. }
  15334. inline void ClientImpl::set_default_headers(Headers headers) {
  15335. default_headers_ = std::move(headers);
  15336. }
  15337. inline void ClientImpl::set_header_writer(
  15338. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15339. header_writer_ = writer;
  15340. }
  15341. inline void ClientImpl::set_address_family(int family) {
  15342. address_family_ = family;
  15343. }
  15344. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15345. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15346. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15347. socket_options_ = std::move(socket_options);
  15348. }
  15349. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15350. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15351. inline void ClientImpl::set_payload_max_length(size_t length) {
  15352. payload_max_length_ = length;
  15353. has_payload_max_length_ = true;
  15354. }
  15355. inline void ClientImpl::set_interface(const std::string &intf) {
  15356. interface_ = intf;
  15357. }
  15358. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15359. proxy_host_ = host;
  15360. proxy_port_ = port;
  15361. std::lock_guard<std::mutex> guard(socket_mutex_);
  15362. disconnect(/*gracefully=*/true);
  15363. }
  15364. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15365. const std::string &password) {
  15366. proxy_basic_auth_username_ = username;
  15367. proxy_basic_auth_password_ = password;
  15368. }
  15369. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15370. proxy_bearer_token_auth_token_ = token;
  15371. }
  15372. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15373. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  15374. std::lock_guard<std::mutex> guard(socket_mutex_);
  15375. disconnect(/*gracefully=*/true);
  15376. }
  15377. #ifdef CPPHTTPLIB_SSL_ENABLED
  15378. inline void ClientImpl::set_digest_auth(const std::string &username,
  15379. const std::string &password) {
  15380. digest_auth_username_ = username;
  15381. digest_auth_password_ = password;
  15382. }
  15383. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15384. const std::string &ca_cert_dir_path) {
  15385. ca_cert_file_path_ = ca_cert_file_path;
  15386. ca_cert_dir_path_ = ca_cert_dir_path;
  15387. }
  15388. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15389. const std::string &password) {
  15390. proxy_digest_auth_username_ = username;
  15391. proxy_digest_auth_password_ = password;
  15392. }
  15393. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15394. server_certificate_verification_ = enabled;
  15395. }
  15396. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15397. server_hostname_verification_ = enabled;
  15398. }
  15399. inline void ClientImpl::enable_system_ca(bool enabled) {
  15400. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15401. }
  15402. #endif
  15403. inline void ClientImpl::set_logger(Logger logger) {
  15404. logger_ = std::move(logger);
  15405. }
  15406. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15407. error_logger_ = std::move(error_logger);
  15408. }
  15409. /*
  15410. * SSL/TLS Common Implementation
  15411. */
  15412. inline ClientConnection::~ClientConnection() {
  15413. #ifdef CPPHTTPLIB_SSL_ENABLED
  15414. if (session) {
  15415. tls::shutdown(session, true);
  15416. tls::free_session(session);
  15417. session = nullptr;
  15418. }
  15419. #endif
  15420. if (sock != INVALID_SOCKET) {
  15421. detail::close_socket(sock);
  15422. sock = INVALID_SOCKET;
  15423. }
  15424. }
  15425. // Universal client implementation
  15426. inline Client::Client(const std::string &scheme_host_port)
  15427. : Client(scheme_host_port, std::string(), std::string()) {}
  15428. inline Client::Client(const std::string &scheme_host_port,
  15429. const std::string &client_cert_path,
  15430. const std::string &client_key_path) {
  15431. detail::UrlComponents uc;
  15432. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15433. auto &scheme = uc.scheme;
  15434. #ifdef CPPHTTPLIB_SSL_ENABLED
  15435. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15436. #else
  15437. if (!scheme.empty() && scheme != "http") {
  15438. #endif
  15439. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15440. std::string msg = "'" + scheme + "' scheme is not supported.";
  15441. throw std::invalid_argument(msg);
  15442. #endif
  15443. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15444. return;
  15445. }
  15446. auto is_ssl = scheme == "https";
  15447. auto host = std::move(uc.host);
  15448. auto port = is_ssl ? 443 : 80;
  15449. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15450. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15451. return;
  15452. }
  15453. if (is_ssl) {
  15454. #ifdef CPPHTTPLIB_SSL_ENABLED
  15455. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15456. client_key_path);
  15457. is_ssl_ = is_ssl;
  15458. #endif
  15459. } else {
  15460. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15461. client_key_path);
  15462. }
  15463. } else if (scheme_host_port.compare(0, 2, "//") == 0 ||
  15464. scheme_host_port.find("://") < scheme_host_port.find('/')) {
  15465. // A URL, but not one this client can use, such as one with userinfo. A
  15466. // Unix socket path may have "//" further on.
  15467. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15468. } else {
  15469. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15470. // if port param below changes.
  15471. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15472. client_cert_path, client_key_path);
  15473. }
  15474. }
  15475. inline Client::Client(const std::string &host, int port)
  15476. : Client(host, port, std::string(), std::string()) {}
  15477. inline Client::Client(const std::string &host, int port,
  15478. const std::string &client_cert_path,
  15479. const std::string &client_key_path)
  15480. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15481. client_key_path)) {}
  15482. inline Client::~Client() = default;
  15483. inline bool Client::is_valid() const {
  15484. return cli_ != nullptr && cli_->is_valid();
  15485. }
  15486. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15487. return cli_->Get(path, std::move(progress));
  15488. }
  15489. inline Result Client::Get(const std::string &path, const Headers &headers,
  15490. DownloadProgress progress) {
  15491. return cli_->Get(path, headers, std::move(progress));
  15492. }
  15493. inline Result Client::Get(const std::string &path,
  15494. ContentReceiver content_receiver,
  15495. DownloadProgress progress) {
  15496. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15497. }
  15498. inline Result Client::Get(const std::string &path, const Headers &headers,
  15499. ContentReceiver content_receiver,
  15500. DownloadProgress progress) {
  15501. return cli_->Get(path, headers, std::move(content_receiver),
  15502. std::move(progress));
  15503. }
  15504. inline Result Client::Get(const std::string &path,
  15505. ResponseHandler response_handler,
  15506. ContentReceiver content_receiver,
  15507. DownloadProgress progress) {
  15508. return cli_->Get(path, std::move(response_handler),
  15509. std::move(content_receiver), std::move(progress));
  15510. }
  15511. inline Result Client::Get(const std::string &path, const Headers &headers,
  15512. ResponseHandler response_handler,
  15513. ContentReceiver content_receiver,
  15514. DownloadProgress progress) {
  15515. return cli_->Get(path, headers, std::move(response_handler),
  15516. std::move(content_receiver), std::move(progress));
  15517. }
  15518. inline Result Client::Get(const std::string &path, const Params &params,
  15519. DownloadProgress progress) {
  15520. return cli_->Get(path, params, std::move(progress));
  15521. }
  15522. inline Result Client::Get(const std::string &path, const Params &params,
  15523. const Headers &headers, DownloadProgress progress) {
  15524. return cli_->Get(path, params, headers, std::move(progress));
  15525. }
  15526. inline Result Client::Get(const std::string &path, const Params &params,
  15527. const Headers &headers,
  15528. ContentReceiver content_receiver,
  15529. DownloadProgress progress) {
  15530. return cli_->Get(path, params, headers, std::move(content_receiver),
  15531. std::move(progress));
  15532. }
  15533. inline Result Client::Get(const std::string &path, const Params &params,
  15534. const Headers &headers,
  15535. ResponseHandler response_handler,
  15536. ContentReceiver content_receiver,
  15537. DownloadProgress progress) {
  15538. return cli_->Get(path, params, headers, std::move(response_handler),
  15539. std::move(content_receiver), std::move(progress));
  15540. }
  15541. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15542. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15543. return cli_->Head(path, headers);
  15544. }
  15545. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15546. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15547. return cli_->Post(path, headers);
  15548. }
  15549. inline Result Client::Post(const std::string &path, const char *body,
  15550. size_t content_length,
  15551. const std::string &content_type,
  15552. UploadProgress progress) {
  15553. return cli_->Post(path, body, content_length, content_type, progress);
  15554. }
  15555. inline Result Client::Post(const std::string &path, const Headers &headers,
  15556. const char *body, size_t content_length,
  15557. const std::string &content_type,
  15558. UploadProgress progress) {
  15559. return cli_->Post(path, headers, body, content_length, content_type,
  15560. progress);
  15561. }
  15562. inline Result Client::Post(const std::string &path, const std::string &body,
  15563. const std::string &content_type,
  15564. UploadProgress progress) {
  15565. return cli_->Post(path, body, content_type, progress);
  15566. }
  15567. inline Result Client::Post(const std::string &path, const Headers &headers,
  15568. const std::string &body,
  15569. const std::string &content_type,
  15570. UploadProgress progress) {
  15571. return cli_->Post(path, headers, body, content_type, progress);
  15572. }
  15573. inline Result Client::Post(const std::string &path, size_t content_length,
  15574. ContentProvider content_provider,
  15575. const std::string &content_type,
  15576. UploadProgress progress) {
  15577. return cli_->Post(path, content_length, std::move(content_provider),
  15578. content_type, progress);
  15579. }
  15580. inline Result Client::Post(const std::string &path, size_t content_length,
  15581. ContentProvider content_provider,
  15582. const std::string &content_type,
  15583. ContentReceiver content_receiver,
  15584. UploadProgress progress) {
  15585. return cli_->Post(path, content_length, std::move(content_provider),
  15586. content_type, std::move(content_receiver), progress);
  15587. }
  15588. inline Result Client::Post(const std::string &path,
  15589. ContentProviderWithoutLength content_provider,
  15590. const std::string &content_type,
  15591. UploadProgress progress) {
  15592. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15593. }
  15594. inline Result Client::Post(const std::string &path,
  15595. ContentProviderWithoutLength content_provider,
  15596. const std::string &content_type,
  15597. ContentReceiver content_receiver,
  15598. UploadProgress progress) {
  15599. return cli_->Post(path, std::move(content_provider), content_type,
  15600. std::move(content_receiver), progress);
  15601. }
  15602. inline Result Client::Post(const std::string &path, const Headers &headers,
  15603. size_t content_length,
  15604. ContentProvider content_provider,
  15605. const std::string &content_type,
  15606. UploadProgress progress) {
  15607. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15608. content_type, progress);
  15609. }
  15610. inline Result Client::Post(const std::string &path, const Headers &headers,
  15611. size_t content_length,
  15612. ContentProvider content_provider,
  15613. const std::string &content_type,
  15614. ContentReceiver content_receiver,
  15615. DownloadProgress progress) {
  15616. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15617. content_type, std::move(content_receiver), progress);
  15618. }
  15619. inline Result Client::Post(const std::string &path, const Headers &headers,
  15620. ContentProviderWithoutLength content_provider,
  15621. const std::string &content_type,
  15622. UploadProgress progress) {
  15623. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15624. progress);
  15625. }
  15626. inline Result Client::Post(const std::string &path, const Headers &headers,
  15627. ContentProviderWithoutLength content_provider,
  15628. const std::string &content_type,
  15629. ContentReceiver content_receiver,
  15630. DownloadProgress progress) {
  15631. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15632. std::move(content_receiver), progress);
  15633. }
  15634. inline Result Client::Post(const std::string &path, const Params &params) {
  15635. return cli_->Post(path, params);
  15636. }
  15637. inline Result Client::Post(const std::string &path, const Headers &headers,
  15638. const Params &params) {
  15639. return cli_->Post(path, headers, params);
  15640. }
  15641. inline Result Client::Post(const std::string &path,
  15642. const UploadFormDataItems &items,
  15643. UploadProgress progress) {
  15644. return cli_->Post(path, items, progress);
  15645. }
  15646. inline Result Client::Post(const std::string &path, const Headers &headers,
  15647. const UploadFormDataItems &items,
  15648. UploadProgress progress) {
  15649. return cli_->Post(path, headers, items, progress);
  15650. }
  15651. inline Result Client::Post(const std::string &path, const Headers &headers,
  15652. const UploadFormDataItems &items,
  15653. const std::string &boundary,
  15654. UploadProgress progress) {
  15655. return cli_->Post(path, headers, items, boundary, progress);
  15656. }
  15657. inline Result Client::Post(const std::string &path, const Headers &headers,
  15658. const UploadFormDataItems &items,
  15659. const FormDataProviderItems &provider_items,
  15660. UploadProgress progress) {
  15661. return cli_->Post(path, headers, items, provider_items, progress);
  15662. }
  15663. inline Result Client::Post(const std::string &path, const Headers &headers,
  15664. const std::string &body,
  15665. const std::string &content_type,
  15666. ContentReceiver content_receiver,
  15667. DownloadProgress progress) {
  15668. return cli_->Post(path, headers, body, content_type,
  15669. std::move(content_receiver), progress);
  15670. }
  15671. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15672. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15673. return cli_->Put(path, headers);
  15674. }
  15675. inline Result Client::Put(const std::string &path, const char *body,
  15676. size_t content_length,
  15677. const std::string &content_type,
  15678. UploadProgress progress) {
  15679. return cli_->Put(path, body, content_length, content_type, progress);
  15680. }
  15681. inline Result Client::Put(const std::string &path, const Headers &headers,
  15682. const char *body, size_t content_length,
  15683. const std::string &content_type,
  15684. UploadProgress progress) {
  15685. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15686. }
  15687. inline Result Client::Put(const std::string &path, const std::string &body,
  15688. const std::string &content_type,
  15689. UploadProgress progress) {
  15690. return cli_->Put(path, body, content_type, progress);
  15691. }
  15692. inline Result Client::Put(const std::string &path, const Headers &headers,
  15693. const std::string &body,
  15694. const std::string &content_type,
  15695. UploadProgress progress) {
  15696. return cli_->Put(path, headers, body, content_type, progress);
  15697. }
  15698. inline Result Client::Put(const std::string &path, size_t content_length,
  15699. ContentProvider content_provider,
  15700. const std::string &content_type,
  15701. UploadProgress progress) {
  15702. return cli_->Put(path, content_length, std::move(content_provider),
  15703. content_type, progress);
  15704. }
  15705. inline Result Client::Put(const std::string &path, size_t content_length,
  15706. ContentProvider content_provider,
  15707. const std::string &content_type,
  15708. ContentReceiver content_receiver,
  15709. UploadProgress progress) {
  15710. return cli_->Put(path, content_length, std::move(content_provider),
  15711. content_type, std::move(content_receiver), progress);
  15712. }
  15713. inline Result Client::Put(const std::string &path,
  15714. ContentProviderWithoutLength content_provider,
  15715. const std::string &content_type,
  15716. UploadProgress progress) {
  15717. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15718. }
  15719. inline Result Client::Put(const std::string &path,
  15720. ContentProviderWithoutLength content_provider,
  15721. const std::string &content_type,
  15722. ContentReceiver content_receiver,
  15723. UploadProgress progress) {
  15724. return cli_->Put(path, std::move(content_provider), content_type,
  15725. std::move(content_receiver), progress);
  15726. }
  15727. inline Result Client::Put(const std::string &path, const Headers &headers,
  15728. size_t content_length,
  15729. ContentProvider content_provider,
  15730. const std::string &content_type,
  15731. UploadProgress progress) {
  15732. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15733. content_type, progress);
  15734. }
  15735. inline Result Client::Put(const std::string &path, const Headers &headers,
  15736. size_t content_length,
  15737. ContentProvider content_provider,
  15738. const std::string &content_type,
  15739. ContentReceiver content_receiver,
  15740. UploadProgress progress) {
  15741. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15742. content_type, std::move(content_receiver), progress);
  15743. }
  15744. inline Result Client::Put(const std::string &path, const Headers &headers,
  15745. ContentProviderWithoutLength content_provider,
  15746. const std::string &content_type,
  15747. UploadProgress progress) {
  15748. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15749. progress);
  15750. }
  15751. inline Result Client::Put(const std::string &path, const Headers &headers,
  15752. ContentProviderWithoutLength content_provider,
  15753. const std::string &content_type,
  15754. ContentReceiver content_receiver,
  15755. UploadProgress progress) {
  15756. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15757. std::move(content_receiver), progress);
  15758. }
  15759. inline Result Client::Put(const std::string &path, const Params &params) {
  15760. return cli_->Put(path, params);
  15761. }
  15762. inline Result Client::Put(const std::string &path, const Headers &headers,
  15763. const Params &params) {
  15764. return cli_->Put(path, headers, params);
  15765. }
  15766. inline Result Client::Put(const std::string &path,
  15767. const UploadFormDataItems &items,
  15768. UploadProgress progress) {
  15769. return cli_->Put(path, items, progress);
  15770. }
  15771. inline Result Client::Put(const std::string &path, const Headers &headers,
  15772. const UploadFormDataItems &items,
  15773. UploadProgress progress) {
  15774. return cli_->Put(path, headers, items, progress);
  15775. }
  15776. inline Result Client::Put(const std::string &path, const Headers &headers,
  15777. const UploadFormDataItems &items,
  15778. const std::string &boundary,
  15779. UploadProgress progress) {
  15780. return cli_->Put(path, headers, items, boundary, progress);
  15781. }
  15782. inline Result Client::Put(const std::string &path, const Headers &headers,
  15783. const UploadFormDataItems &items,
  15784. const FormDataProviderItems &provider_items,
  15785. UploadProgress progress) {
  15786. return cli_->Put(path, headers, items, provider_items, progress);
  15787. }
  15788. inline Result Client::Put(const std::string &path, const Headers &headers,
  15789. const std::string &body,
  15790. const std::string &content_type,
  15791. ContentReceiver content_receiver,
  15792. DownloadProgress progress) {
  15793. return cli_->Put(path, headers, body, content_type, content_receiver,
  15794. progress);
  15795. }
  15796. inline Result Client::Patch(const std::string &path) {
  15797. return cli_->Patch(path);
  15798. }
  15799. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15800. return cli_->Patch(path, headers);
  15801. }
  15802. inline Result Client::Patch(const std::string &path, const char *body,
  15803. size_t content_length,
  15804. const std::string &content_type,
  15805. UploadProgress progress) {
  15806. return cli_->Patch(path, body, content_length, content_type, progress);
  15807. }
  15808. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15809. const char *body, size_t content_length,
  15810. const std::string &content_type,
  15811. UploadProgress progress) {
  15812. return cli_->Patch(path, headers, body, content_length, content_type,
  15813. progress);
  15814. }
  15815. inline Result Client::Patch(const std::string &path, const std::string &body,
  15816. const std::string &content_type,
  15817. UploadProgress progress) {
  15818. return cli_->Patch(path, body, content_type, progress);
  15819. }
  15820. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15821. const std::string &body,
  15822. const std::string &content_type,
  15823. UploadProgress progress) {
  15824. return cli_->Patch(path, headers, body, content_type, progress);
  15825. }
  15826. inline Result Client::Patch(const std::string &path, size_t content_length,
  15827. ContentProvider content_provider,
  15828. const std::string &content_type,
  15829. UploadProgress progress) {
  15830. return cli_->Patch(path, content_length, std::move(content_provider),
  15831. content_type, progress);
  15832. }
  15833. inline Result Client::Patch(const std::string &path, size_t content_length,
  15834. ContentProvider content_provider,
  15835. const std::string &content_type,
  15836. ContentReceiver content_receiver,
  15837. UploadProgress progress) {
  15838. return cli_->Patch(path, content_length, std::move(content_provider),
  15839. content_type, std::move(content_receiver), progress);
  15840. }
  15841. inline Result Client::Patch(const std::string &path,
  15842. ContentProviderWithoutLength content_provider,
  15843. const std::string &content_type,
  15844. UploadProgress progress) {
  15845. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15846. }
  15847. inline Result Client::Patch(const std::string &path,
  15848. ContentProviderWithoutLength content_provider,
  15849. const std::string &content_type,
  15850. ContentReceiver content_receiver,
  15851. UploadProgress progress) {
  15852. return cli_->Patch(path, std::move(content_provider), content_type,
  15853. std::move(content_receiver), progress);
  15854. }
  15855. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15856. size_t content_length,
  15857. ContentProvider content_provider,
  15858. const std::string &content_type,
  15859. UploadProgress progress) {
  15860. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15861. content_type, progress);
  15862. }
  15863. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15864. size_t content_length,
  15865. ContentProvider content_provider,
  15866. const std::string &content_type,
  15867. ContentReceiver content_receiver,
  15868. UploadProgress progress) {
  15869. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15870. content_type, std::move(content_receiver), progress);
  15871. }
  15872. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15873. ContentProviderWithoutLength content_provider,
  15874. const std::string &content_type,
  15875. UploadProgress progress) {
  15876. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15877. progress);
  15878. }
  15879. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15880. ContentProviderWithoutLength content_provider,
  15881. const std::string &content_type,
  15882. ContentReceiver content_receiver,
  15883. UploadProgress progress) {
  15884. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15885. std::move(content_receiver), progress);
  15886. }
  15887. inline Result Client::Patch(const std::string &path, const Params &params) {
  15888. return cli_->Patch(path, params);
  15889. }
  15890. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15891. const Params &params) {
  15892. return cli_->Patch(path, headers, params);
  15893. }
  15894. inline Result Client::Patch(const std::string &path,
  15895. const UploadFormDataItems &items,
  15896. UploadProgress progress) {
  15897. return cli_->Patch(path, items, progress);
  15898. }
  15899. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15900. const UploadFormDataItems &items,
  15901. UploadProgress progress) {
  15902. return cli_->Patch(path, headers, items, progress);
  15903. }
  15904. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15905. const UploadFormDataItems &items,
  15906. const std::string &boundary,
  15907. UploadProgress progress) {
  15908. return cli_->Patch(path, headers, items, boundary, progress);
  15909. }
  15910. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15911. const UploadFormDataItems &items,
  15912. const FormDataProviderItems &provider_items,
  15913. UploadProgress progress) {
  15914. return cli_->Patch(path, headers, items, provider_items, progress);
  15915. }
  15916. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15917. const std::string &body,
  15918. const std::string &content_type,
  15919. ContentReceiver content_receiver,
  15920. DownloadProgress progress) {
  15921. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15922. progress);
  15923. }
  15924. inline Result Client::Delete(const std::string &path,
  15925. DownloadProgress progress) {
  15926. return cli_->Delete(path, progress);
  15927. }
  15928. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15929. DownloadProgress progress) {
  15930. return cli_->Delete(path, headers, progress);
  15931. }
  15932. inline Result Client::Delete(const std::string &path, const char *body,
  15933. size_t content_length,
  15934. const std::string &content_type,
  15935. DownloadProgress progress) {
  15936. return cli_->Delete(path, body, content_length, content_type, progress);
  15937. }
  15938. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15939. const char *body, size_t content_length,
  15940. const std::string &content_type,
  15941. DownloadProgress progress) {
  15942. return cli_->Delete(path, headers, body, content_length, content_type,
  15943. progress);
  15944. }
  15945. inline Result Client::Delete(const std::string &path, const std::string &body,
  15946. const std::string &content_type,
  15947. DownloadProgress progress) {
  15948. return cli_->Delete(path, body, content_type, progress);
  15949. }
  15950. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15951. const std::string &body,
  15952. const std::string &content_type,
  15953. DownloadProgress progress) {
  15954. return cli_->Delete(path, headers, body, content_type, progress);
  15955. }
  15956. inline Result Client::Delete(const std::string &path, const Params &params,
  15957. DownloadProgress progress) {
  15958. return cli_->Delete(path, params, progress);
  15959. }
  15960. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15961. const Params &params, DownloadProgress progress) {
  15962. return cli_->Delete(path, headers, params, progress);
  15963. }
  15964. inline Result Client::Options(const std::string &path) {
  15965. return cli_->Options(path);
  15966. }
  15967. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15968. return cli_->Options(path, headers);
  15969. }
  15970. inline ClientImpl::StreamHandle
  15971. Client::open_stream(const std::string &method, const std::string &path,
  15972. const Params &params, const Headers &headers,
  15973. const std::string &body, const std::string &content_type) {
  15974. return cli_->open_stream(method, path, params, headers, body, content_type);
  15975. }
  15976. inline bool Client::send(Request &req, Response &res, Error &error) {
  15977. return cli_->send(req, res, error);
  15978. }
  15979. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15980. inline void Client::stop() { cli_->stop(); }
  15981. inline std::string Client::host() const { return cli_->host(); }
  15982. inline int Client::port() const { return cli_->port(); }
  15983. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15984. inline socket_t Client::socket() const { return cli_->socket(); }
  15985. inline void
  15986. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15987. cli_->set_hostname_addr_map(std::move(addr_map));
  15988. }
  15989. inline void Client::set_default_headers(Headers headers) {
  15990. cli_->set_default_headers(std::move(headers));
  15991. }
  15992. inline void Client::set_header_writer(
  15993. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15994. cli_->set_header_writer(writer);
  15995. }
  15996. inline void Client::set_address_family(int family) {
  15997. cli_->set_address_family(family);
  15998. }
  15999. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  16000. inline void Client::set_socket_options(SocketOptions socket_options) {
  16001. cli_->set_socket_options(std::move(socket_options));
  16002. }
  16003. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  16004. cli_->set_connection_timeout(sec, usec);
  16005. }
  16006. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  16007. cli_->set_read_timeout(sec, usec);
  16008. }
  16009. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  16010. cli_->set_write_timeout(sec, usec);
  16011. }
  16012. inline void Client::set_basic_auth(const std::string &username,
  16013. const std::string &password) {
  16014. cli_->set_basic_auth(username, password);
  16015. }
  16016. inline void Client::set_bearer_token_auth(const std::string &token) {
  16017. cli_->set_bearer_token_auth(token);
  16018. }
  16019. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  16020. inline void Client::set_follow_location(bool on) {
  16021. cli_->set_follow_location(on);
  16022. }
  16023. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  16024. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  16025. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  16026. inline void Client::set_payload_max_length(size_t length) {
  16027. cli_->set_payload_max_length(length);
  16028. }
  16029. inline void Client::set_interface(const std::string &intf) {
  16030. cli_->set_interface(intf);
  16031. }
  16032. inline void Client::set_proxy(const std::string &host, int port) {
  16033. cli_->set_proxy(host, port);
  16034. }
  16035. inline void Client::set_proxy_basic_auth(const std::string &username,
  16036. const std::string &password) {
  16037. cli_->set_proxy_basic_auth(username, password);
  16038. }
  16039. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  16040. cli_->set_proxy_bearer_token_auth(token);
  16041. }
  16042. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  16043. cli_->set_no_proxy(patterns);
  16044. }
  16045. inline void Client::set_logger(Logger logger) {
  16046. cli_->set_logger(std::move(logger));
  16047. }
  16048. inline void Client::set_error_logger(ErrorLogger error_logger) {
  16049. cli_->set_error_logger(std::move(error_logger));
  16050. }
  16051. /*
  16052. * Group 6: SSL Server and Client implementation
  16053. */
  16054. #ifdef CPPHTTPLIB_SSL_ENABLED
  16055. // SSL HTTP server implementation
  16056. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  16057. const char *client_ca_cert_file_path,
  16058. const char *client_ca_cert_dir_path,
  16059. const char *private_key_password) {
  16060. using namespace tls;
  16061. ctx_ = create_server_context();
  16062. if (!ctx_) { return; }
  16063. // Load server certificate and private key
  16064. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  16065. private_key_password)) {
  16066. last_ssl_error_ = static_cast<int>(get_error());
  16067. free_context(ctx_);
  16068. ctx_ = nullptr;
  16069. return;
  16070. }
  16071. // Load client CA certificates for client authentication
  16072. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  16073. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  16074. client_ca_cert_dir_path)) {
  16075. last_ssl_error_ = static_cast<int>(get_error());
  16076. free_context(ctx_);
  16077. ctx_ = nullptr;
  16078. return;
  16079. }
  16080. // Enable client certificate verification
  16081. set_verify_client(ctx_, true);
  16082. }
  16083. }
  16084. inline SSLServer::SSLServer(const PemMemory &pem) {
  16085. using namespace tls;
  16086. ctx_ = create_server_context();
  16087. if (ctx_) {
  16088. std::string cert_buf, key_buf;
  16089. if (!set_server_cert_pem(
  16090. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16091. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16092. pem.private_key_password)) {
  16093. last_ssl_error_ = static_cast<int>(get_error());
  16094. free_context(ctx_);
  16095. ctx_ = nullptr;
  16096. } else if (pem.client_ca_pem) {
  16097. auto ca_len = pem.client_ca_pem_len ? pem.client_ca_pem_len
  16098. : strlen(pem.client_ca_pem);
  16099. if (!load_ca_pem(ctx_, pem.client_ca_pem, ca_len)) {
  16100. last_ssl_error_ = static_cast<int>(get_error());
  16101. free_context(ctx_);
  16102. ctx_ = nullptr;
  16103. } else {
  16104. set_verify_client(ctx_, true);
  16105. }
  16106. }
  16107. }
  16108. }
  16109. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  16110. using namespace tls;
  16111. ctx_ = create_server_context();
  16112. if (ctx_) {
  16113. if (!setup_callback(ctx_)) {
  16114. free_context(ctx_);
  16115. ctx_ = nullptr;
  16116. }
  16117. }
  16118. }
  16119. inline SSLServer::~SSLServer() {
  16120. if (ctx_) { tls::free_context(ctx_); }
  16121. }
  16122. inline bool SSLServer::is_valid() const {
  16123. return ctx_ != nullptr && Server::is_valid();
  16124. }
  16125. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  16126. using namespace tls;
  16127. session_t session = nullptr;
  16128. {
  16129. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16130. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  16131. session = create_session(static_cast<ctx_t>(ctx_), sock);
  16132. if (session) { handshakes_in_progress_++; }
  16133. }
  16134. if (!session) {
  16135. last_ssl_error_ = static_cast<int>(get_error());
  16136. detail::shutdown_socket(sock);
  16137. detail::close_socket(sock);
  16138. return false;
  16139. }
  16140. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  16141. bool handshake_done = false;
  16142. bool ret = false;
  16143. bool websocket_upgraded = false;
  16144. auto cleanup = detail::scope_exit([&] {
  16145. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  16146. free_session(session);
  16147. detail::shutdown_socket(sock);
  16148. detail::close_socket(sock);
  16149. });
  16150. // Perform TLS accept handshake with timeout
  16151. TlsError tls_err;
  16152. auto accepted = false;
  16153. {
  16154. auto handshake_left = detail::scope_exit([&] {
  16155. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16156. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  16157. });
  16158. accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  16159. read_timeout_usec_, &tls_err);
  16160. }
  16161. if (!accepted) {
  16162. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16163. // Map TlsError to legacy ssl_error for backward compatibility
  16164. if (tls_err.code == ErrorCode::WantRead) {
  16165. last_ssl_error_ = SSL_ERROR_WANT_READ;
  16166. } else if (tls_err.code == ErrorCode::WantWrite) {
  16167. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  16168. } else {
  16169. last_ssl_error_ = SSL_ERROR_SSL;
  16170. }
  16171. #else
  16172. last_ssl_error_ = static_cast<int>(get_error());
  16173. #endif
  16174. return false;
  16175. }
  16176. handshake_done = true;
  16177. std::string remote_addr;
  16178. int remote_port = 0;
  16179. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  16180. std::string local_addr;
  16181. int local_port = 0;
  16182. detail::get_local_ip_and_port(sock, local_addr, local_port);
  16183. ret = serve_guarded([&]() {
  16184. return detail::process_server_socket_ssl(
  16185. svr_sock_, session, sock, keep_alive_max_count_,
  16186. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  16187. write_timeout_sec_, write_timeout_usec_,
  16188. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  16189. return process_request(
  16190. strm, remote_addr, remote_port, local_addr, local_port,
  16191. close_connection, connection_closed,
  16192. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  16193. });
  16194. });
  16195. return ret;
  16196. }
  16197. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  16198. const char *key_pem,
  16199. const char *client_ca_pem,
  16200. const char *password) {
  16201. if (!ctx_) { return false; }
  16202. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16203. updates_pending_++;
  16204. auto se = detail::scope_exit([&] {
  16205. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16206. });
  16207. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16208. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16209. return false;
  16210. }
  16211. if (client_ca_pem) {
  16212. if (!tls::update_server_client_ca(ctx_, client_ca_pem)) { return false; }
  16213. // As in the constructors, a client CA makes client certificates required
  16214. tls::set_verify_client(ctx_, true);
  16215. }
  16216. return true;
  16217. }
  16218. // SSL HTTP client implementation
  16219. inline SSLClient::~SSLClient() {
  16220. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16221. // base function rather than the derived function once we get to the
  16222. // base class destructor, and won't free the SSL (causing a leak).
  16223. // This must happen before the context is freed below: some backends
  16224. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16225. // context, so freeing the context first leaves close_notify reading
  16226. // freed memory.
  16227. shutdown_ssl_impl(socket_, true);
  16228. if (ctx_) {
  16229. tls::free_context(ctx_);
  16230. ctx_ = nullptr;
  16231. }
  16232. }
  16233. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16234. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16235. shutdown_ssl_impl(socket, shutdown_gracefully);
  16236. }
  16237. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16238. bool shutdown_gracefully) {
  16239. if (socket.sock == INVALID_SOCKET) {
  16240. assert(socket.ssl == nullptr);
  16241. return;
  16242. }
  16243. if (socket.ssl) {
  16244. tls::shutdown(socket.ssl, shutdown_gracefully);
  16245. {
  16246. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16247. tls::free_session(socket.ssl);
  16248. }
  16249. socket.ssl = nullptr;
  16250. }
  16251. assert(socket.ssl == nullptr);
  16252. }
  16253. inline bool SSLClient::process_socket(
  16254. const Socket &socket,
  16255. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16256. std::function<bool(Stream &strm)> callback) {
  16257. assert(socket.ssl);
  16258. return detail::process_client_socket_ssl(
  16259. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16260. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16261. [&](detail::SSLSocketStream &strm) {
  16262. auto ret = callback(strm);
  16263. // A request that failed after the handshake reports Error::Read or
  16264. // Error::Write; keep the TLS error behind it, such as a fatal alert
  16265. // from the server, for Result::ssl_error() and ssl_backend_error()
  16266. const auto &tls_error = strm.tls_error();
  16267. if (!ret && tls_error.code != tls::ErrorCode::Success) {
  16268. last_ssl_error_ = static_cast<int>(tls_error.code);
  16269. last_backend_error_ = tls_error.backend_code;
  16270. }
  16271. return ret;
  16272. });
  16273. }
  16274. inline bool SSLClient::is_ssl() const { return true; }
  16275. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16276. if (!is_valid()) {
  16277. error = Error::SSLConnection;
  16278. return false;
  16279. }
  16280. return ClientImpl::create_and_connect_socket(socket, error);
  16281. }
  16282. inline bool SSLClient::setup_proxy_connection(
  16283. Socket &socket,
  16284. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16285. Response &res, bool &success, Error &error) {
  16286. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16287. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16288. return false;
  16289. }
  16290. if (!initialize_ssl(socket, error)) {
  16291. success = false;
  16292. return false;
  16293. }
  16294. return true;
  16295. }
  16296. // Assumes that socket_mutex_ is locked and that there are no requests in
  16297. // flight
  16298. inline bool SSLClient::connect_with_proxy(
  16299. Socket &socket,
  16300. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16301. Response &res, bool &success, Error &error) {
  16302. success = true;
  16303. Response proxy_res;
  16304. if (!detail::process_client_socket(
  16305. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16306. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16307. start_time, [&](Stream &strm) {
  16308. Request req2;
  16309. req2.method = "CONNECT";
  16310. req2.path =
  16311. detail::make_host_and_port_string_always_port(host_, port_);
  16312. if (max_timeout_msec_ > 0) {
  16313. req2.start_time_ = std::chrono::steady_clock::now();
  16314. }
  16315. return process_request(strm, req2, proxy_res, false, error);
  16316. })) {
  16317. // Thread-safe to close everything because we are assuming there are no
  16318. // requests in flight
  16319. shutdown_ssl(socket, true);
  16320. shutdown_socket(socket);
  16321. close_socket(socket);
  16322. success = false;
  16323. return false;
  16324. }
  16325. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16326. if (!proxy_digest_auth_username_.empty() &&
  16327. !proxy_digest_auth_password_.empty()) {
  16328. std::map<std::string, std::string> auth;
  16329. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16330. // Close the current socket and create a new one for the authenticated
  16331. // request
  16332. shutdown_ssl(socket, true);
  16333. shutdown_socket(socket);
  16334. close_socket(socket);
  16335. // Create a new socket for the authenticated CONNECT request
  16336. if (!ensure_socket_connection(socket, error)) {
  16337. success = false;
  16338. return false;
  16339. }
  16340. proxy_res = Response();
  16341. if (!detail::process_client_socket(
  16342. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16343. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16344. start_time, [&](Stream &strm) {
  16345. Request req3;
  16346. req3.method = "CONNECT";
  16347. req3.path = detail::make_host_and_port_string_always_port(
  16348. host_, port_);
  16349. req3.headers.insert(detail::make_digest_authentication_header(
  16350. req3, make_request_target(req3), auth, 1,
  16351. detail::random_string(10), proxy_digest_auth_username_,
  16352. proxy_digest_auth_password_, true));
  16353. if (max_timeout_msec_ > 0) {
  16354. req3.start_time_ = std::chrono::steady_clock::now();
  16355. }
  16356. return process_request(strm, req3, proxy_res, false, error);
  16357. })) {
  16358. // Thread-safe to close everything because we are assuming there are
  16359. // no requests in flight
  16360. shutdown_ssl(socket, true);
  16361. shutdown_socket(socket);
  16362. close_socket(socket);
  16363. success = false;
  16364. return false;
  16365. }
  16366. }
  16367. }
  16368. }
  16369. // If status code is not 200, proxy request is failed.
  16370. // Set error to ProxyConnection. A 407 is returned as the response of the
  16371. // request, so the caller sees the proxy asks for credentials; any other
  16372. // status would read as the answer of the origin, which it never reached.
  16373. if (proxy_res.status != StatusCode::OK_200) {
  16374. error = Error::ProxyConnection;
  16375. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16376. res = std::move(proxy_res);
  16377. } else {
  16378. success = false;
  16379. }
  16380. // Thread-safe to close everything because we are assuming there are
  16381. // no requests in flight
  16382. shutdown_ssl(socket, true);
  16383. shutdown_socket(socket);
  16384. close_socket(socket);
  16385. return false;
  16386. }
  16387. return true;
  16388. }
  16389. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16390. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16391. if (is_proxy_enabled_for_host(host_)) { return true; }
  16392. if (!initialize_ssl(socket, error)) {
  16393. shutdown_socket(socket);
  16394. close_socket(socket);
  16395. return false;
  16396. }
  16397. return true;
  16398. }
  16399. // SSL HTTP client implementation
  16400. inline SSLClient::SSLClient(const std::string &host)
  16401. : SSLClient(host, 443, std::string(), std::string()) {}
  16402. inline SSLClient::SSLClient(const std::string &host, int port)
  16403. : SSLClient(host, port, std::string(), std::string()) {}
  16404. inline void SSLClient::init_ctx() {
  16405. ctx_ = tls::create_client_context();
  16406. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16407. }
  16408. inline void SSLClient::reset_ctx_on_error() {
  16409. last_backend_error_ = tls::get_error();
  16410. tls::free_context(ctx_);
  16411. ctx_ = nullptr;
  16412. }
  16413. inline SSLClient::SSLClient(const std::string &host, int port,
  16414. const std::string &client_cert_path,
  16415. const std::string &client_key_path,
  16416. const std::string &private_key_password)
  16417. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16418. init_ctx();
  16419. if (!ctx_) { return; }
  16420. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16421. const char *password =
  16422. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16423. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16424. client_key_path.c_str(), password)) {
  16425. reset_ctx_on_error();
  16426. }
  16427. }
  16428. }
  16429. inline SSLClient::SSLClient(const std::string &host, int port,
  16430. const PemMemory &pem)
  16431. : ClientImpl(host, port) {
  16432. init_ctx();
  16433. if (!ctx_) { return; }
  16434. if (pem.cert_pem && pem.key_pem) {
  16435. std::string cert_buf, key_buf;
  16436. if (!tls::set_client_cert_pem(
  16437. ctx_, detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  16438. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  16439. pem.private_key_password)) {
  16440. reset_ctx_on_error();
  16441. }
  16442. }
  16443. }
  16444. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16445. if (ca_cert_store && ctx_) {
  16446. // set_ca_store takes ownership of ca_cert_store
  16447. tls::set_ca_store(ctx_, ca_cert_store);
  16448. ca_cert_store_set_ = true;
  16449. } else if (ca_cert_store) {
  16450. tls::free_ca_store(ca_cert_store);
  16451. }
  16452. custom_ca_loaded_ = true;
  16453. }
  16454. inline void
  16455. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16456. if (!ctx_) { return; }
  16457. server_certificate_verifier_ = verifier;
  16458. // Under the lock that creating a session from ctx_ takes
  16459. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16460. tls::set_verify_callback(ctx_, std::move(verifier));
  16461. }
  16462. inline void SSLClient::set_session_verifier(
  16463. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16464. session_verifier_ = std::move(verifier);
  16465. }
  16466. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16467. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16468. enable_windows_cert_verification_ = enabled;
  16469. }
  16470. #endif
  16471. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16472. std::size_t size) {
  16473. if (ctx_ && ca_cert && size > 0) {
  16474. // Every PEM loaded, for redirect transfer
  16475. if (!ca_cert_pem_.empty() && ca_cert_pem_.back() != '\n') {
  16476. ca_cert_pem_ += '\n';
  16477. }
  16478. ca_cert_pem_.append(ca_cert, size);
  16479. tls::load_ca_pem(ctx_, ca_cert, size);
  16480. }
  16481. custom_ca_loaded_ = true;
  16482. }
  16483. inline bool SSLClient::load_certs() {
  16484. auto ret = true;
  16485. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16486. // one client is shared across concurrent requests here.
  16487. std::call_once(initialize_cert_, [&]() {
  16488. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16489. ret = detail::load_client_ca_config(ctx_, ca_cert_file_path_,
  16490. ca_cert_dir_path_, custom_ca_loaded_,
  16491. system_ca_mode_, last_backend_error_);
  16492. });
  16493. return ret;
  16494. }
  16495. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16496. // Load CA certificates if server verification is enabled
  16497. if (server_certificate_verification_) {
  16498. if (!load_certs()) {
  16499. error = Error::SSLLoadingCerts;
  16500. return false;
  16501. }
  16502. }
  16503. detail::ClientTlsSessionOptions options;
  16504. options.server_hostname_verification = server_hostname_verification_;
  16505. options.session_verifier = session_verifier_;
  16506. options.ctx_mutex = &ctx_mutex_;
  16507. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16508. // Skip Schannel when a custom CA cert is specified, as the Windows
  16509. // certificate store would not know about user-provided CA certificates.
  16510. // Also skip when system CA trust is explicitly disabled.
  16511. options.windows_cert_verification =
  16512. enable_windows_cert_verification_ &&
  16513. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16514. ca_cert_dir_path_.empty() && !custom_ca_loaded_;
  16515. // Only a verifier set through set_server_certificate_verifier() is seen
  16516. // here, not one installed with tls::set_verify_callback() directly.
  16517. options.server_certificate_verifier_set =
  16518. static_cast<bool>(server_certificate_verifier_);
  16519. #endif
  16520. tls::session_t session = nullptr;
  16521. // Use scope_exit to ensure session is freed on error paths
  16522. bool success = false;
  16523. auto session_guard = detail::scope_exit([&] {
  16524. if (!success) { tls::free_session(session); }
  16525. });
  16526. detail::ClientTlsSessionError tls_error;
  16527. if (!detail::setup_client_tls_session(
  16528. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16529. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16530. options)) {
  16531. error = tls_error.error;
  16532. last_ssl_error_ = tls_error.ssl_error;
  16533. last_backend_error_ = tls_error.backend_error;
  16534. return false;
  16535. }
  16536. success = true;
  16537. socket.ssl = session;
  16538. return true;
  16539. }
  16540. inline void Client::set_digest_auth(const std::string &username,
  16541. const std::string &password) {
  16542. cli_->set_digest_auth(username, password);
  16543. }
  16544. inline void Client::set_proxy_digest_auth(const std::string &username,
  16545. const std::string &password) {
  16546. cli_->set_proxy_digest_auth(username, password);
  16547. }
  16548. inline void Client::enable_server_certificate_verification(bool enabled) {
  16549. cli_->enable_server_certificate_verification(enabled);
  16550. }
  16551. inline void Client::enable_server_hostname_verification(bool enabled) {
  16552. cli_->enable_server_hostname_verification(enabled);
  16553. }
  16554. inline void Client::enable_system_ca(bool enabled) {
  16555. cli_->enable_system_ca(enabled);
  16556. }
  16557. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16558. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16559. if (is_ssl_) {
  16560. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16561. enabled);
  16562. }
  16563. }
  16564. #endif
  16565. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16566. const std::string &ca_cert_dir_path) {
  16567. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16568. }
  16569. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16570. if (is_ssl_) {
  16571. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16572. } else if (ca_cert_store) {
  16573. tls::free_ca_store(ca_cert_store);
  16574. }
  16575. }
  16576. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16577. if (is_ssl_) {
  16578. // Use the PEM-based path so the CA data is retained for redirect transfer
  16579. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16580. }
  16581. }
  16582. inline void
  16583. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16584. if (is_ssl_) {
  16585. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16586. std::move(verifier));
  16587. }
  16588. }
  16589. inline void Client::set_session_verifier(
  16590. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16591. if (is_ssl_) {
  16592. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16593. }
  16594. }
  16595. inline tls::ctx_t Client::tls_context() const {
  16596. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16597. return nullptr;
  16598. }
  16599. #endif // CPPHTTPLIB_SSL_ENABLED
  16600. /*
  16601. * Group 7: TLS abstraction layer - Common API
  16602. */
  16603. #ifdef CPPHTTPLIB_SSL_ENABLED
  16604. namespace tls {
  16605. // Helper for PeerCert construction
  16606. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16607. return PeerCert(get_peer_cert(session));
  16608. }
  16609. namespace impl {
  16610. // set_verify_callback() can replace a callback while handshakes on other
  16611. // threads run it, so they share it, and take their reference under this lock.
  16612. inline std::mutex &verify_callback_mutex() {
  16613. static std::mutex mutex;
  16614. return mutex;
  16615. }
  16616. // The TLS libraries are C, so an exception from a verify callback must not
  16617. // unwind through them. It rejects the certificate instead.
  16618. inline bool run_verify_callback(const VerifyCallback &callback,
  16619. const VerifyContext &ctx) {
  16620. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  16621. return callback(ctx);
  16622. #else
  16623. try {
  16624. return callback(ctx);
  16625. } catch (...) { return false; }
  16626. #endif
  16627. }
  16628. // Check if a string is an IPv4 address
  16629. inline bool is_ipv4_address(const std::string &str) {
  16630. int dots = 0;
  16631. for (char c : str) {
  16632. if (c == '.') {
  16633. dots++;
  16634. } else if (!detail::is_ascii_digit(c)) {
  16635. return false;
  16636. }
  16637. }
  16638. return dots == 3;
  16639. }
  16640. // Parse IPv4 address string to bytes
  16641. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16642. const char *p = str.c_str();
  16643. for (int i = 0; i < 4; i++) {
  16644. if (i > 0) {
  16645. if (*p != '.') { return false; }
  16646. p++;
  16647. }
  16648. int val = 0;
  16649. int digits = 0;
  16650. while (detail::is_ascii_digit(*p)) {
  16651. val = val * 10 + (*p - '0');
  16652. if (val > 255) { return false; }
  16653. p++;
  16654. digits++;
  16655. }
  16656. if (digits == 0) { return false; }
  16657. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16658. if (digits > 1 && *(p - digits) == '0') { return false; }
  16659. out[i] = static_cast<unsigned char>(val);
  16660. }
  16661. return *p == '\0';
  16662. }
  16663. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16664. // `out` must have room for at least 16 bytes. Returns the address length
  16665. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16666. // literal. Used to match a host against iPAddress SANs the same way the
  16667. // OpenSSL backend does via X509_check_ip.
  16668. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16669. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16670. struct in6_addr addr6 = {};
  16671. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16672. memcpy(out, &addr6, 16);
  16673. return 16;
  16674. }
  16675. return 0;
  16676. }
  16677. #ifdef _WIN32
  16678. // Enumerate Windows system certificates and call callback with DER data
  16679. template <typename Callback>
  16680. inline bool enumerate_windows_system_certs(Callback cb) {
  16681. bool loaded = false;
  16682. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16683. for (auto store_name : store_names) {
  16684. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16685. if (hStore) {
  16686. PCCERT_CONTEXT pContext = nullptr;
  16687. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16688. nullptr) {
  16689. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16690. loaded = true;
  16691. }
  16692. }
  16693. CertCloseStore(hStore, 0);
  16694. }
  16695. }
  16696. return loaded;
  16697. }
  16698. #endif
  16699. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16700. // Enumerate macOS Keychain certificates and call callback with DER data
  16701. template <typename Callback>
  16702. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16703. bool loaded = false;
  16704. const SecTrustSettingsDomain domains[] = {
  16705. kSecTrustSettingsDomainSystem,
  16706. kSecTrustSettingsDomainAdmin,
  16707. kSecTrustSettingsDomainUser,
  16708. };
  16709. for (auto domain : domains) {
  16710. CFArrayRef certs = nullptr;
  16711. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16712. if (status != errSecSuccess || !certs) {
  16713. if (certs) CFRelease(certs);
  16714. continue;
  16715. }
  16716. CFIndex count = CFArrayGetCount(certs);
  16717. for (CFIndex i = 0; i < count; i++) {
  16718. SecCertificateRef cert =
  16719. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16720. CFDataRef data = SecCertificateCopyData(cert);
  16721. if (data) {
  16722. if (cb(CFDataGetBytePtr(data),
  16723. static_cast<size_t>(CFDataGetLength(data)))) {
  16724. loaded = true;
  16725. }
  16726. CFRelease(data);
  16727. }
  16728. }
  16729. CFRelease(certs);
  16730. }
  16731. return loaded;
  16732. }
  16733. #endif
  16734. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16735. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16736. // Common CA certificate file paths on Linux/Unix
  16737. inline const char **system_ca_paths() {
  16738. static const char *paths[] = {
  16739. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16740. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16741. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16742. "/etc/pki/tls/cacert.pem", // OpenELEC
  16743. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16744. nullptr};
  16745. return paths;
  16746. }
  16747. // Common CA certificate directory paths on Linux/Unix
  16748. inline const char **system_ca_dirs() {
  16749. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16750. "/etc/pki/tls/certs", // RHEL/CentOS
  16751. "/usr/share/ca-certificates", // Other
  16752. nullptr};
  16753. return dirs;
  16754. }
  16755. #endif
  16756. } // namespace impl
  16757. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16758. const char *ca_dir) {
  16759. if (!ctx) { return false; }
  16760. bool success = true;
  16761. if (ca_file && *ca_file) {
  16762. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16763. }
  16764. if (ca_dir && *ca_dir) {
  16765. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16766. }
  16767. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16768. // Set CA list for client certificate request (CertificateRequest message)
  16769. if (ca_file && *ca_file) {
  16770. auto list = SSL_load_client_CA_file(ca_file);
  16771. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16772. }
  16773. #endif
  16774. return success;
  16775. }
  16776. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16777. const char *password) {
  16778. return set_client_cert_pem(ctx, cert, key, password);
  16779. }
  16780. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16781. const char *key_path, const char *password) {
  16782. return set_client_cert_file(ctx, cert_path, key_path, password);
  16783. }
  16784. // PeerCert implementation
  16785. inline PeerCert::PeerCert() = default;
  16786. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16787. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16788. other.cert_ = nullptr;
  16789. }
  16790. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16791. if (this != &other) {
  16792. if (cert_) { free_cert(cert_); }
  16793. cert_ = other.cert_;
  16794. other.cert_ = nullptr;
  16795. }
  16796. return *this;
  16797. }
  16798. inline PeerCert::~PeerCert() {
  16799. if (cert_) { free_cert(cert_); }
  16800. }
  16801. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16802. inline std::string PeerCert::subject_cn() const {
  16803. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16804. }
  16805. inline std::string PeerCert::issuer_name() const {
  16806. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16807. }
  16808. inline bool PeerCert::check_hostname(const char *hostname) const {
  16809. return cert_ ? verify_hostname(cert_, hostname) : false;
  16810. }
  16811. inline std::vector<SanEntry> PeerCert::sans() const {
  16812. std::vector<SanEntry> result;
  16813. if (cert_) { get_cert_sans(cert_, result); }
  16814. return result;
  16815. }
  16816. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16817. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16818. }
  16819. inline std::string PeerCert::serial() const {
  16820. return cert_ ? get_cert_serial(cert_) : std::string();
  16821. }
  16822. // VerifyContext method implementations
  16823. inline std::string VerifyContext::subject_cn() const {
  16824. return cert ? get_cert_subject_cn(cert) : std::string();
  16825. }
  16826. inline std::string VerifyContext::issuer_name() const {
  16827. return cert ? get_cert_issuer_name(cert) : std::string();
  16828. }
  16829. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16830. return cert ? verify_hostname(cert, hostname) : false;
  16831. }
  16832. inline std::vector<SanEntry> VerifyContext::sans() const {
  16833. std::vector<SanEntry> result;
  16834. if (cert) { get_cert_sans(cert, result); }
  16835. return result;
  16836. }
  16837. inline bool VerifyContext::validity(time_t &not_before,
  16838. time_t &not_after) const {
  16839. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16840. }
  16841. inline std::string VerifyContext::serial() const {
  16842. return cert ? get_cert_serial(cert) : std::string();
  16843. }
  16844. // TlsError static method implementation
  16845. inline std::string TlsError::verify_error_to_string(long error_code) {
  16846. return verify_error_string(error_code);
  16847. }
  16848. } // namespace tls
  16849. // Request::peer_cert() implementation
  16850. inline tls::PeerCert Request::peer_cert() const {
  16851. return tls::get_peer_cert_from_session(ssl);
  16852. }
  16853. // Request::sni() implementation
  16854. inline std::string Request::sni() const {
  16855. if (!ssl) { return std::string(); }
  16856. const char *s = tls::get_sni(ssl);
  16857. return s ? std::string(s) : std::string();
  16858. }
  16859. #endif // CPPHTTPLIB_SSL_ENABLED
  16860. /*
  16861. * Group 8: TLS abstraction layer - OpenSSL backend
  16862. */
  16863. /*
  16864. * OpenSSL Backend Implementation
  16865. */
  16866. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16867. namespace tls {
  16868. namespace impl {
  16869. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16870. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16871. switch (ssl_error) {
  16872. case SSL_ERROR_NONE: return ErrorCode::Success;
  16873. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16874. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16875. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16876. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16877. case SSL_ERROR_SSL:
  16878. default: return ErrorCode::Fatal;
  16879. }
  16880. }
  16881. // Fills in a failed SSL_connect(). One that the server certificate's
  16882. // verification stopped reports the verify result, as the other backends and
  16883. // a check after the handshake do.
  16884. inline void fill_connect_error(SSL *ssl, int ret, TlsError &err) {
  16885. auto ssl_err = SSL_get_error(ssl, ret);
  16886. auto error = ERR_get_error();
  16887. err.code = map_ssl_error(ssl_err, err.sys_errno);
  16888. err.backend_code = error;
  16889. if (ssl_err != SSL_ERROR_SSL || ERR_GET_LIB(error) != ERR_LIB_SSL ||
  16890. ERR_GET_REASON(error) != SSL_R_CERTIFICATE_VERIFY_FAILED) {
  16891. return;
  16892. }
  16893. // A certificate only a verify callback turned down carries no verdict of
  16894. // its own, and fails as any other handshake does
  16895. auto verify_result = SSL_get_verify_result(ssl);
  16896. if (verify_result == X509_V_OK || verify_result == X509_V_ERR_UNSPECIFIED) {
  16897. return;
  16898. }
  16899. err.code = verify_result == X509_V_ERR_HOSTNAME_MISMATCH
  16900. ? ErrorCode::HostnameMismatch
  16901. : ErrorCode::CertVerifyFailed;
  16902. err.backend_code = static_cast<uint64_t>(verify_result);
  16903. }
  16904. // Helper: Create client CA list from PEM string
  16905. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16906. // Caller takes ownership of returned list
  16907. inline STACK_OF(X509_NAME) *
  16908. create_client_ca_list_from_pem(const char *ca_pem) {
  16909. if (!ca_pem) { return nullptr; }
  16910. auto ca_list = sk_X509_NAME_new_null();
  16911. if (!ca_list) { return nullptr; }
  16912. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16913. if (!bio) {
  16914. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16915. return nullptr;
  16916. }
  16917. X509 *cert = nullptr;
  16918. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16919. nullptr) {
  16920. const X509_NAME *name = X509_get_subject_name(cert);
  16921. if (name) {
  16922. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16923. }
  16924. X509_free(cert);
  16925. }
  16926. BIO_free(bio);
  16927. return ca_list;
  16928. }
  16929. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16930. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16931. long /*argl*/, void * /*argp*/) {
  16932. delete static_cast<std::shared_ptr<VerifyCallback> *>(ptr);
  16933. }
  16934. // The SSL_CTX owns its verify callback, so each client or server sees only
  16935. // its own, on whichever thread runs the handshake.
  16936. inline int verify_callback_index() {
  16937. static const auto index = SSL_CTX_get_ex_new_index(
  16938. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16939. return index;
  16940. }
  16941. // OpenSSL verify callback wrapper
  16942. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16943. // Get SSL object from X509_STORE_CTX
  16944. auto ssl = static_cast<SSL *>(
  16945. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16946. if (!ssl) { return preverify_ok; }
  16947. std::shared_ptr<VerifyCallback> callback;
  16948. {
  16949. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  16950. auto stored = static_cast<std::shared_ptr<VerifyCallback> *>(
  16951. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16952. if (stored) { callback = *stored; }
  16953. }
  16954. if (!callback) { return preverify_ok; }
  16955. // Get current certificate and depth
  16956. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16957. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16958. int error = X509_STORE_CTX_get_error(ctx);
  16959. // Build context
  16960. VerifyContext verify_ctx;
  16961. verify_ctx.session = static_cast<session_t>(ssl);
  16962. verify_ctx.cert = static_cast<cert_t>(cert);
  16963. verify_ctx.depth = depth;
  16964. verify_ctx.preverify_ok = (preverify_ok != 0);
  16965. verify_ctx.error_code = error;
  16966. verify_ctx.error_string =
  16967. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16968. auto accepted = run_verify_callback(*callback, verify_ctx);
  16969. // A client verifying the server during the handshake, which is what
  16970. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  16971. if (!SSL_is_server(ssl) &&
  16972. (SSL_get_verify_mode(ssl) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  16973. accepted = accepted && preverify_ok;
  16974. }
  16975. return accepted ? 1 : 0;
  16976. }
  16977. // Sets the verify mode from whether the peer's certificate is required and
  16978. // whether a verify callback is set.
  16979. inline void apply_verify_mode(SSL_CTX *ssl_ctx, bool require) {
  16980. auto has_callback =
  16981. SSL_CTX_get_ex_data(ssl_ctx, verify_callback_index()) != nullptr;
  16982. auto mode = require ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16983. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  16984. SSL_CTX_set_verify(ssl_ctx, mode,
  16985. has_callback ? openssl_verify_callback : nullptr);
  16986. }
  16987. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16988. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16989. // that must be released with release_store_objects
  16990. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16991. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16992. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16993. #endif
  16994. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16995. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16996. return X509_STORE_get1_objects(store);
  16997. #else
  16998. return X509_STORE_get0_objects(store);
  16999. #endif
  17000. }
  17001. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  17002. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  17003. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  17004. #else
  17005. (void)objs; // get0 variant returns an internal pointer; nothing to free
  17006. #endif
  17007. }
  17008. } // namespace impl
  17009. inline ctx_t create_client_context() {
  17010. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  17011. if (ctx) {
  17012. // Disable auto-retry to properly handle non-blocking I/O
  17013. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  17014. // Set minimum TLS version
  17015. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17016. }
  17017. return static_cast<ctx_t>(ctx);
  17018. }
  17019. inline void free_context(ctx_t ctx) {
  17020. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  17021. }
  17022. inline bool set_min_version(ctx_t ctx, Version version) {
  17023. if (!ctx) return false;
  17024. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  17025. static_cast<uint16_t>(version)) == 1;
  17026. }
  17027. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17028. if (!ctx || !pem || len == 0) return false;
  17029. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17030. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17031. if (!store) return false;
  17032. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  17033. if (!bio) return false;
  17034. bool ok = true;
  17035. X509 *cert = nullptr;
  17036. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  17037. nullptr) {
  17038. if (X509_STORE_add_cert(store, cert) != 1) {
  17039. // Ignore duplicate errors
  17040. auto err = ERR_peek_last_error();
  17041. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  17042. ok = false;
  17043. }
  17044. }
  17045. X509_free(cert);
  17046. if (!ok) break;
  17047. }
  17048. BIO_free(bio);
  17049. // Clear any "no more certificates" errors
  17050. ERR_clear_error();
  17051. return ok;
  17052. }
  17053. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17054. if (!ctx || !file_path) return false;
  17055. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  17056. nullptr) == 1;
  17057. }
  17058. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17059. if (!ctx || !dir_path) return false;
  17060. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  17061. dir_path) == 1;
  17062. }
  17063. inline bool load_system_certs(ctx_t ctx) {
  17064. if (!ctx) return false;
  17065. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17066. #ifdef _WIN32
  17067. // Windows: Load from system certificate store (ROOT and CA)
  17068. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17069. if (!store) return false;
  17070. bool loaded_any = false;
  17071. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  17072. for (auto store_name : store_names) {
  17073. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  17074. if (!hStore) continue;
  17075. PCCERT_CONTEXT pContext = nullptr;
  17076. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  17077. nullptr) {
  17078. const unsigned char *data = pContext->pbCertEncoded;
  17079. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  17080. if (x509) {
  17081. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17082. X509_free(x509);
  17083. }
  17084. }
  17085. CertCloseStore(hStore, 0);
  17086. }
  17087. return loaded_any;
  17088. #elif defined(__APPLE__)
  17089. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  17090. // macOS: Load from Keychain
  17091. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17092. if (!store) return false;
  17093. bool loaded_any = false;
  17094. const SecTrustSettingsDomain domains[] = {
  17095. kSecTrustSettingsDomainSystem,
  17096. kSecTrustSettingsDomainAdmin,
  17097. kSecTrustSettingsDomainUser,
  17098. };
  17099. for (auto domain : domains) {
  17100. CFArrayRef certs = nullptr;
  17101. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  17102. !certs) {
  17103. if (certs) CFRelease(certs);
  17104. continue;
  17105. }
  17106. auto count = CFArrayGetCount(certs);
  17107. for (CFIndex i = 0; i < count; i++) {
  17108. auto cert = reinterpret_cast<SecCertificateRef>(
  17109. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  17110. CFDataRef der = SecCertificateCopyData(cert);
  17111. if (der) {
  17112. const unsigned char *data = CFDataGetBytePtr(der);
  17113. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  17114. if (x509) {
  17115. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  17116. X509_free(x509);
  17117. }
  17118. CFRelease(der);
  17119. }
  17120. }
  17121. CFRelease(certs);
  17122. }
  17123. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17124. #else
  17125. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17126. #endif
  17127. #else
  17128. // Other Unix: use default verify paths
  17129. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  17130. #endif
  17131. }
  17132. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17133. const char *password) {
  17134. if (!ctx || !cert || !key) return false;
  17135. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17136. // Load certificate
  17137. auto cert_bio = BIO_new_mem_buf(cert, -1);
  17138. if (!cert_bio) return false;
  17139. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17140. BIO_free(cert_bio);
  17141. if (!x509) return false;
  17142. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  17143. X509_free(x509);
  17144. if (!cert_ok) return false;
  17145. // Load private key
  17146. auto key_bio = BIO_new_mem_buf(key, -1);
  17147. if (!key_bio) return false;
  17148. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17149. password ? const_cast<char *>(password)
  17150. : nullptr);
  17151. BIO_free(key_bio);
  17152. if (!pkey) return false;
  17153. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  17154. EVP_PKEY_free(pkey);
  17155. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  17156. }
  17157. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17158. const char *key_path, const char *password) {
  17159. if (!ctx || !cert_path || !key_path) return false;
  17160. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17161. if (password && password[0] != '\0') {
  17162. SSL_CTX_set_default_passwd_cb_userdata(
  17163. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  17164. }
  17165. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  17166. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  17167. }
  17168. inline ctx_t create_server_context() {
  17169. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  17170. if (ctx) {
  17171. // No renegotiation, as on the other backends: it would run a handshake
  17172. // that SSLServer::update_certs_pem() does not wait for
  17173. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  17174. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  17175. SSL_OP_NO_RENEGOTIATION);
  17176. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  17177. // Without one, a client resuming its session is sent a fatal alert once
  17178. // client certificates are verified.
  17179. static const unsigned char sid_ctx[] = "cpp-httplib";
  17180. SSL_CTX_set_session_id_context(ctx, sid_ctx, sizeof(sid_ctx) - 1);
  17181. }
  17182. return static_cast<ctx_t>(ctx);
  17183. }
  17184. inline void set_verify_client(ctx_t ctx, bool require) {
  17185. if (!ctx) return;
  17186. impl::apply_verify_mode(static_cast<SSL_CTX *>(ctx), require);
  17187. }
  17188. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17189. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  17190. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17191. SSL *ssl = SSL_new(ssl_ctx);
  17192. if (!ssl) return nullptr;
  17193. // Disable auto-retry for proper non-blocking I/O handling
  17194. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  17195. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  17196. if (!bio) {
  17197. SSL_free(ssl);
  17198. return nullptr;
  17199. }
  17200. SSL_set_bio(ssl, bio, bio);
  17201. return static_cast<session_t>(ssl);
  17202. }
  17203. inline void free_session(session_t session) {
  17204. if (session) { SSL_free(static_cast<SSL *>(session)); }
  17205. }
  17206. inline bool set_sni(session_t session, const char *hostname,
  17207. bool verify_hostname) {
  17208. if (!session || !hostname) return false;
  17209. auto ssl = static_cast<SSL *>(session);
  17210. // The handshake's chain verification then checks the name as well
  17211. if (verify_hostname &&
  17212. X509_VERIFY_PARAM_set1_host(SSL_get0_param(ssl), hostname,
  17213. strlen(hostname)) != 1) {
  17214. return false;
  17215. }
  17216. #if defined(OPENSSL_IS_BORINGSSL)
  17217. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  17218. #else
  17219. // Direct call instead of macro to suppress -Wold-style-cast warning
  17220. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  17221. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  17222. #endif
  17223. }
  17224. inline TlsError connect(session_t session) {
  17225. if (!session) { return TlsError(); }
  17226. auto ssl = static_cast<SSL *>(session);
  17227. auto ret = SSL_connect(ssl);
  17228. TlsError err;
  17229. if (ret == 1) {
  17230. err.code = ErrorCode::Success;
  17231. } else {
  17232. impl::fill_connect_error(ssl, ret, err);
  17233. }
  17234. return err;
  17235. }
  17236. inline TlsError accept(session_t session) {
  17237. if (!session) { return TlsError(); }
  17238. auto ssl = static_cast<SSL *>(session);
  17239. auto ret = SSL_accept(ssl);
  17240. TlsError err;
  17241. if (ret == 1) {
  17242. err.code = ErrorCode::Success;
  17243. } else {
  17244. auto ssl_err = SSL_get_error(ssl, ret);
  17245. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17246. err.backend_code = ERR_get_error();
  17247. }
  17248. return err;
  17249. }
  17250. inline bool connect_nonblocking(session_t session, socket_t sock,
  17251. time_t timeout_sec, time_t timeout_usec,
  17252. TlsError *err) {
  17253. if (!session) {
  17254. if (err) { err->code = ErrorCode::Fatal; }
  17255. return false;
  17256. }
  17257. auto ssl = static_cast<SSL *>(session);
  17258. auto bio = SSL_get_rbio(ssl);
  17259. // Set non-blocking mode for handshake
  17260. detail::set_nonblocking(sock, true);
  17261. if (bio) { BIO_set_nbio(bio, 1); }
  17262. auto cleanup = detail::scope_exit([&]() {
  17263. // Restore blocking mode after handshake
  17264. if (bio) { BIO_set_nbio(bio, 0); }
  17265. detail::set_nonblocking(sock, false);
  17266. });
  17267. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17268. auto res = 0;
  17269. while ((res = SSL_connect(ssl)) != 1) {
  17270. auto ssl_err = SSL_get_error(ssl, res);
  17271. switch (ssl_err) {
  17272. case SSL_ERROR_WANT_READ:
  17273. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17274. break;
  17275. case SSL_ERROR_WANT_WRITE:
  17276. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17277. break;
  17278. default: break;
  17279. }
  17280. if (err) { impl::fill_connect_error(ssl, res, *err); }
  17281. return false;
  17282. }
  17283. if (err) { err->code = ErrorCode::Success; }
  17284. return true;
  17285. }
  17286. inline bool accept_nonblocking(session_t session, socket_t sock,
  17287. time_t timeout_sec, time_t timeout_usec,
  17288. TlsError *err) {
  17289. if (!session) {
  17290. if (err) { err->code = ErrorCode::Fatal; }
  17291. return false;
  17292. }
  17293. auto ssl = static_cast<SSL *>(session);
  17294. auto bio = SSL_get_rbio(ssl);
  17295. // Set non-blocking mode for handshake
  17296. detail::set_nonblocking(sock, true);
  17297. if (bio) { BIO_set_nbio(bio, 1); }
  17298. auto cleanup = detail::scope_exit([&]() {
  17299. // Restore blocking mode after handshake
  17300. if (bio) { BIO_set_nbio(bio, 0); }
  17301. detail::set_nonblocking(sock, false);
  17302. });
  17303. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17304. auto res = 0;
  17305. while ((res = SSL_accept(ssl)) != 1) {
  17306. auto ssl_err = SSL_get_error(ssl, res);
  17307. switch (ssl_err) {
  17308. case SSL_ERROR_WANT_READ:
  17309. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17310. break;
  17311. case SSL_ERROR_WANT_WRITE:
  17312. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17313. break;
  17314. default: break;
  17315. }
  17316. if (err) {
  17317. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17318. err->backend_code = ERR_get_error();
  17319. }
  17320. return false;
  17321. }
  17322. if (err) { err->code = ErrorCode::Success; }
  17323. return true;
  17324. }
  17325. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17326. if (!session || !buf) {
  17327. err.code = ErrorCode::Fatal;
  17328. return -1;
  17329. }
  17330. auto ssl = static_cast<SSL *>(session);
  17331. constexpr auto max_len =
  17332. static_cast<size_t>((std::numeric_limits<int>::max)());
  17333. if (len > max_len) { len = max_len; }
  17334. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17335. if (ret > 0) {
  17336. err.code = ErrorCode::Success;
  17337. return ret;
  17338. }
  17339. auto ssl_err = SSL_get_error(ssl, ret);
  17340. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17341. if (err.code == ErrorCode::PeerClosed) {
  17342. return 0;
  17343. } // Gracefully handle the peer closed state.
  17344. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17345. return -1;
  17346. }
  17347. inline ssize_t write(session_t session, const void *buf, size_t len,
  17348. TlsError &err) {
  17349. if (!session || !buf) {
  17350. err.code = ErrorCode::Fatal;
  17351. return -1;
  17352. }
  17353. auto ssl = static_cast<SSL *>(session);
  17354. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17355. if (ret > 0) {
  17356. err.code = ErrorCode::Success;
  17357. return ret;
  17358. }
  17359. auto ssl_err = SSL_get_error(ssl, ret);
  17360. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17361. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17362. return -1;
  17363. }
  17364. inline int pending(const_session_t session) {
  17365. if (!session) return 0;
  17366. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17367. }
  17368. inline void shutdown(session_t session, bool graceful) {
  17369. if (!session) return;
  17370. auto ssl = static_cast<SSL *>(session);
  17371. if (graceful) {
  17372. // Send close_notify without waiting for the peer's. The connection is
  17373. // closed right after this, so a unidirectional shutdown is enough, and an
  17374. // idle peer that never answers would otherwise hold this thread until the
  17375. // read timeout. The other backends do not wait either.
  17376. SSL_shutdown(ssl);
  17377. }
  17378. }
  17379. inline bool is_peer_closed(session_t session, socket_t sock) {
  17380. if (!session) return true;
  17381. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17382. detail::set_nonblocking(sock, true);
  17383. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17384. auto ssl = static_cast<SSL *>(session);
  17385. char buf;
  17386. auto ret = SSL_peek(ssl, &buf, 1);
  17387. if (ret > 0) return false;
  17388. auto err = SSL_get_error(ssl, ret);
  17389. return err == SSL_ERROR_ZERO_RETURN;
  17390. }
  17391. inline cert_t get_peer_cert(const_session_t session) {
  17392. if (!session) return nullptr;
  17393. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17394. static_cast<SSL *>(const_cast<void *>(session))));
  17395. }
  17396. inline size_t get_peer_certs(const_session_t session,
  17397. std::vector<cert_t> &certs) {
  17398. certs.clear();
  17399. if (!session) { return 0; }
  17400. auto ssl = static_cast<const SSL *>(session);
  17401. // On the server side, the chain leaves out the peer's own certificate
  17402. if (SSL_is_server(ssl)) {
  17403. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17404. }
  17405. if (auto sk = SSL_get_peer_cert_chain(ssl)) {
  17406. auto count = sk_X509_num(sk);
  17407. for (decltype(count) i = 0; i < count; i++) {
  17408. auto x509 = sk_X509_value(sk, i);
  17409. X509_up_ref(x509);
  17410. certs.push_back(static_cast<cert_t>(x509));
  17411. }
  17412. }
  17413. return certs.size();
  17414. }
  17415. inline void free_cert(cert_t cert) {
  17416. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17417. }
  17418. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17419. if (!cert || !hostname) return false;
  17420. auto x509 = static_cast<X509 *>(cert);
  17421. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17422. if (detail::is_ip_address(hostname)) {
  17423. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17424. }
  17425. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17426. }
  17427. inline uint64_t hostname_mismatch_code() {
  17428. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17429. }
  17430. inline long get_verify_result(const_session_t session) {
  17431. if (!session) return X509_V_ERR_UNSPECIFIED;
  17432. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17433. }
  17434. inline std::string get_cert_subject_cn(cert_t cert) {
  17435. if (!cert) return "";
  17436. auto x509 = static_cast<X509 *>(cert);
  17437. auto subject_name = X509_get_subject_name(x509);
  17438. if (!subject_name) return "";
  17439. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17440. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17441. if (idx < 0) return "";
  17442. auto entry = X509_NAME_get_entry(subject_name, idx);
  17443. if (!entry) return "";
  17444. auto data = X509_NAME_ENTRY_get_data(entry);
  17445. if (!data) return "";
  17446. return std::string(
  17447. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17448. static_cast<size_t>(ASN1_STRING_length(data)));
  17449. }
  17450. inline std::string get_cert_issuer_name(cert_t cert) {
  17451. if (!cert) return "";
  17452. auto x509 = static_cast<X509 *>(cert);
  17453. auto issuer_name = X509_get_issuer_name(x509);
  17454. if (!issuer_name) return "";
  17455. char buf[256];
  17456. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17457. return std::string(buf);
  17458. }
  17459. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17460. sans.clear();
  17461. if (!cert) return false;
  17462. auto x509 = static_cast<X509 *>(cert);
  17463. auto names = static_cast<GENERAL_NAMES *>(
  17464. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17465. if (!names) return true; // No SANs is valid
  17466. auto count = sk_GENERAL_NAME_num(names);
  17467. for (decltype(count) i = 0; i < count; i++) {
  17468. auto gen = sk_GENERAL_NAME_value(names, i);
  17469. if (!gen) continue;
  17470. SanEntry entry;
  17471. switch (gen->type) {
  17472. case GEN_DNS:
  17473. entry.type = SanType::DNS;
  17474. if (gen->d.dNSName) {
  17475. entry.value = std::string(
  17476. reinterpret_cast<const char *>(
  17477. ASN1_STRING_get0_data(gen->d.dNSName)),
  17478. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17479. }
  17480. break;
  17481. case GEN_IPADD:
  17482. entry.type = SanType::IP;
  17483. if (gen->d.iPAddress) {
  17484. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17485. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17486. if (len == 4) {
  17487. // IPv4
  17488. char buf[INET_ADDRSTRLEN];
  17489. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17490. entry.value = buf;
  17491. } else if (len == 16) {
  17492. // IPv6
  17493. char buf[INET6_ADDRSTRLEN];
  17494. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17495. entry.value = buf;
  17496. }
  17497. }
  17498. break;
  17499. case GEN_EMAIL:
  17500. entry.type = SanType::EMAIL;
  17501. if (gen->d.rfc822Name) {
  17502. entry.value = std::string(
  17503. reinterpret_cast<const char *>(
  17504. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17505. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17506. }
  17507. break;
  17508. case GEN_URI:
  17509. entry.type = SanType::URI;
  17510. if (gen->d.uniformResourceIdentifier) {
  17511. entry.value = std::string(
  17512. reinterpret_cast<const char *>(
  17513. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17514. static_cast<size_t>(
  17515. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17516. }
  17517. break;
  17518. default: entry.type = SanType::OTHER; break;
  17519. }
  17520. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17521. }
  17522. GENERAL_NAMES_free(names);
  17523. return true;
  17524. }
  17525. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17526. time_t &not_after) {
  17527. if (!cert) return false;
  17528. auto x509 = static_cast<X509 *>(cert);
  17529. auto nb = X509_get0_notBefore(x509);
  17530. auto na = X509_get0_notAfter(x509);
  17531. if (!nb || !na) return false;
  17532. ASN1_TIME *epoch = ASN1_TIME_new();
  17533. if (!epoch) return false;
  17534. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17535. if (!ASN1_TIME_set(epoch, 0)) return false;
  17536. int pday, psec;
  17537. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17538. not_before = 86400 * (time_t)pday + psec;
  17539. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17540. not_after = 86400 * (time_t)pday + psec;
  17541. return true;
  17542. }
  17543. inline std::string get_cert_serial(cert_t cert) {
  17544. if (!cert) return "";
  17545. auto x509 = static_cast<X509 *>(cert);
  17546. auto serial = X509_get_serialNumber(x509);
  17547. if (!serial) return "";
  17548. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17549. if (!bn) return "";
  17550. auto hex = BN_bn2hex(bn);
  17551. BN_free(bn);
  17552. if (!hex) return "";
  17553. std::string result(hex);
  17554. OPENSSL_free(hex);
  17555. return result;
  17556. }
  17557. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17558. if (!cert) return false;
  17559. auto x509 = static_cast<X509 *>(cert);
  17560. auto len = i2d_X509(x509, nullptr);
  17561. if (len < 0) return false;
  17562. der.resize(static_cast<size_t>(len));
  17563. auto p = der.data();
  17564. i2d_X509(x509, &p);
  17565. return true;
  17566. }
  17567. inline const char *get_sni(const_session_t session) {
  17568. if (!session) return nullptr;
  17569. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17570. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17571. }
  17572. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17573. inline uint64_t get_error() { return ERR_get_error(); }
  17574. inline std::string error_string(uint64_t code) {
  17575. char buf[256];
  17576. ERR_error_string_n(static_cast<decltype(ERR_get_error())>(code), buf,
  17577. sizeof(buf));
  17578. return std::string(buf);
  17579. }
  17580. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17581. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17582. if (!mem) { return nullptr; }
  17583. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17584. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17585. if (!inf) { return nullptr; }
  17586. auto store = X509_STORE_new();
  17587. if (store) {
  17588. auto count = sk_X509_INFO_num(inf);
  17589. for (decltype(count) i = 0; i < count; i++) {
  17590. auto itmp = sk_X509_INFO_value(inf, i);
  17591. if (!itmp) { continue; }
  17592. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17593. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17594. }
  17595. }
  17596. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17597. return static_cast<ca_store_t>(store);
  17598. }
  17599. inline void free_ca_store(ca_store_t store) {
  17600. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17601. }
  17602. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17603. if (!ctx || !store) { return false; }
  17604. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17605. auto x509_store = static_cast<X509_STORE *>(store);
  17606. // Check if same store is already set
  17607. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17608. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17609. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17610. return true;
  17611. }
  17612. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17613. certs.clear();
  17614. if (!ctx) { return 0; }
  17615. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17616. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17617. if (!store) { return 0; }
  17618. auto objs = impl::get_store_objects(store);
  17619. if (!objs) { return 0; }
  17620. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17621. auto count = sk_X509_OBJECT_num(objs);
  17622. for (decltype(count) i = 0; i < count; i++) {
  17623. auto obj = sk_X509_OBJECT_value(objs, i);
  17624. if (!obj) { continue; }
  17625. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17626. auto x509 = X509_OBJECT_get0_X509(obj);
  17627. if (x509) {
  17628. // Increment reference count so caller can free it
  17629. X509_up_ref(x509);
  17630. certs.push_back(static_cast<cert_t>(x509));
  17631. }
  17632. }
  17633. }
  17634. return certs.size();
  17635. }
  17636. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17637. std::vector<std::string> names;
  17638. if (!ctx) { return names; }
  17639. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17640. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17641. if (!store) { return names; }
  17642. auto objs = impl::get_store_objects(store);
  17643. if (!objs) { return names; }
  17644. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17645. auto count = sk_X509_OBJECT_num(objs);
  17646. for (decltype(count) i = 0; i < count; i++) {
  17647. auto obj = sk_X509_OBJECT_value(objs, i);
  17648. if (!obj) { continue; }
  17649. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17650. auto x509 = X509_OBJECT_get0_X509(obj);
  17651. if (x509) {
  17652. auto subject = X509_get_subject_name(x509);
  17653. if (subject) {
  17654. char buf[512];
  17655. X509_NAME_oneline(subject, buf, sizeof(buf));
  17656. names.push_back(buf);
  17657. }
  17658. }
  17659. }
  17660. }
  17661. return names;
  17662. }
  17663. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17664. const char *key_pem, const char *password) {
  17665. if (!ctx || !cert_pem || !key_pem) { return false; }
  17666. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17667. // Load certificate from PEM
  17668. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17669. if (!cert_bio) { return false; }
  17670. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17671. BIO_free(cert_bio);
  17672. if (!cert) { return false; }
  17673. // Load private key from PEM
  17674. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17675. if (!key_bio) {
  17676. X509_free(cert);
  17677. return false;
  17678. }
  17679. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17680. password ? const_cast<char *>(password)
  17681. : nullptr);
  17682. BIO_free(key_bio);
  17683. if (!key) {
  17684. X509_free(cert);
  17685. return false;
  17686. }
  17687. // Update certificate and key
  17688. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17689. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17690. X509_free(cert);
  17691. EVP_PKEY_free(key);
  17692. return ret;
  17693. }
  17694. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17695. if (!ctx || !ca_pem) { return false; }
  17696. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17697. // Create new X509_STORE from PEM
  17698. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17699. if (!store) { return false; }
  17700. // A resumed session is not verified again, so the ticket keys from before
  17701. // go, or a client verified under the old CAs could go on resuming.
  17702. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  17703. unsigned char ticket_keys[48];
  17704. #else
  17705. unsigned char ticket_keys[80];
  17706. #endif
  17707. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) != 1 ||
  17708. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys,
  17709. sizeof(ticket_keys)) != 1) {
  17710. free_ca_store(store);
  17711. return false;
  17712. }
  17713. // SSL_CTX_set_cert_store takes ownership
  17714. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17715. // Set client CA list for client certificate request
  17716. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17717. if (ca_list) {
  17718. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17719. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17720. }
  17721. // The cached sessions go for the same reason.
  17722. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17723. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17724. #else
  17725. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17726. #endif
  17727. return true;
  17728. }
  17729. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17730. if (!ctx) { return false; }
  17731. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17732. auto index = impl::verify_callback_index();
  17733. if (index < 0) { return false; }
  17734. std::shared_ptr<VerifyCallback> *stored = nullptr;
  17735. if (callback) {
  17736. stored = new std::shared_ptr<VerifyCallback>(
  17737. std::make_shared<VerifyCallback>(std::move(callback)));
  17738. }
  17739. std::shared_ptr<VerifyCallback> *previous = nullptr;
  17740. {
  17741. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  17742. previous = static_cast<std::shared_ptr<VerifyCallback> *>(
  17743. SSL_CTX_get_ex_data(ssl_ctx, index));
  17744. if (SSL_CTX_set_ex_data(ssl_ctx, index, stored) != 1) {
  17745. delete stored;
  17746. return false;
  17747. }
  17748. }
  17749. // A handshake running the previous callback keeps it until it returns.
  17750. delete previous;
  17751. // A resumed handshake shows no certificate to run the callback on.
  17752. if (stored) {
  17753. SSL_CTX_set_options(ssl_ctx, SSL_OP_NO_TICKET);
  17754. SSL_CTX_set_session_cache_mode(ssl_ctx, SSL_SESS_CACHE_OFF);
  17755. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER)
  17756. // TLS 1.3 tickets, which SSL_OP_NO_TICKET leaves on
  17757. SSL_CTX_set_num_tickets(ssl_ctx, 0);
  17758. #endif
  17759. }
  17760. // Keep requiring the peer's certificate if set_verify_client() asked for it
  17761. auto require =
  17762. (SSL_CTX_get_verify_mode(ssl_ctx) & SSL_VERIFY_FAIL_IF_NO_PEER_CERT) != 0;
  17763. impl::apply_verify_mode(ssl_ctx, require);
  17764. return true;
  17765. }
  17766. inline long get_verify_error(const_session_t session) {
  17767. if (!session) { return -1; }
  17768. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17769. return SSL_get_verify_result(ssl);
  17770. }
  17771. inline std::string verify_error_string(long error_code) {
  17772. if (error_code == X509_V_OK) { return ""; }
  17773. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17774. return str ? str : "unknown error";
  17775. }
  17776. } // namespace tls
  17777. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17778. /*
  17779. * Group 9: TLS abstraction layer - Mbed TLS backend
  17780. */
  17781. /*
  17782. * Mbed TLS Backend Implementation
  17783. */
  17784. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17785. namespace tls {
  17786. namespace impl {
  17787. // Mbed TLS session wrapper
  17788. struct MbedTlsSession {
  17789. mbedtls_ssl_context ssl;
  17790. socket_t sock = INVALID_SOCKET;
  17791. std::string hostname; // For client: set via set_sni
  17792. std::string sni_hostname; // For server: received from client via SNI callback
  17793. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17794. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17795. // (e.g. a response that arrived while this side was still in its post-write
  17796. // check), the byte is pushed back here and served by the next read().
  17797. unsigned char peeked_byte = 0;
  17798. bool has_peeked_byte = false;
  17799. // Set by set_sni() when the caller disabled hostname verification, so the
  17800. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17801. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17802. // OpenSSL and wolfSSL keep them independent).
  17803. bool suppress_hostname_mismatch = false;
  17804. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17805. // ever runs the callback of its own context.
  17806. VerifyCallback verify_callback;
  17807. bool is_server = false;
  17808. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17809. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17810. MbedTlsSession(const MbedTlsSession &) = delete;
  17811. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17812. };
  17813. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17814. // queue)
  17815. inline int &mbedtls_last_error() {
  17816. static thread_local int err = 0;
  17817. return err;
  17818. }
  17819. // Helper to map Mbed TLS error to ErrorCode
  17820. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17821. uint32_t verify_flags) {
  17822. if (ret == 0) { return ErrorCode::Success; }
  17823. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17824. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17825. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17826. return ErrorCode::PeerClosed;
  17827. }
  17828. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17829. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17830. out_errno = errno;
  17831. return ErrorCode::SyscallError;
  17832. }
  17833. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17834. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17835. // the handshake's chain verification (see set_sni()); a mismatch there
  17836. // is reported the same way as any other verify_flags bit. Report it as
  17837. // HostnameMismatch, matching the other backends and the post-handshake
  17838. // identity check below, but only when naming is the sole problem -
  17839. // if the chain itself is also untrusted/expired/etc., that takes
  17840. // priority over the naming detail.
  17841. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17842. return ErrorCode::HostnameMismatch;
  17843. }
  17844. return ErrorCode::CertVerifyFailed;
  17845. }
  17846. return ErrorCode::Fatal;
  17847. }
  17848. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17849. // return value, including the verify-flags-dependent HostnameMismatch
  17850. // mapping; shared by connect() and connect_nonblocking() so the
  17851. // backend_code policy for that mapping only lives in one place.
  17852. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17853. int ret) {
  17854. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17855. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17856. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17857. ? static_cast<uint64_t>(verify_flags)
  17858. : static_cast<uint64_t>(-ret);
  17859. }
  17860. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17861. // non-fatal notification delivered between records, not an error and not
  17862. // application data, so I/O calls that see it should just be retried. Kept in
  17863. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17864. // splitting the closing brace across an #if.
  17865. inline bool mbedtls_is_session_ticket(int ret) {
  17866. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17867. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17868. #else
  17869. (void)ret;
  17870. return false;
  17871. #endif
  17872. }
  17873. // BIO-like send callback for Mbed TLS
  17874. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17875. size_t len) {
  17876. auto sock = *static_cast<socket_t *>(ctx);
  17877. #ifdef _WIN32
  17878. auto ret =
  17879. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17880. if (ret == SOCKET_ERROR) {
  17881. int err = WSAGetLastError();
  17882. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17883. return MBEDTLS_ERR_NET_SEND_FAILED;
  17884. }
  17885. #else
  17886. auto ret = send(sock, buf, len, 0);
  17887. if (ret < 0) {
  17888. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17889. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17890. }
  17891. return MBEDTLS_ERR_NET_SEND_FAILED;
  17892. }
  17893. #endif
  17894. return static_cast<int>(ret);
  17895. }
  17896. // BIO-like recv callback for Mbed TLS
  17897. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17898. auto sock = *static_cast<socket_t *>(ctx);
  17899. #ifdef _WIN32
  17900. auto ret =
  17901. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17902. if (ret == SOCKET_ERROR) {
  17903. int err = WSAGetLastError();
  17904. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17905. return MBEDTLS_ERR_NET_RECV_FAILED;
  17906. }
  17907. #else
  17908. auto ret = recv(sock, buf, len, 0);
  17909. if (ret < 0) {
  17910. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17911. return MBEDTLS_ERR_SSL_WANT_READ;
  17912. }
  17913. return MBEDTLS_ERR_NET_RECV_FAILED;
  17914. }
  17915. #endif
  17916. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17917. return static_cast<int>(ret);
  17918. }
  17919. // MbedTlsContext constructor/destructor implementations
  17920. inline MbedTlsContext::MbedTlsContext() {
  17921. mbedtls_ssl_config_init(&conf);
  17922. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17923. mbedtls_entropy_init(&entropy);
  17924. mbedtls_ctr_drbg_init(&ctr_drbg);
  17925. #endif
  17926. mbedtls_x509_crt_init(&ca_chain);
  17927. mbedtls_x509_crt_init(&own_cert);
  17928. mbedtls_pk_init(&own_key);
  17929. }
  17930. inline MbedTlsContext::~MbedTlsContext() {
  17931. mbedtls_pk_free(&own_key);
  17932. mbedtls_x509_crt_free(&own_cert);
  17933. mbedtls_x509_crt_free(&ca_chain);
  17934. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17935. mbedtls_ctr_drbg_free(&ctr_drbg);
  17936. mbedtls_entropy_free(&entropy);
  17937. #endif
  17938. mbedtls_ssl_config_free(&conf);
  17939. }
  17940. // Thread-local storage for SNI captured during handshake
  17941. // This is needed because the SNI callback doesn't have a way to pass
  17942. // session-specific data before the session is fully set up
  17943. inline std::string &mbedpending_sni() {
  17944. static thread_local std::string sni;
  17945. return sni;
  17946. }
  17947. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17948. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17949. const unsigned char *name, size_t name_len) {
  17950. (void)p_ctx;
  17951. (void)ssl;
  17952. // Store SNI name in thread-local storage
  17953. // It will be retrieved and stored in the session after handshake
  17954. if (name && name_len > 0) {
  17955. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17956. } else {
  17957. mbedpending_sni().clear();
  17958. }
  17959. return 0; // Accept any SNI
  17960. }
  17961. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17962. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17963. }
  17964. // MbedTLS verify callback wrapper
  17965. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17966. int cert_depth, uint32_t *flags) {
  17967. // data points to the MbedTlsSession
  17968. auto *session = static_cast<MbedTlsSession *>(data);
  17969. // set_sni() disabled hostname verification for this session: ignore the
  17970. // CN/SAN mismatch flag, as the OpenSSL/wolfSSL backends do. The final
  17971. // pass/fail decision still comes from the remaining flags (and, below, from
  17972. // the user's own verify callback).
  17973. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17974. const auto &callback = session->verify_callback;
  17975. if (!callback) { return 0; } // Continue with default verification
  17976. // Build context
  17977. VerifyContext verify_ctx;
  17978. verify_ctx.session = static_cast<session_t>(session);
  17979. verify_ctx.cert = static_cast<cert_t>(crt);
  17980. verify_ctx.depth = cert_depth;
  17981. verify_ctx.preverify_ok = (*flags == 0);
  17982. verify_ctx.error_code = static_cast<long>(*flags);
  17983. // Convert Mbed TLS flags to error string
  17984. static thread_local char error_buf[256];
  17985. if (*flags != 0) {
  17986. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17987. verify_ctx.error_string = error_buf;
  17988. } else {
  17989. verify_ctx.error_string = nullptr;
  17990. }
  17991. bool accepted = run_verify_callback(callback, verify_ctx);
  17992. if (accepted) {
  17993. // Overrides the built-in verification only on a server, as on OpenSSL and
  17994. // wolfSSL, whose clients check the verify result after the handshake
  17995. if (session->is_server) { *flags = 0; }
  17996. return 0;
  17997. }
  17998. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17999. }
  18000. // Sets the authentication mode from whether the peer's certificate is required
  18001. // and whether a verify callback is set. OPTIONAL lets the callback run even if
  18002. // verification is not required (matching OpenSSL's SSL_VERIFY_PEER).
  18003. inline void apply_verify_mode(MbedTlsContext &mctx) {
  18004. auto mode = MBEDTLS_SSL_VERIFY_NONE;
  18005. if (mctx.verify_client) {
  18006. mode = MBEDTLS_SSL_VERIFY_REQUIRED;
  18007. } else if (mctx.verify_callback) {
  18008. mode = MBEDTLS_SSL_VERIFY_OPTIONAL;
  18009. }
  18010. mbedtls_ssl_conf_authmode(&mctx.conf, mode);
  18011. }
  18012. } // namespace impl
  18013. inline ctx_t create_client_context() {
  18014. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18015. if (!ctx) { return nullptr; }
  18016. ctx->is_server = false;
  18017. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18018. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18019. if (!detail::ensure_mbedtls_psa_crypto()) {
  18020. delete ctx;
  18021. return nullptr;
  18022. }
  18023. int ret;
  18024. #else
  18025. // Seed the random number generator
  18026. const char *pers = "httplib_client";
  18027. int ret = mbedtls_ctr_drbg_seed(
  18028. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18029. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18030. if (ret != 0) {
  18031. impl::mbedtls_last_error() = ret;
  18032. delete ctx;
  18033. return nullptr;
  18034. }
  18035. #endif
  18036. // Set up SSL config for client
  18037. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  18038. MBEDTLS_SSL_TRANSPORT_STREAM,
  18039. MBEDTLS_SSL_PRESET_DEFAULT);
  18040. if (ret != 0) {
  18041. impl::mbedtls_last_error() = ret;
  18042. delete ctx;
  18043. return nullptr;
  18044. }
  18045. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18046. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18047. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18048. #endif
  18049. // Default: verify peer certificate
  18050. ctx->verify_client = true;
  18051. impl::apply_verify_mode(*ctx);
  18052. // Set minimum TLS version to 1.2
  18053. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18054. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18055. #else
  18056. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18057. MBEDTLS_SSL_MINOR_VERSION_3);
  18058. #endif
  18059. return static_cast<ctx_t>(ctx);
  18060. }
  18061. inline ctx_t create_server_context() {
  18062. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  18063. if (!ctx) { return nullptr; }
  18064. ctx->is_server = true;
  18065. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18066. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  18067. if (!detail::ensure_mbedtls_psa_crypto()) {
  18068. delete ctx;
  18069. return nullptr;
  18070. }
  18071. int ret;
  18072. #else
  18073. // Seed the random number generator
  18074. const char *pers = "httplib_server";
  18075. int ret = mbedtls_ctr_drbg_seed(
  18076. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  18077. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  18078. if (ret != 0) {
  18079. impl::mbedtls_last_error() = ret;
  18080. delete ctx;
  18081. return nullptr;
  18082. }
  18083. #endif
  18084. // Set up SSL config for server
  18085. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  18086. MBEDTLS_SSL_TRANSPORT_STREAM,
  18087. MBEDTLS_SSL_PRESET_DEFAULT);
  18088. if (ret != 0) {
  18089. impl::mbedtls_last_error() = ret;
  18090. delete ctx;
  18091. return nullptr;
  18092. }
  18093. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18094. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  18095. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  18096. #endif
  18097. // Default: don't verify client
  18098. impl::apply_verify_mode(*ctx);
  18099. // Set minimum TLS version to 1.2
  18100. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18101. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  18102. #else
  18103. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  18104. MBEDTLS_SSL_MINOR_VERSION_3);
  18105. #endif
  18106. // Set SNI callback to capture client's SNI hostname
  18107. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  18108. return static_cast<ctx_t>(ctx);
  18109. }
  18110. inline void free_context(ctx_t ctx) {
  18111. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  18112. }
  18113. inline bool set_min_version(ctx_t ctx, Version version) {
  18114. if (!ctx) { return false; }
  18115. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18116. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18117. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  18118. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  18119. if (version >= Version::TLS1_3) {
  18120. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18121. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  18122. #endif
  18123. }
  18124. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  18125. #else
  18126. // Mbed TLS 2.x uses major/minor version numbers
  18127. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  18128. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  18129. if (version >= Version::TLS1_3) {
  18130. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  18131. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  18132. #else
  18133. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  18134. #endif
  18135. }
  18136. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  18137. #endif
  18138. return true;
  18139. }
  18140. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18141. if (!ctx || !pem) { return false; }
  18142. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18143. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  18144. // Add null terminator if not present
  18145. std::string pem_str(pem, len);
  18146. int ret = mbedtls_x509_crt_parse(
  18147. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  18148. pem_str.size() + 1);
  18149. if (ret != 0) {
  18150. impl::mbedtls_last_error() = ret;
  18151. return false;
  18152. }
  18153. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18154. return true;
  18155. }
  18156. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18157. if (!ctx || !file_path) { return false; }
  18158. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18159. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  18160. if (ret != 0) {
  18161. impl::mbedtls_last_error() = ret;
  18162. return false;
  18163. }
  18164. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18165. return true;
  18166. }
  18167. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18168. if (!ctx || !dir_path) { return false; }
  18169. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18170. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  18171. if (ret < 0) { // Returns number of certs on success, negative on error
  18172. impl::mbedtls_last_error() = ret;
  18173. return false;
  18174. }
  18175. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18176. return true;
  18177. }
  18178. inline bool load_system_certs(ctx_t ctx) {
  18179. if (!ctx) { return false; }
  18180. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18181. bool loaded = false;
  18182. #ifdef _WIN32
  18183. loaded = impl::enumerate_windows_system_certs(
  18184. [&](const unsigned char *data, size_t len) {
  18185. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18186. });
  18187. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18188. loaded = impl::enumerate_macos_keychain_certs(
  18189. [&](const unsigned char *data, size_t len) {
  18190. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  18191. });
  18192. #else
  18193. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18194. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  18195. loaded = true;
  18196. break;
  18197. }
  18198. }
  18199. if (!loaded) {
  18200. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18201. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  18202. loaded = true;
  18203. break;
  18204. }
  18205. }
  18206. }
  18207. #endif
  18208. if (loaded) {
  18209. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  18210. }
  18211. return loaded;
  18212. }
  18213. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18214. const char *password) {
  18215. if (!ctx || !cert || !key) { return false; }
  18216. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18217. // Parse certificate
  18218. std::string cert_str(cert);
  18219. int ret = mbedtls_x509_crt_parse(
  18220. &mctx->own_cert,
  18221. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  18222. cert_str.size() + 1);
  18223. if (ret != 0) {
  18224. impl::mbedtls_last_error() = ret;
  18225. return false;
  18226. }
  18227. // Parse private key
  18228. std::string key_str(key);
  18229. const unsigned char *pwd =
  18230. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  18231. size_t pwd_len = password ? strlen(password) : 0;
  18232. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18233. ret = mbedtls_pk_parse_key(
  18234. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18235. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  18236. &mctx->ctr_drbg);
  18237. #else
  18238. ret = mbedtls_pk_parse_key(
  18239. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  18240. key_str.size() + 1, pwd, pwd_len);
  18241. #endif
  18242. if (ret != 0) {
  18243. impl::mbedtls_last_error() = ret;
  18244. return false;
  18245. }
  18246. // Verify that the certificate and private key match.
  18247. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  18248. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  18249. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18250. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18251. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18252. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18253. #else
  18254. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18255. #endif
  18256. if (ret != 0) {
  18257. impl::mbedtls_last_error() = ret;
  18258. return false;
  18259. }
  18260. #endif
  18261. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18262. if (ret != 0) {
  18263. impl::mbedtls_last_error() = ret;
  18264. return false;
  18265. }
  18266. return true;
  18267. }
  18268. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18269. const char *key_path, const char *password) {
  18270. if (!ctx || !cert_path || !key_path) { return false; }
  18271. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18272. // Parse certificate file
  18273. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  18274. if (ret != 0) {
  18275. impl::mbedtls_last_error() = ret;
  18276. return false;
  18277. }
  18278. // Parse private key file
  18279. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18280. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  18281. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18282. #else
  18283. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  18284. #endif
  18285. if (ret != 0) {
  18286. impl::mbedtls_last_error() = ret;
  18287. return false;
  18288. }
  18289. // Verify that the certificate and private key match.
  18290. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  18291. #ifndef CPPHTTPLIB_MBEDTLS_V4
  18292. #ifdef CPPHTTPLIB_MBEDTLS_V3
  18293. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  18294. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  18295. #else
  18296. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  18297. #endif
  18298. if (ret != 0) {
  18299. impl::mbedtls_last_error() = ret;
  18300. return false;
  18301. }
  18302. #endif
  18303. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  18304. if (ret != 0) {
  18305. impl::mbedtls_last_error() = ret;
  18306. return false;
  18307. }
  18308. return true;
  18309. }
  18310. inline void set_verify_client(ctx_t ctx, bool require) {
  18311. if (!ctx) { return; }
  18312. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18313. mctx->verify_client = require;
  18314. impl::apply_verify_mode(*mctx);
  18315. }
  18316. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18317. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18318. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18319. auto session = new (std::nothrow) impl::MbedTlsSession();
  18320. if (!session) { return nullptr; }
  18321. session->sock = sock;
  18322. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18323. if (ret != 0) {
  18324. impl::mbedtls_last_error() = ret;
  18325. delete session;
  18326. return nullptr;
  18327. }
  18328. // Explicitly opt out of in-handshake hostname verification by default;
  18329. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18330. // fails outright when no hostname was set. set_sni() installs the real
  18331. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18332. // caller verifies the certificate identity post-handshake via
  18333. // verify_hostname().
  18334. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18335. // Set BIO callbacks
  18336. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18337. impl::mbedtls_net_recv_cb, nullptr);
  18338. // Installed always, as it also masks the hostname mismatch that set_sni()
  18339. // may ask for. The session runs its own copy of the user's callback, which
  18340. // set_verify_callback() cannot replace under a handshake.
  18341. session->verify_callback = mctx->verify_callback;
  18342. session->is_server = mctx->is_server;
  18343. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback, session);
  18344. return static_cast<session_t>(session);
  18345. }
  18346. inline void free_session(session_t session) {
  18347. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18348. }
  18349. inline bool set_sni(session_t session, const char *hostname,
  18350. bool verify_hostname) {
  18351. if (!session || !hostname) { return false; }
  18352. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18353. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18354. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18355. // independently, so a disabled hostname check is handled below by masking
  18356. // the resulting mismatch flag instead of skipping this call.
  18357. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18358. if (ret != 0) {
  18359. impl::mbedtls_last_error() = ret;
  18360. return false;
  18361. }
  18362. msession->hostname = hostname;
  18363. if (!verify_hostname) { msession->suppress_hostname_mismatch = true; }
  18364. return true;
  18365. }
  18366. inline TlsError connect(session_t session) {
  18367. TlsError err;
  18368. if (!session) {
  18369. err.code = ErrorCode::Fatal;
  18370. return err;
  18371. }
  18372. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18373. int ret;
  18374. do {
  18375. ret = mbedtls_ssl_handshake(&msession->ssl);
  18376. } while (impl::mbedtls_is_session_ticket(ret));
  18377. if (ret == 0) {
  18378. err.code = ErrorCode::Success;
  18379. } else {
  18380. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18381. impl::mbedtls_last_error() = ret;
  18382. }
  18383. return err;
  18384. }
  18385. inline TlsError accept(session_t session) {
  18386. // A failed handshake leaves its SNI behind, so start without it
  18387. impl::mbedpending_sni().clear();
  18388. // Same as connect for Mbed TLS - handshake works for both client and server
  18389. auto result = connect(session);
  18390. // After successful handshake, capture SNI from thread-local storage
  18391. if (result.code == ErrorCode::Success && session) {
  18392. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18393. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18394. }
  18395. return result;
  18396. }
  18397. inline bool connect_nonblocking(session_t session, socket_t sock,
  18398. time_t timeout_sec, time_t timeout_usec,
  18399. TlsError *err) {
  18400. if (!session) {
  18401. if (err) { err->code = ErrorCode::Fatal; }
  18402. return false;
  18403. }
  18404. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18405. // Set socket to non-blocking mode
  18406. detail::set_nonblocking(sock, true);
  18407. auto cleanup =
  18408. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18409. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18410. int ret;
  18411. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18412. // Non-fatal TLS 1.3 ticket; retry immediately.
  18413. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18414. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18415. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18416. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18417. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18418. }
  18419. // TlsError or timeout
  18420. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18421. impl::mbedtls_last_error() = ret;
  18422. return false;
  18423. }
  18424. if (err) { err->code = ErrorCode::Success; }
  18425. return true;
  18426. }
  18427. inline bool accept_nonblocking(session_t session, socket_t sock,
  18428. time_t timeout_sec, time_t timeout_usec,
  18429. TlsError *err) {
  18430. // A failed handshake leaves its SNI behind, so start without it
  18431. impl::mbedpending_sni().clear();
  18432. // Same implementation as connect for Mbed TLS
  18433. bool result =
  18434. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18435. // After successful handshake, capture SNI from thread-local storage
  18436. if (result && session) {
  18437. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18438. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18439. }
  18440. return result;
  18441. }
  18442. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18443. if (!session || !buf) {
  18444. err.code = ErrorCode::Fatal;
  18445. return -1;
  18446. }
  18447. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18448. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18449. if (msession->has_peeked_byte) {
  18450. if (len == 0) { return 0; }
  18451. auto p = static_cast<unsigned char *>(buf);
  18452. p[0] = msession->peeked_byte;
  18453. msession->has_peeked_byte = false;
  18454. size_t n = 1;
  18455. // Top up with any already-decrypted bytes without risking a block.
  18456. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18457. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18458. if (extra > 0) { n += static_cast<size_t>(extra); }
  18459. }
  18460. err.code = ErrorCode::Success;
  18461. return static_cast<ssize_t>(n);
  18462. }
  18463. int ret;
  18464. do {
  18465. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18466. len);
  18467. } while (impl::mbedtls_is_session_ticket(ret));
  18468. if (ret > 0) {
  18469. err.code = ErrorCode::Success;
  18470. return static_cast<ssize_t>(ret);
  18471. }
  18472. if (ret == 0) {
  18473. err.code = ErrorCode::PeerClosed;
  18474. return 0;
  18475. }
  18476. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18477. err.backend_code = static_cast<uint64_t>(-ret);
  18478. impl::mbedtls_last_error() = ret;
  18479. // mbedTLS signals a clean close_notify via a negative error code rather
  18480. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18481. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18482. return -1;
  18483. }
  18484. inline ssize_t write(session_t session, const void *buf, size_t len,
  18485. TlsError &err) {
  18486. if (!session || !buf) {
  18487. err.code = ErrorCode::Fatal;
  18488. return -1;
  18489. }
  18490. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18491. int ret;
  18492. do {
  18493. ret = mbedtls_ssl_write(&msession->ssl,
  18494. static_cast<const unsigned char *>(buf), len);
  18495. } while (impl::mbedtls_is_session_ticket(ret));
  18496. if (ret > 0) {
  18497. err.code = ErrorCode::Success;
  18498. return static_cast<ssize_t>(ret);
  18499. }
  18500. if (ret == 0) {
  18501. err.code = ErrorCode::PeerClosed;
  18502. return 0;
  18503. }
  18504. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18505. err.backend_code = static_cast<uint64_t>(-ret);
  18506. impl::mbedtls_last_error() = ret;
  18507. return -1;
  18508. }
  18509. inline int pending(const_session_t session) {
  18510. if (!session) { return 0; }
  18511. auto msession =
  18512. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18513. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18514. (msession->has_peeked_byte ? 1 : 0);
  18515. }
  18516. inline void shutdown(session_t session, bool graceful) {
  18517. if (!session) { return; }
  18518. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18519. if (graceful) {
  18520. // Try to send close_notify, but don't block forever
  18521. int ret;
  18522. int attempts = 0;
  18523. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18524. attempts < 3) {
  18525. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18526. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18527. break;
  18528. }
  18529. attempts++;
  18530. }
  18531. }
  18532. }
  18533. inline bool is_peer_closed(session_t session, socket_t sock) {
  18534. if (!session || sock == INVALID_SOCKET) { return true; }
  18535. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18536. // Check if there's already decrypted or pushed-back data available.
  18537. // If so, the connection is definitely alive.
  18538. if (msession->has_peeked_byte ||
  18539. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18540. return false;
  18541. }
  18542. // Set socket to non-blocking to avoid blocking on read
  18543. detail::set_nonblocking(sock, true);
  18544. auto cleanup =
  18545. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18546. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18547. // on application data — e.g. a response that already arrived — push the
  18548. // byte back so the next read() delivers it instead of losing it.
  18549. unsigned char buf;
  18550. int ret;
  18551. do {
  18552. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18553. } while (impl::mbedtls_is_session_ticket(ret));
  18554. // If we got data or WANT_READ (would block), connection is alive
  18555. if (ret > 0) {
  18556. msession->peeked_byte = buf;
  18557. msession->has_peeked_byte = true;
  18558. return false;
  18559. }
  18560. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18561. // If we get a peer close notify or a connection reset, the peer is closed
  18562. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18563. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18564. }
  18565. inline cert_t get_peer_cert(const_session_t session) {
  18566. if (!session) { return nullptr; }
  18567. auto msession =
  18568. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18569. // Mbed TLS returns a pointer to the internal peer cert chain.
  18570. // WARNING: This pointer is only valid while the session is active.
  18571. // Do not use the certificate after calling free_session().
  18572. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18573. return const_cast<mbedtls_x509_crt *>(cert);
  18574. }
  18575. inline size_t get_peer_certs(const_session_t session,
  18576. std::vector<cert_t> &certs) {
  18577. certs.clear();
  18578. // Mbed TLS parses the whole received chain into a list headed by the peer
  18579. // certificate, owned by the session like get_peer_cert()'s result
  18580. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18581. crt && crt->raw.len > 0; crt = crt->next) {
  18582. certs.push_back(static_cast<cert_t>(crt));
  18583. }
  18584. return certs.size();
  18585. }
  18586. inline void free_cert(cert_t cert) {
  18587. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18588. // chain, so there is nothing to free. Callers still call this for the other
  18589. // backends.
  18590. (void)cert;
  18591. }
  18592. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18593. if (!cert || !hostname) { return false; }
  18594. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18595. std::string host_str(hostname);
  18596. // Check if hostname is an IP address (IPv4 or IPv6)
  18597. unsigned char ip_bytes[16];
  18598. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18599. auto is_ip = ip_len > 0;
  18600. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18601. // in buf.tag and the raw value in buf.p / buf.len.
  18602. auto has_dns_san = false;
  18603. for (auto san = &mcert->subject_alt_names; san; san = san->next) {
  18604. if (!san->buf.p || san->buf.len == 0) { continue; }
  18605. const unsigned char *p = san->buf.p;
  18606. size_t len = san->buf.len;
  18607. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18608. if (is_ip) {
  18609. // For an IP host, only a matching iPAddress SAN of the same family
  18610. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18611. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18612. memcmp(p, ip_bytes, ip_len) == 0) {
  18613. return true;
  18614. }
  18615. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18616. has_dns_san = true;
  18617. std::string san_name(reinterpret_cast<const char *>(p), len);
  18618. if (detail::match_hostname(san_name, host_str)) { return true; }
  18619. }
  18620. }
  18621. // Fallback: the Common Names (CN) in the subject, as X509_check_host does it:
  18622. // never for an IP host, which only an iPAddress SAN names, and never next to
  18623. // a DNS SAN (RFC 6125 6.4.4).
  18624. if (is_ip || has_dns_san) { return false; }
  18625. for (auto name = &mcert->subject; name; name = name->next) {
  18626. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18627. std::string cn(reinterpret_cast<const char *>(name->val.p),
  18628. name->val.len);
  18629. if (detail::match_hostname(cn, host_str)) { return true; }
  18630. }
  18631. }
  18632. return false;
  18633. }
  18634. inline uint64_t hostname_mismatch_code() {
  18635. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18636. }
  18637. inline long get_verify_result(const_session_t session) {
  18638. if (!session) { return -1; }
  18639. auto msession =
  18640. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18641. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18642. // Return 0 (X509_V_OK equivalent) if verification passed
  18643. return flags == 0 ? 0 : static_cast<long>(flags);
  18644. }
  18645. inline std::string get_cert_subject_cn(cert_t cert) {
  18646. if (!cert) return "";
  18647. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18648. // Find the CN in the subject
  18649. const mbedtls_x509_name *name = &x509->subject;
  18650. while (name != nullptr) {
  18651. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18652. return std::string(reinterpret_cast<const char *>(name->val.p),
  18653. name->val.len);
  18654. }
  18655. name = name->next;
  18656. }
  18657. return "";
  18658. }
  18659. inline std::string get_cert_issuer_name(cert_t cert) {
  18660. if (!cert) return "";
  18661. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18662. // Build a human-readable issuer name string
  18663. char buf[512];
  18664. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18665. if (ret < 0) return "";
  18666. return std::string(buf);
  18667. }
  18668. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18669. sans.clear();
  18670. if (!cert) return false;
  18671. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18672. // Parse the Subject Alternative Name extension
  18673. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18674. while (cur != nullptr) {
  18675. if (cur->buf.len > 0) {
  18676. const unsigned char *p = cur->buf.p;
  18677. size_t value_len = cur->buf.len;
  18678. SanEntry entry;
  18679. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18680. case MBEDTLS_X509_SAN_DNS_NAME:
  18681. entry.type = SanType::DNS;
  18682. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18683. break;
  18684. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18685. entry.type = SanType::IP;
  18686. if (value_len == 4) {
  18687. // IPv4
  18688. char buf[16];
  18689. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18690. entry.value = buf;
  18691. } else if (value_len == 16) {
  18692. // IPv6
  18693. char buf[64];
  18694. snprintf(buf, sizeof(buf),
  18695. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18696. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18697. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18698. p[10], p[11], p[12], p[13], p[14], p[15]);
  18699. entry.value = buf;
  18700. }
  18701. break;
  18702. case MBEDTLS_X509_SAN_RFC822_NAME:
  18703. entry.type = SanType::EMAIL;
  18704. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18705. break;
  18706. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18707. entry.type = SanType::URI;
  18708. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18709. break;
  18710. default: entry.type = SanType::OTHER; break;
  18711. }
  18712. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18713. }
  18714. cur = cur->next;
  18715. }
  18716. return true;
  18717. }
  18718. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18719. time_t &not_after) {
  18720. if (!cert) return false;
  18721. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18722. // Convert mbedtls_x509_time to time_t
  18723. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18724. struct tm tm_time = {};
  18725. tm_time.tm_year = t.year - 1900;
  18726. tm_time.tm_mon = t.mon - 1;
  18727. tm_time.tm_mday = t.day;
  18728. tm_time.tm_hour = t.hour;
  18729. tm_time.tm_min = t.min;
  18730. tm_time.tm_sec = t.sec;
  18731. #ifdef _WIN32
  18732. return _mkgmtime(&tm_time);
  18733. #else
  18734. return timegm(&tm_time);
  18735. #endif
  18736. };
  18737. not_before = to_time_t(x509->valid_from);
  18738. not_after = to_time_t(x509->valid_to);
  18739. return true;
  18740. }
  18741. inline std::string get_cert_serial(cert_t cert) {
  18742. if (!cert) return "";
  18743. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18744. // Convert serial number to hex string
  18745. std::string result;
  18746. result.reserve(x509->serial.len * 2);
  18747. for (size_t i = 0; i < x509->serial.len; i++) {
  18748. char hex[3];
  18749. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18750. result += hex;
  18751. }
  18752. return result;
  18753. }
  18754. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18755. if (!cert) return false;
  18756. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18757. if (!crt->raw.p || crt->raw.len == 0) return false;
  18758. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18759. return true;
  18760. }
  18761. inline const char *get_sni(const_session_t session) {
  18762. if (!session) return nullptr;
  18763. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18764. // For server: return SNI received from client during handshake
  18765. if (!msession->sni_hostname.empty()) {
  18766. return msession->sni_hostname.c_str();
  18767. }
  18768. // For client: return the hostname set via set_sni
  18769. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18770. return nullptr;
  18771. }
  18772. inline uint64_t peek_error() {
  18773. // Mbed TLS doesn't have an error queue, return the last error
  18774. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18775. }
  18776. inline uint64_t get_error() {
  18777. // Mbed TLS doesn't have an error queue, return and clear the last error
  18778. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18779. impl::mbedtls_last_error() = 0;
  18780. return err;
  18781. }
  18782. inline std::string error_string(uint64_t code) {
  18783. char buf[256];
  18784. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18785. return std::string(buf);
  18786. }
  18787. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18788. #ifdef CPPHTTPLIB_MBEDTLS_V4
  18789. // Parsing certificates needs PSA Crypto, and no context may exist yet
  18790. if (!detail::ensure_mbedtls_psa_crypto()) { return nullptr; }
  18791. #endif
  18792. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18793. if (!ca_chain) { return nullptr; }
  18794. mbedtls_x509_crt_init(ca_chain);
  18795. // mbedtls_x509_crt_parse expects null-terminated PEM
  18796. int ret = mbedtls_x509_crt_parse(ca_chain,
  18797. reinterpret_cast<const unsigned char *>(pem),
  18798. len + 1); // +1 for null terminator
  18799. if (ret != 0) {
  18800. // Try without +1 in case PEM is already null-terminated
  18801. ret = mbedtls_x509_crt_parse(
  18802. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18803. if (ret != 0) {
  18804. mbedtls_x509_crt_free(ca_chain);
  18805. delete ca_chain;
  18806. return nullptr;
  18807. }
  18808. }
  18809. return static_cast<ca_store_t>(ca_chain);
  18810. }
  18811. inline void free_ca_store(ca_store_t store) {
  18812. if (store) {
  18813. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18814. mbedtls_x509_crt_free(ca_chain);
  18815. delete ca_chain;
  18816. }
  18817. }
  18818. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18819. if (!ctx || !store) { return false; }
  18820. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18821. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18822. // Free existing CA chain
  18823. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18824. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18825. // Copy the CA chain (deep copy)
  18826. // Parse from the raw data of the source cert
  18827. mbedtls_x509_crt *src = ca_chain;
  18828. while (src != nullptr) {
  18829. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18830. src->raw.len);
  18831. if (ret != 0) {
  18832. free_ca_store(store);
  18833. return false;
  18834. }
  18835. src = src->next;
  18836. }
  18837. // This function takes ownership of the store; the chain was deep-copied
  18838. // above, so release the source
  18839. free_ca_store(store);
  18840. // Update the SSL config to use the new CA chain
  18841. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18842. return true;
  18843. }
  18844. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18845. certs.clear();
  18846. if (!ctx) { return 0; }
  18847. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18848. // Owned by the context; see free_cert()
  18849. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18850. cert = cert->next) {
  18851. certs.push_back(static_cast<cert_t>(cert));
  18852. }
  18853. return certs.size();
  18854. }
  18855. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18856. std::vector<std::string> names;
  18857. if (!ctx) { return names; }
  18858. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18859. // Iterate through the CA chain
  18860. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18861. while (cert != nullptr && cert->raw.len > 0) {
  18862. char buf[512];
  18863. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18864. if (ret > 0) { names.push_back(buf); }
  18865. cert = cert->next;
  18866. }
  18867. return names;
  18868. }
  18869. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18870. const char *key_pem, const char *password) {
  18871. if (!ctx || !cert_pem || !key_pem) { return false; }
  18872. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18873. // Parse into new objects first, so that a bad pair leaves the old one in
  18874. // place, and swap them in after; the old ones are freed on the way out.
  18875. mbedtls_x509_crt cert;
  18876. mbedtls_pk_context key;
  18877. mbedtls_x509_crt_init(&cert);
  18878. mbedtls_pk_init(&key);
  18879. auto se = detail::scope_exit([&] {
  18880. mbedtls_x509_crt_free(&cert);
  18881. mbedtls_pk_free(&key);
  18882. });
  18883. // Parse certificate PEM
  18884. int ret = mbedtls_x509_crt_parse(
  18885. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18886. strlen(cert_pem) + 1);
  18887. if (ret != 0) {
  18888. impl::mbedtls_last_error() = ret;
  18889. return false;
  18890. }
  18891. // Parse private key PEM
  18892. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18893. ret = mbedtls_pk_parse_key(
  18894. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18895. strlen(key_pem) + 1,
  18896. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18897. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18898. &mbed_ctx->ctr_drbg);
  18899. #else
  18900. ret = mbedtls_pk_parse_key(
  18901. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18902. strlen(key_pem) + 1,
  18903. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18904. password ? strlen(password) : 0);
  18905. #endif
  18906. if (ret != 0) {
  18907. impl::mbedtls_last_error() = ret;
  18908. return false;
  18909. }
  18910. std::swap(mbed_ctx->own_cert, cert);
  18911. std::swap(mbed_ctx->own_key, key);
  18912. // Configure SSL to use the new certificate and key
  18913. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18914. &mbed_ctx->own_key);
  18915. if (ret != 0) {
  18916. impl::mbedtls_last_error() = ret;
  18917. return false;
  18918. }
  18919. return true;
  18920. }
  18921. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18922. if (!ctx || !ca_pem) { return false; }
  18923. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18924. // Parse into a new chain first, so that a bad one leaves the old in place
  18925. mbedtls_x509_crt chain;
  18926. mbedtls_x509_crt_init(&chain);
  18927. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18928. // Parse CA PEM
  18929. int ret = mbedtls_x509_crt_parse(
  18930. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18931. strlen(ca_pem) + 1);
  18932. if (ret != 0) {
  18933. impl::mbedtls_last_error() = ret;
  18934. return false;
  18935. }
  18936. std::swap(mbed_ctx->ca_chain, chain);
  18937. // Update SSL config to use new CA chain
  18938. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18939. return true;
  18940. }
  18941. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18942. if (!ctx) { return false; }
  18943. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18944. // create_session() hands each session its own copy to run.
  18945. mbed_ctx->verify_callback = std::move(callback);
  18946. impl::apply_verify_mode(*mbed_ctx);
  18947. return true;
  18948. }
  18949. inline long get_verify_error(const_session_t session) {
  18950. if (!session) { return -1; }
  18951. auto *msession =
  18952. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18953. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18954. }
  18955. inline std::string verify_error_string(long error_code) {
  18956. if (error_code == 0) { return ""; }
  18957. char buf[256];
  18958. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18959. static_cast<uint32_t>(error_code));
  18960. // Remove trailing newline if present
  18961. std::string result(buf);
  18962. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18963. result.pop_back();
  18964. }
  18965. return result;
  18966. }
  18967. } // namespace tls
  18968. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18969. /*
  18970. * Group 10: TLS abstraction layer - wolfSSL backend
  18971. */
  18972. /*
  18973. * wolfSSL Backend Implementation
  18974. */
  18975. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18976. namespace tls {
  18977. namespace impl {
  18978. // wolfSSL session wrapper
  18979. struct WolfSSLSession {
  18980. WOLFSSL *ssl = nullptr;
  18981. socket_t sock = INVALID_SOCKET;
  18982. std::string hostname; // For client: set via set_sni
  18983. std::string sni_hostname; // For server: received from client via SNI callback
  18984. WolfSSLSession() = default;
  18985. ~WolfSSLSession() {
  18986. if (ssl) { wolfSSL_free(ssl); }
  18987. }
  18988. WolfSSLSession(const WolfSSLSession &) = delete;
  18989. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18990. };
  18991. // Thread-local error code accessor for wolfSSL
  18992. inline uint64_t &wolfssl_last_error() {
  18993. static thread_local uint64_t err = 0;
  18994. return err;
  18995. }
  18996. // Helper to map wolfSSL error to ErrorCode.
  18997. // ssl_error is the value from wolfSSL_get_error().
  18998. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18999. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  19000. int &out_errno) {
  19001. switch (ssl_error) {
  19002. case SSL_ERROR_NONE: return ErrorCode::Success;
  19003. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  19004. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  19005. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  19006. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  19007. default:
  19008. if (ssl) {
  19009. // wolfSSL stores the low-level error code as a negative value.
  19010. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  19011. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  19012. if (low_err == DOMAIN_NAME_MISMATCH) {
  19013. return ErrorCode::HostnameMismatch;
  19014. }
  19015. // Check verify result to distinguish cert verification from generic SSL
  19016. // errors.
  19017. long vr = wolfSSL_get_verify_result(ssl);
  19018. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  19019. }
  19020. return ErrorCode::Fatal;
  19021. }
  19022. }
  19023. // WolfSSLContext constructor/destructor implementations
  19024. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  19025. inline WolfSSLContext::~WolfSSLContext() {
  19026. if (ctx) { wolfSSL_CTX_free(ctx); }
  19027. }
  19028. // Thread-local storage for SNI captured during handshake
  19029. inline std::string &wolfssl_pending_sni() {
  19030. static thread_local std::string sni;
  19031. return sni;
  19032. }
  19033. // SNI callback for wolfSSL server to capture client's SNI hostname
  19034. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  19035. (void)ret;
  19036. (void)exArg;
  19037. void *name_data = nullptr;
  19038. unsigned short name_len =
  19039. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  19040. if (name_data && name_len > 0) {
  19041. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  19042. name_len);
  19043. } else {
  19044. wolfssl_pending_sni().clear();
  19045. }
  19046. return 0; // Continue regardless
  19047. }
  19048. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  19049. // runs the verify callback of its own context.
  19050. inline int context_ex_data_index() {
  19051. static const auto index =
  19052. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19053. return index;
  19054. }
  19055. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  19056. // other tls:: function takes.
  19057. inline int session_ex_data_index() {
  19058. static const auto index =
  19059. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  19060. return index;
  19061. }
  19062. // A resumed session skips the client's certificate, so a server that checks
  19063. // one would let in a certificate checked against another server's CA, as
  19064. // wolfSSL shares its session cache between contexts, or against a CA since
  19065. // replaced by update_server_client_ca().
  19066. inline void disable_server_resumption(WolfSSLContext *wctx) {
  19067. if (!wctx->is_server) { return; }
  19068. wolfSSL_CTX_set_session_cache_mode(wctx->ctx, WOLFSSL_SESS_CACHE_OFF);
  19069. #ifdef HAVE_SESSION_TICKET
  19070. wolfSSL_CTX_NoTicketTLSv12(wctx->ctx);
  19071. #endif
  19072. }
  19073. // wolfSSL verify callback wrapper
  19074. inline int wolfssl_verify_callback(int preverify_ok,
  19075. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  19076. // Get the WOLFSSL object from the X509_STORE_CTX
  19077. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  19078. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  19079. if (!ssl) { return preverify_ok; }
  19080. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  19081. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  19082. if (!wctx) { return preverify_ok; }
  19083. std::shared_ptr<VerifyCallback> callback;
  19084. {
  19085. std::lock_guard<std::mutex> guard(verify_callback_mutex());
  19086. callback = wctx->verify_callback;
  19087. }
  19088. if (!callback) { return preverify_ok; }
  19089. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  19090. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  19091. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  19092. VerifyContext verify_ctx;
  19093. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  19094. verify_ctx.cert = static_cast<cert_t>(cert);
  19095. verify_ctx.depth = depth;
  19096. verify_ctx.preverify_ok = (preverify_ok != 0);
  19097. verify_ctx.error_code = static_cast<long>(err);
  19098. if (err != 0) {
  19099. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  19100. } else {
  19101. verify_ctx.error_string = nullptr;
  19102. }
  19103. auto accepted = run_verify_callback(*callback, verify_ctx);
  19104. // A client verifying the server during the handshake, which is what
  19105. // set_verify_client(ctx, true) asks for there, keeps the built-in verdict
  19106. if (!wolfSSL_is_server(ssl) &&
  19107. (wolfSSL_get_verify_mode(ssl) & WOLFSSL_VERIFY_FAIL_IF_NO_PEER_CERT)) {
  19108. accepted = accepted && preverify_ok;
  19109. }
  19110. return accepted ? 1 : 0;
  19111. }
  19112. // Sets the verify mode from whether the peer's certificate is required and
  19113. // whether a verify callback is set.
  19114. inline void apply_verify_mode(WolfSSLContext &wctx) {
  19115. auto has_callback = static_cast<bool>(wctx.verify_callback);
  19116. if (wctx.verify_client || has_callback) { disable_server_resumption(&wctx); }
  19117. auto mode = wctx.verify_client
  19118. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19119. : (has_callback ? SSL_VERIFY_PEER : SSL_VERIFY_NONE);
  19120. wolfSSL_CTX_set_verify(wctx.ctx, mode,
  19121. has_callback ? wolfssl_verify_callback : nullptr);
  19122. }
  19123. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  19124. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  19125. wolfSSL_CTX_set_default_passwd_cb(
  19126. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  19127. auto *pwd = static_cast<const char *>(userdata);
  19128. if (!pwd) return 0;
  19129. auto len = static_cast<int>(strlen(pwd));
  19130. if (len > size) len = size;
  19131. memcpy(buf, pwd, static_cast<size_t>(len));
  19132. return len;
  19133. });
  19134. }
  19135. } // namespace impl
  19136. inline ctx_t create_client_context() {
  19137. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19138. if (!ctx) { return nullptr; }
  19139. ctx->is_server = false;
  19140. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  19141. if (!method) {
  19142. delete ctx;
  19143. return nullptr;
  19144. }
  19145. ctx->ctx = wolfSSL_CTX_new(method);
  19146. if (!ctx->ctx ||
  19147. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19148. WOLFSSL_SUCCESS) {
  19149. delete ctx;
  19150. return nullptr;
  19151. }
  19152. // Default: verify peer certificate
  19153. ctx->verify_client = true;
  19154. impl::apply_verify_mode(*ctx);
  19155. return static_cast<ctx_t>(ctx);
  19156. }
  19157. inline ctx_t create_server_context() {
  19158. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  19159. if (!ctx) { return nullptr; }
  19160. ctx->is_server = true;
  19161. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  19162. if (!method) {
  19163. delete ctx;
  19164. return nullptr;
  19165. }
  19166. ctx->ctx = wolfSSL_CTX_new(method);
  19167. if (!ctx->ctx ||
  19168. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  19169. WOLFSSL_SUCCESS) {
  19170. delete ctx;
  19171. return nullptr;
  19172. }
  19173. // Default: don't verify client
  19174. impl::apply_verify_mode(*ctx);
  19175. // Enable SNI on server
  19176. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  19177. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  19178. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  19179. return static_cast<ctx_t>(ctx);
  19180. }
  19181. inline void free_context(ctx_t ctx) {
  19182. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  19183. }
  19184. inline bool set_min_version(ctx_t ctx, Version version) {
  19185. if (!ctx) { return false; }
  19186. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19187. int min_ver = WOLFSSL_TLSV1_2;
  19188. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  19189. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  19190. }
  19191. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  19192. if (!ctx || !pem) { return false; }
  19193. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19194. int ret = wolfSSL_CTX_load_verify_buffer(
  19195. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  19196. static_cast<long>(len), SSL_FILETYPE_PEM);
  19197. if (ret != SSL_SUCCESS) {
  19198. impl::wolfssl_last_error() =
  19199. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19200. return false;
  19201. }
  19202. wctx->ca_pem_data_.append(pem, len);
  19203. return true;
  19204. }
  19205. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  19206. if (!ctx || !file_path) { return false; }
  19207. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19208. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  19209. if (ret != SSL_SUCCESS) {
  19210. impl::wolfssl_last_error() =
  19211. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19212. return false;
  19213. }
  19214. return true;
  19215. }
  19216. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  19217. if (!ctx || !dir_path) { return false; }
  19218. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19219. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  19220. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  19221. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  19222. // immediately. Return true even on failure since the CA file may have
  19223. // already been loaded, matching OpenSSL's lenient behavior.
  19224. (void)ret;
  19225. return true;
  19226. }
  19227. inline bool load_system_certs(ctx_t ctx) {
  19228. if (!ctx) { return false; }
  19229. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19230. bool loaded = false;
  19231. #ifdef _WIN32
  19232. loaded = impl::enumerate_windows_system_certs(
  19233. [&](const unsigned char *data, size_t len) {
  19234. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19235. static_cast<long>(len),
  19236. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19237. });
  19238. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  19239. loaded = impl::enumerate_macos_keychain_certs(
  19240. [&](const unsigned char *data, size_t len) {
  19241. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  19242. static_cast<long>(len),
  19243. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  19244. });
  19245. #else
  19246. for (auto path = impl::system_ca_paths(); *path; ++path) {
  19247. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  19248. SSL_SUCCESS) {
  19249. loaded = true;
  19250. break;
  19251. }
  19252. }
  19253. if (!loaded) {
  19254. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  19255. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  19256. SSL_SUCCESS) {
  19257. loaded = true;
  19258. break;
  19259. }
  19260. }
  19261. }
  19262. #endif
  19263. return loaded;
  19264. }
  19265. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  19266. const char *password) {
  19267. if (!ctx || !cert || !key) { return false; }
  19268. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19269. // Load certificate
  19270. int ret = wolfSSL_CTX_use_certificate_buffer(
  19271. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  19272. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  19273. if (ret != SSL_SUCCESS) {
  19274. impl::wolfssl_last_error() =
  19275. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19276. return false;
  19277. }
  19278. // Set password callback if password is provided
  19279. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19280. // Load private key
  19281. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19282. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  19283. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  19284. if (ret != SSL_SUCCESS) {
  19285. impl::wolfssl_last_error() =
  19286. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19287. return false;
  19288. }
  19289. // Verify that the certificate and private key match
  19290. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19291. }
  19292. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  19293. const char *key_path, const char *password) {
  19294. if (!ctx || !cert_path || !key_path) { return false; }
  19295. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19296. // Load certificate file
  19297. int ret =
  19298. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  19299. if (ret != SSL_SUCCESS) {
  19300. impl::wolfssl_last_error() =
  19301. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19302. return false;
  19303. }
  19304. // Set password callback if password is provided
  19305. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19306. // Load private key file
  19307. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  19308. if (ret != SSL_SUCCESS) {
  19309. impl::wolfssl_last_error() =
  19310. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19311. return false;
  19312. }
  19313. // Verify that the certificate and private key match
  19314. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  19315. }
  19316. inline void set_verify_client(ctx_t ctx, bool require) {
  19317. if (!ctx) { return; }
  19318. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19319. wctx->verify_client = require;
  19320. impl::apply_verify_mode(*wctx);
  19321. }
  19322. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19323. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19324. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19325. auto session = new (std::nothrow) impl::WolfSSLSession();
  19326. if (!session) { return nullptr; }
  19327. session->sock = sock;
  19328. session->ssl = wolfSSL_new(wctx->ctx);
  19329. if (!session->ssl) {
  19330. impl::wolfssl_last_error() =
  19331. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19332. delete session;
  19333. return nullptr;
  19334. }
  19335. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19336. session) != WOLFSSL_SUCCESS) {
  19337. delete session;
  19338. return nullptr;
  19339. }
  19340. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19341. return static_cast<session_t>(session);
  19342. }
  19343. inline void free_session(session_t session) {
  19344. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19345. }
  19346. inline bool set_sni(session_t session, const char *hostname,
  19347. bool verify_hostname) {
  19348. if (!session || !hostname) { return false; }
  19349. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19350. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19351. static_cast<word16>(strlen(hostname)));
  19352. if (ret != WOLFSSL_SUCCESS) {
  19353. impl::wolfssl_last_error() =
  19354. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19355. return false;
  19356. }
  19357. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19358. // separately from the SNI extension sent above; skip it when hostname
  19359. // verification is disabled so only the chain is checked, matching OpenSSL.
  19360. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19361. wsession->hostname = hostname;
  19362. return true;
  19363. }
  19364. inline TlsError connect(session_t session) {
  19365. TlsError err;
  19366. if (!session) {
  19367. err.code = ErrorCode::Fatal;
  19368. return err;
  19369. }
  19370. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19371. int ret = wolfSSL_connect(wsession->ssl);
  19372. if (ret == SSL_SUCCESS) {
  19373. err.code = ErrorCode::Success;
  19374. } else {
  19375. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19376. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19377. err.backend_code = static_cast<uint64_t>(ssl_error);
  19378. impl::wolfssl_last_error() = err.backend_code;
  19379. }
  19380. return err;
  19381. }
  19382. inline TlsError accept(session_t session) {
  19383. TlsError err;
  19384. if (!session) {
  19385. err.code = ErrorCode::Fatal;
  19386. return err;
  19387. }
  19388. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19389. int ret = wolfSSL_accept(wsession->ssl);
  19390. if (ret == SSL_SUCCESS) {
  19391. err.code = ErrorCode::Success;
  19392. // Capture SNI from thread-local storage after successful handshake
  19393. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19394. impl::wolfssl_pending_sni().clear();
  19395. } else {
  19396. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19397. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19398. err.backend_code = static_cast<uint64_t>(ssl_error);
  19399. impl::wolfssl_last_error() = err.backend_code;
  19400. }
  19401. return err;
  19402. }
  19403. inline bool connect_nonblocking(session_t session, socket_t sock,
  19404. time_t timeout_sec, time_t timeout_usec,
  19405. TlsError *err) {
  19406. if (!session) {
  19407. if (err) { err->code = ErrorCode::Fatal; }
  19408. return false;
  19409. }
  19410. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19411. // Set socket to non-blocking mode
  19412. detail::set_nonblocking(sock, true);
  19413. auto cleanup =
  19414. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19415. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19416. int ret;
  19417. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19418. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19419. if (ssl_error == SSL_ERROR_WANT_READ) {
  19420. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19421. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19422. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19423. }
  19424. // Error or timeout
  19425. if (err) {
  19426. err->code =
  19427. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19428. err->backend_code = static_cast<uint64_t>(ssl_error);
  19429. }
  19430. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19431. return false;
  19432. }
  19433. if (err) { err->code = ErrorCode::Success; }
  19434. return true;
  19435. }
  19436. inline bool accept_nonblocking(session_t session, socket_t sock,
  19437. time_t timeout_sec, time_t timeout_usec,
  19438. TlsError *err) {
  19439. if (!session) {
  19440. if (err) { err->code = ErrorCode::Fatal; }
  19441. return false;
  19442. }
  19443. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19444. // Set socket to non-blocking mode
  19445. detail::set_nonblocking(sock, true);
  19446. auto cleanup =
  19447. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19448. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19449. int ret;
  19450. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19451. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19452. if (ssl_error == SSL_ERROR_WANT_READ) {
  19453. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19454. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19455. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19456. }
  19457. // Error or timeout
  19458. if (err) {
  19459. err->code =
  19460. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19461. err->backend_code = static_cast<uint64_t>(ssl_error);
  19462. }
  19463. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19464. return false;
  19465. }
  19466. if (err) { err->code = ErrorCode::Success; }
  19467. // Capture SNI from thread-local storage after successful handshake
  19468. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19469. impl::wolfssl_pending_sni().clear();
  19470. return true;
  19471. }
  19472. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19473. if (!session || !buf) {
  19474. err.code = ErrorCode::Fatal;
  19475. return -1;
  19476. }
  19477. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19478. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19479. if (ret > 0) {
  19480. err.code = ErrorCode::Success;
  19481. return static_cast<ssize_t>(ret);
  19482. }
  19483. if (ret == 0) {
  19484. err.code = ErrorCode::PeerClosed;
  19485. return 0;
  19486. }
  19487. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19488. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19489. err.backend_code = static_cast<uint64_t>(ssl_error);
  19490. impl::wolfssl_last_error() = err.backend_code;
  19491. return -1;
  19492. }
  19493. inline ssize_t write(session_t session, const void *buf, size_t len,
  19494. TlsError &err) {
  19495. if (!session || !buf) {
  19496. err.code = ErrorCode::Fatal;
  19497. return -1;
  19498. }
  19499. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19500. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19501. if (ret > 0) {
  19502. err.code = ErrorCode::Success;
  19503. return static_cast<ssize_t>(ret);
  19504. }
  19505. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19506. // Treat this as an error (return -1) so callers don't spin in a
  19507. // write loop adding zero to the offset.
  19508. if (ret == 0) {
  19509. err.code = ErrorCode::PeerClosed;
  19510. return -1;
  19511. }
  19512. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19513. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19514. err.backend_code = static_cast<uint64_t>(ssl_error);
  19515. impl::wolfssl_last_error() = err.backend_code;
  19516. return -1;
  19517. }
  19518. inline int pending(const_session_t session) {
  19519. if (!session) { return 0; }
  19520. auto wsession =
  19521. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19522. return wolfSSL_pending(wsession->ssl);
  19523. }
  19524. inline void shutdown(session_t session, bool graceful) {
  19525. if (!session) { return; }
  19526. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19527. if (graceful) {
  19528. int ret;
  19529. int attempts = 0;
  19530. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19531. attempts < 3) {
  19532. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19533. if (ssl_error != SSL_ERROR_WANT_READ &&
  19534. ssl_error != SSL_ERROR_WANT_WRITE) {
  19535. break;
  19536. }
  19537. attempts++;
  19538. }
  19539. } else {
  19540. wolfSSL_shutdown(wsession->ssl);
  19541. }
  19542. }
  19543. inline bool is_peer_closed(session_t session, socket_t sock) {
  19544. if (!session || sock == INVALID_SOCKET) { return true; }
  19545. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19546. // Check if there's already decrypted data available
  19547. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19548. // Set socket to non-blocking to avoid blocking on read
  19549. detail::set_nonblocking(sock, true);
  19550. auto cleanup =
  19551. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19552. // Peek 1 byte to check connection status without consuming data
  19553. unsigned char buf;
  19554. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19555. // If we got data or WANT_READ (would block), connection is alive
  19556. if (ret > 0) { return false; }
  19557. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19558. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19559. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19560. ret == 0;
  19561. }
  19562. inline cert_t get_peer_cert(const_session_t session) {
  19563. if (!session) { return nullptr; }
  19564. auto wsession =
  19565. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19566. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19567. return static_cast<cert_t>(cert);
  19568. }
  19569. inline size_t get_peer_certs(const_session_t session,
  19570. std::vector<cert_t> &certs) {
  19571. certs.clear();
  19572. if (!session) { return 0; }
  19573. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19574. #ifdef SESSION_CERTS
  19575. auto wsession =
  19576. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19577. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19578. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19579. for (int i = 0; i < count; i++) {
  19580. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19581. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19582. }
  19583. #endif
  19584. return certs.size();
  19585. }
  19586. inline void free_cert(cert_t cert) {
  19587. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19588. }
  19589. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19590. if (!cert || !hostname) { return false; }
  19591. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19592. std::string host_str(hostname);
  19593. // Check if hostname is an IP address (IPv4 or IPv6)
  19594. unsigned char ip_bytes[16];
  19595. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19596. auto is_ip = ip_len > 0;
  19597. // Check Subject Alternative Names
  19598. auto has_dns_san = false;
  19599. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19600. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19601. if (san_names) {
  19602. int san_count = wolfSSL_sk_num(san_names);
  19603. for (int i = 0; i < san_count; i++) {
  19604. auto *names =
  19605. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19606. if (!names) continue;
  19607. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19608. // DNS name
  19609. has_dns_san = true;
  19610. unsigned char *dns_name = nullptr;
  19611. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19612. if (dns_name && dns_len > 0) {
  19613. std::string san_name(reinterpret_cast<char *>(dns_name),
  19614. static_cast<size_t>(dns_len));
  19615. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19616. if (detail::match_hostname(san_name, host_str)) {
  19617. wolfSSL_sk_free(san_names);
  19618. return true;
  19619. }
  19620. }
  19621. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19622. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19623. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19624. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19625. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19626. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19627. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19628. wolfSSL_sk_free(san_names);
  19629. return true;
  19630. }
  19631. }
  19632. }
  19633. wolfSSL_sk_free(san_names);
  19634. }
  19635. // Fallback: the Common Name (CN) in the subject, as X509_check_host does it:
  19636. // never for an IP host, which only an iPAddress SAN names, and never next to
  19637. // a DNS SAN (RFC 6125 6.4.4).
  19638. if (is_ip || has_dns_san) { return false; }
  19639. auto cn = get_cert_subject_cn(cert);
  19640. return !cn.empty() && detail::match_hostname(cn, host_str);
  19641. }
  19642. inline uint64_t hostname_mismatch_code() {
  19643. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19644. }
  19645. inline long get_verify_result(const_session_t session) {
  19646. if (!session) { return -1; }
  19647. auto wsession =
  19648. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19649. long result = wolfSSL_get_verify_result(wsession->ssl);
  19650. return result;
  19651. }
  19652. inline std::string get_cert_subject_cn(cert_t cert) {
  19653. if (!cert) return "";
  19654. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19655. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19656. if (!subject) return "";
  19657. char cn[256] = {};
  19658. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19659. sizeof(cn));
  19660. if (cn_len <= 0) return "";
  19661. return std::string(cn, static_cast<size_t>(cn_len));
  19662. }
  19663. inline std::string get_cert_issuer_name(cert_t cert) {
  19664. if (!cert) return "";
  19665. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19666. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19667. if (!issuer) return "";
  19668. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19669. if (!name_str) return "";
  19670. std::string result(name_str);
  19671. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19672. return result;
  19673. }
  19674. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19675. sans.clear();
  19676. if (!cert) return false;
  19677. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19678. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19679. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19680. if (!san_names) return true; // No SANs is not an error
  19681. int count = wolfSSL_sk_num(san_names);
  19682. for (int i = 0; i < count; i++) {
  19683. auto *name =
  19684. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19685. if (!name) continue;
  19686. SanEntry entry;
  19687. switch (name->type) {
  19688. case WOLFSSL_GEN_DNS: {
  19689. entry.type = SanType::DNS;
  19690. unsigned char *dns_name = nullptr;
  19691. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19692. if (dns_name && dns_len > 0) {
  19693. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19694. static_cast<size_t>(dns_len));
  19695. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19696. }
  19697. break;
  19698. }
  19699. case WOLFSSL_GEN_IPADD: {
  19700. entry.type = SanType::IP;
  19701. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19702. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19703. if (ip_data && ip_len == 4) {
  19704. char buf[16];
  19705. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19706. ip_data[2], ip_data[3]);
  19707. entry.value = buf;
  19708. } else if (ip_data && ip_len == 16) {
  19709. char buf[64];
  19710. snprintf(buf, sizeof(buf),
  19711. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19712. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19713. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19714. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19715. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19716. ip_data[14], ip_data[15]);
  19717. entry.value = buf;
  19718. }
  19719. break;
  19720. }
  19721. case WOLFSSL_GEN_EMAIL:
  19722. entry.type = SanType::EMAIL;
  19723. {
  19724. unsigned char *email = nullptr;
  19725. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19726. if (email && email_len > 0) {
  19727. entry.value = std::string(reinterpret_cast<char *>(email),
  19728. static_cast<size_t>(email_len));
  19729. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19730. }
  19731. }
  19732. break;
  19733. case WOLFSSL_GEN_URI:
  19734. entry.type = SanType::URI;
  19735. {
  19736. unsigned char *uri = nullptr;
  19737. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19738. &uri, name->d.uniformResourceIdentifier);
  19739. if (uri && uri_len > 0) {
  19740. entry.value = std::string(reinterpret_cast<char *>(uri),
  19741. static_cast<size_t>(uri_len));
  19742. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19743. }
  19744. }
  19745. break;
  19746. default: entry.type = SanType::OTHER; break;
  19747. }
  19748. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19749. }
  19750. wolfSSL_sk_free(san_names);
  19751. return true;
  19752. }
  19753. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19754. time_t &not_after) {
  19755. if (!cert) return false;
  19756. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19757. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19758. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19759. if (!nb || !na) return false;
  19760. // wolfSSL_ASN1_TIME_to_tm is available
  19761. struct tm tm_nb = {}, tm_na = {};
  19762. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19763. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19764. #ifdef _WIN32
  19765. not_before = _mkgmtime(&tm_nb);
  19766. not_after = _mkgmtime(&tm_na);
  19767. #else
  19768. not_before = timegm(&tm_nb);
  19769. not_after = timegm(&tm_na);
  19770. #endif
  19771. return true;
  19772. }
  19773. inline std::string get_cert_serial(cert_t cert) {
  19774. if (!cert) return "";
  19775. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19776. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19777. if (!serial_asn1) return "";
  19778. // Get the serial number data
  19779. int len = serial_asn1->length;
  19780. unsigned char *data = serial_asn1->data;
  19781. if (!data || len <= 0) return "";
  19782. std::string result;
  19783. result.reserve(static_cast<size_t>(len) * 2);
  19784. for (int i = 0; i < len; i++) {
  19785. char hex[3];
  19786. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19787. result += hex;
  19788. }
  19789. return result;
  19790. }
  19791. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19792. if (!cert) return false;
  19793. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19794. int der_len = 0;
  19795. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19796. if (!der_data || der_len <= 0) return false;
  19797. der.assign(der_data, der_data + der_len);
  19798. return true;
  19799. }
  19800. inline const char *get_sni(const_session_t session) {
  19801. if (!session) return nullptr;
  19802. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19803. // For server: return SNI received from client during handshake
  19804. if (!wsession->sni_hostname.empty()) {
  19805. return wsession->sni_hostname.c_str();
  19806. }
  19807. // For client: return the hostname set via set_sni
  19808. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19809. return nullptr;
  19810. }
  19811. inline uint64_t peek_error() {
  19812. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19813. }
  19814. inline uint64_t get_error() {
  19815. uint64_t err = impl::wolfssl_last_error();
  19816. impl::wolfssl_last_error() = 0;
  19817. return err;
  19818. }
  19819. inline std::string error_string(uint64_t code) {
  19820. char buf[256];
  19821. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19822. return std::string(buf);
  19823. }
  19824. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19825. if (!pem || len == 0) { return nullptr; }
  19826. // Validate by attempting to load into a temporary ctx
  19827. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19828. if (!tmp_ctx) { return nullptr; }
  19829. int ret = wolfSSL_CTX_load_verify_buffer(
  19830. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19831. static_cast<long>(len), SSL_FILETYPE_PEM);
  19832. wolfSSL_CTX_free(tmp_ctx);
  19833. if (ret != SSL_SUCCESS) { return nullptr; }
  19834. return static_cast<ca_store_t>(
  19835. new impl::WolfSSLCAStore{std::string(pem, len)});
  19836. }
  19837. inline void free_ca_store(ca_store_t store) {
  19838. delete static_cast<impl::WolfSSLCAStore *>(store);
  19839. }
  19840. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19841. if (!ctx || !store) { return false; }
  19842. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19843. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19844. int ret = wolfSSL_CTX_load_verify_buffer(
  19845. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19846. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19847. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19848. // This function takes ownership of the store; the PEM data was copied into
  19849. // the context, so release the source
  19850. free_ca_store(store);
  19851. return ret == SSL_SUCCESS;
  19852. }
  19853. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19854. certs.clear();
  19855. if (!ctx) { return 0; }
  19856. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19857. if (wctx->ca_pem_data_.empty()) { return 0; }
  19858. const std::string &pem = wctx->ca_pem_data_;
  19859. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19860. const std::string end_marker = "-----END CERTIFICATE-----";
  19861. size_t pos = 0;
  19862. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19863. size_t end_pos = pem.find(end_marker, pos);
  19864. if (end_pos == std::string::npos) { break; }
  19865. end_pos += end_marker.size();
  19866. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19867. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19868. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19869. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19870. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19871. pos = end_pos;
  19872. }
  19873. return certs.size();
  19874. }
  19875. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19876. std::vector<std::string> names;
  19877. if (!ctx) { return names; }
  19878. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19879. if (wctx->ca_pem_data_.empty()) { return names; }
  19880. const std::string &pem = wctx->ca_pem_data_;
  19881. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19882. const std::string end_marker = "-----END CERTIFICATE-----";
  19883. size_t pos = 0;
  19884. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19885. size_t end_pos = pem.find(end_marker, pos);
  19886. if (end_pos == std::string::npos) { break; }
  19887. end_pos += end_marker.size();
  19888. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19889. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19890. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19891. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19892. if (x509) {
  19893. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19894. if (subject) {
  19895. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19896. if (name_str) {
  19897. names.push_back(name_str);
  19898. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19899. }
  19900. }
  19901. wolfSSL_X509_free(x509);
  19902. }
  19903. pos = end_pos;
  19904. }
  19905. return names;
  19906. }
  19907. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19908. const char *key_pem, const char *password) {
  19909. if (!ctx || !cert_pem || !key_pem) { return false; }
  19910. // Try the pair on a scratch context first, so that a bad one leaves the
  19911. // server's certificate and key as they were
  19912. auto tmp = create_server_context();
  19913. if (!tmp) { return false; }
  19914. auto se = detail::scope_exit([&] { free_context(tmp); });
  19915. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19916. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19917. }
  19918. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19919. if (!ctx || !ca_pem) { return false; }
  19920. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19921. // Replace the CAs rather than add to them, as the other backends do, once
  19922. // the new ones are known to load
  19923. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19924. if (!store) { return false; }
  19925. free_ca_store(store);
  19926. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19927. wctx->ca_pem_data_.clear();
  19928. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19929. }
  19930. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19931. if (!ctx) { return false; }
  19932. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19933. auto stored = callback ? std::make_shared<VerifyCallback>(std::move(callback))
  19934. : nullptr;
  19935. {
  19936. std::lock_guard<std::mutex> guard(impl::verify_callback_mutex());
  19937. // A handshake running the previous callback keeps it until it returns.
  19938. wctx->verify_callback.swap(stored);
  19939. }
  19940. impl::apply_verify_mode(*wctx);
  19941. return true;
  19942. }
  19943. inline long get_verify_error(const_session_t session) {
  19944. if (!session) { return -1; }
  19945. auto *wsession =
  19946. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19947. return wolfSSL_get_verify_result(wsession->ssl);
  19948. }
  19949. inline std::string verify_error_string(long error_code) {
  19950. if (error_code == 0) { return ""; }
  19951. const char *str =
  19952. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19953. return str ? std::string(str) : std::string();
  19954. }
  19955. } // namespace tls
  19956. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19957. // WebSocket implementation
  19958. namespace ws {
  19959. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19960. bool fin) {
  19961. std::lock_guard<std::mutex> lock(write_mutex_);
  19962. if (closed_) { return false; }
  19963. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19964. }
  19965. inline ReadResult WebSocket::read(std::string &msg) {
  19966. // Answers a control frame; any other opcode here is a protocol error.
  19967. // Returns false when the connection is done.
  19968. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  19969. switch (op) {
  19970. case Opcode::Ping: {
  19971. std::lock_guard<std::mutex> lock(write_mutex_);
  19972. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19973. payload.size(), true, !is_server_);
  19974. return true;
  19975. }
  19976. case Opcode::Pong: {
  19977. std::lock_guard<std::mutex> lock(ping_mutex_);
  19978. unacked_pings_ = 0;
  19979. return true;
  19980. }
  19981. case Opcode::Close: {
  19982. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  19983. // malformed, which is answered with a protocol error instead.
  19984. if (closed_.exchange(true)) { return false; }
  19985. auto reply = payload;
  19986. if (!impl::is_valid_close_payload(payload)) {
  19987. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19988. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19989. }
  19990. std::lock_guard<std::mutex> lock(write_mutex_);
  19991. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19992. reply.size(), true, !is_server_);
  19993. return false;
  19994. }
  19995. default: closed_ = true; return false;
  19996. }
  19997. };
  19998. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19999. while (!closed_) {
  20000. Opcode opcode;
  20001. std::string payload;
  20002. bool fin;
  20003. impl::FrameRead r =
  20004. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  20005. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  20006. // A timeout landed on a frame boundary of an open connection: it is
  20007. // untouched and still usable, so hand control back without closing it.
  20008. // That is only useful to a caller who asked for the timeout; the
  20009. // compile-time default is a backstop against a peer gone quiet, and
  20010. // elapsing it closes the connection so a plain `while (ws.read(msg))` loop
  20011. // ends. A wait that a pong timeout cut short finds the connection closed.
  20012. if (r == impl::FrameRead::Timeout && read_timeout_set_ && !closed_) {
  20013. return Timeout;
  20014. }
  20015. if (r != impl::FrameRead::Ok) {
  20016. closed_ = true;
  20017. return Fail;
  20018. }
  20019. switch (opcode) {
  20020. case Opcode::Text:
  20021. case Opcode::Binary: {
  20022. auto result = opcode == Opcode::Text ? Text : Binary;
  20023. msg = std::move(payload);
  20024. // Handle fragmentation
  20025. if (!fin) {
  20026. while (true) {
  20027. Opcode cont_opcode;
  20028. std::string cont_payload;
  20029. bool cont_fin;
  20030. // Only what is left of the limit, but room for a control frame,
  20031. // which may come between the fragments.
  20032. auto max_len =
  20033. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  20034. ? size_t(0)
  20035. : (std::max)(size_t(125),
  20036. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  20037. msg.size());
  20038. // A timeout is not reportable here: half of a fragmented message is
  20039. // already in `msg` and read() has no way to resume it, so it is a
  20040. // failure like any other. Timeouts are only ever seen on a message
  20041. // boundary.
  20042. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  20043. cont_fin, is_server_,
  20044. max_len) != impl::FrameRead::Ok) {
  20045. closed_ = true;
  20046. return Fail;
  20047. }
  20048. // RFC 6455 5.4: the fragments are continuation frames, with only
  20049. // control frames between them.
  20050. if (cont_opcode != Opcode::Continuation) {
  20051. if (handle_control(cont_opcode, cont_payload)) { continue; }
  20052. return Fail;
  20053. }
  20054. msg += cont_payload;
  20055. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  20056. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  20057. closed_ = true;
  20058. return Fail;
  20059. }
  20060. if (cont_fin) { break; }
  20061. }
  20062. }
  20063. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  20064. if (result == Text && !impl::is_valid_utf8(msg)) {
  20065. // close() takes the read lock to wait for the peer's Close reply, so
  20066. // it must not run while this thread still holds it.
  20067. read_lock.unlock();
  20068. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  20069. return Fail;
  20070. }
  20071. return result;
  20072. }
  20073. default:
  20074. if (handle_control(opcode, payload)) { continue; }
  20075. return Fail;
  20076. }
  20077. }
  20078. return Fail;
  20079. }
  20080. inline bool WebSocket::send(const std::string &data) {
  20081. return send_frame(Opcode::Text, data.data(), data.size());
  20082. }
  20083. inline bool WebSocket::send(const char *data, size_t len) {
  20084. return send_frame(Opcode::Binary, data, len);
  20085. }
  20086. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  20087. if (closed_.exchange(true)) { return; }
  20088. ping_cv_.notify_all();
  20089. std::string payload;
  20090. auto code = static_cast<uint16_t>(status);
  20091. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  20092. payload.push_back(static_cast<char>(code & 0xFF));
  20093. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  20094. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  20095. // cut back to a whole UTF-8 character
  20096. auto short_reason = reason.substr(0, 123);
  20097. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  20098. short_reason.pop_back();
  20099. }
  20100. payload += short_reason;
  20101. // A code that may not be sent, such as NoStatus, goes without a payload
  20102. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  20103. {
  20104. std::lock_guard<std::mutex> lock(write_mutex_);
  20105. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  20106. payload.size(), true, !is_server_);
  20107. }
  20108. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  20109. // Close response before closing the TCP connection.
  20110. //
  20111. // Wait only when no other thread is parsing frames. When one is, it is the
  20112. // thread positioned to see the peer's reply, and reading here would take
  20113. // bytes out of the message it is assembling. Bailing out also leaves the
  20114. // stream, including its read timeout, entirely to that thread.
  20115. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  20116. if (!read_lock.owns_lock()) { return; }
  20117. // Use a short timeout to avoid hanging if the peer doesn't respond.
  20118. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  20119. Opcode op;
  20120. std::string resp;
  20121. bool fin;
  20122. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  20123. impl::FrameRead::Ok) {
  20124. if (op == Opcode::Close) { break; }
  20125. }
  20126. }
  20127. inline WebSocket::~WebSocket() {
  20128. {
  20129. std::lock_guard<std::mutex> lock(ping_mutex_);
  20130. closed_ = true;
  20131. }
  20132. ping_cv_.notify_all();
  20133. if (ping_thread_.joinable()) { ping_thread_.join(); }
  20134. // A server's stream outlives this object
  20135. strm_.set_read_interrupt(nullptr);
  20136. }
  20137. inline void WebSocket::start_heartbeat() {
  20138. if (ping_interval_sec_ <= 0) { return; }
  20139. // A pong timeout ends a read() blocked on the silent peer
  20140. if (max_missed_pongs_ > 0) {
  20141. strm_.set_read_interrupt([this] { return pong_timed_out_.load(); });
  20142. }
  20143. ping_thread_ = std::thread([this]() {
  20144. std::unique_lock<std::mutex> lock(ping_mutex_);
  20145. // The predicate keeps a spurious wakeup from sending a ping early
  20146. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  20147. [this]() { return closed_.load(); })) {
  20148. // If the peer has failed to respond to the previous pings, give up.
  20149. // RFC 6455 does not define a pong-timeout mechanism; this is an
  20150. // opt-in liveness check controlled by max_missed_pongs_.
  20151. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  20152. lock.unlock();
  20153. close(CloseStatus::GoingAway, "pong timeout");
  20154. pong_timed_out_ = true;
  20155. return;
  20156. }
  20157. lock.unlock();
  20158. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  20159. lock.lock();
  20160. closed_ = true;
  20161. break;
  20162. }
  20163. lock.lock();
  20164. unacked_pings_++;
  20165. }
  20166. });
  20167. }
  20168. inline const Request &WebSocket::request() const { return req_; }
  20169. inline bool WebSocket::is_open() const { return !closed_; }
  20170. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  20171. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  20172. // poll(), where 0 would instead mean "return immediately", so hand it the
  20173. // negative poll uses for an unbounded wait.
  20174. if (sec == 0 && usec == 0) { sec = -1; }
  20175. strm_.set_read_timeout(sec, usec);
  20176. read_timeout_set_ = true;
  20177. }
  20178. // WebSocketClient implementation
  20179. inline WebSocketClient::WebSocketClient(
  20180. const std::string &scheme_host_port_path, const Headers &headers)
  20181. : headers_(headers) {
  20182. detail::UrlComponents uc;
  20183. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  20184. !uc.host.empty() && !uc.path.empty()) {
  20185. auto &scheme = uc.scheme;
  20186. #ifdef CPPHTTPLIB_SSL_ENABLED
  20187. if (scheme != "ws" && scheme != "wss") {
  20188. #else
  20189. if (scheme != "ws") {
  20190. #endif
  20191. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  20192. std::string msg = "'" + scheme + "' scheme is not supported.";
  20193. throw std::invalid_argument(msg);
  20194. #endif
  20195. return;
  20196. }
  20197. auto is_ssl = scheme == "wss";
  20198. host_ = std::move(uc.host);
  20199. port_ = is_ssl ? 443 : 80;
  20200. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  20201. path_ = std::move(uc.path);
  20202. if (!uc.query.empty()) { path_ += uc.query; }
  20203. #ifdef CPPHTTPLIB_SSL_ENABLED
  20204. is_ssl_ = is_ssl;
  20205. if (is_ssl_) {
  20206. // The context lives as long as the client so that CA configuration
  20207. // survives reconnects; sessions are created per connection.
  20208. tls_ctx_ = tls::create_client_context();
  20209. if (!tls_ctx_) { return; }
  20210. }
  20211. #else
  20212. if (is_ssl) { return; }
  20213. #endif
  20214. is_valid_ = true;
  20215. }
  20216. }
  20217. #ifdef CPPHTTPLIB_SSL_ENABLED
  20218. inline WebSocketClient::WebSocketClient(
  20219. const std::string &scheme_host_port_path, const PemMemory &pem,
  20220. const Headers &headers)
  20221. : WebSocketClient(scheme_host_port_path, headers) {
  20222. // For ws:// URLs the client certificate is silently ignored, consistent
  20223. // with the TLS-only setters such as set_ca_cert_path().
  20224. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  20225. std::string cert_buf, key_buf;
  20226. if (!tls::set_client_cert_pem(
  20227. tls_ctx_,
  20228. detail::pem_c_str(pem.cert_pem, pem.cert_pem_len, cert_buf),
  20229. detail::pem_c_str(pem.key_pem, pem.key_pem_len, key_buf),
  20230. pem.private_key_password)) {
  20231. tls::free_context(tls_ctx_);
  20232. tls_ctx_ = nullptr;
  20233. is_valid_ = false;
  20234. }
  20235. }
  20236. }
  20237. #endif
  20238. inline WebSocketClient::~WebSocketClient() {
  20239. shutdown_and_close();
  20240. #ifdef CPPHTTPLIB_SSL_ENABLED
  20241. if (tls_ctx_) {
  20242. tls::free_context(tls_ctx_);
  20243. tls_ctx_ = nullptr;
  20244. }
  20245. #endif
  20246. }
  20247. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  20248. inline void WebSocketClient::shutdown_and_close() {
  20249. // Send the close frame while the TLS session is still alive: ws_ holds an
  20250. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  20251. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  20252. if (ws_ && ws_->is_open()) { ws_->close(); }
  20253. ws_.reset();
  20254. #ifdef CPPHTTPLIB_SSL_ENABLED
  20255. if (is_ssl_) {
  20256. if (tls_session_) {
  20257. tls::shutdown(tls_session_, true);
  20258. tls::free_session(tls_session_);
  20259. tls_session_ = nullptr;
  20260. }
  20261. }
  20262. #endif
  20263. if (sock_ != INVALID_SOCKET) {
  20264. detail::shutdown_socket(sock_);
  20265. detail::close_socket(sock_);
  20266. sock_ = INVALID_SOCKET;
  20267. }
  20268. }
  20269. // The handshakes belong to establishing the connection, so an unset read
  20270. // timeout leaves them bounded by the connection timeout instead of forever.
  20271. inline std::pair<time_t, time_t> WebSocketClient::handshake_timeout() const {
  20272. if (read_timeout_sec_ == 0 && read_timeout_usec_ == 0) {
  20273. return {connection_timeout_sec_, connection_timeout_usec_};
  20274. }
  20275. return {read_timeout_sec_, read_timeout_usec_};
  20276. }
  20277. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  20278. Error &error, int &ssl_error,
  20279. uint64_t &ssl_backend_error) {
  20280. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  20281. // The streams wait with poll(), where 0 instead means "return immediately",
  20282. // so they are given the negative poll uses for an unbounded wait.
  20283. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  20284. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  20285. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  20286. #ifdef CPPHTTPLIB_SSL_ENABLED
  20287. if (is_ssl_) {
  20288. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  20289. // is not safe to call concurrently on one client to begin with, since
  20290. // nothing else here is guarded either.
  20291. if (server_certificate_verification_ && !certs_loaded_) {
  20292. uint64_t backend_error = 0;
  20293. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  20294. ca_cert_dir_path_, custom_ca_loaded_,
  20295. system_ca_mode_, backend_error);
  20296. certs_loaded_ = true;
  20297. }
  20298. detail::ClientTlsSessionOptions options;
  20299. options.server_hostname_verification = server_hostname_verification_;
  20300. options.session_verifier = session_verifier_;
  20301. auto timeout = handshake_timeout();
  20302. detail::ClientTlsSessionError tls_error;
  20303. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  20304. server_certificate_verification_,
  20305. timeout.first, timeout.second,
  20306. &tls_error, options)) {
  20307. error = tls_error.error;
  20308. ssl_error = tls_error.ssl_error;
  20309. ssl_backend_error = tls_error.backend_error;
  20310. return false;
  20311. }
  20312. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  20313. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  20314. write_timeout_usec_));
  20315. return true;
  20316. }
  20317. #else
  20318. (void)error;
  20319. (void)ssl_error;
  20320. (void)ssl_backend_error;
  20321. #endif
  20322. strm = std::unique_ptr<Stream>(
  20323. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20324. write_timeout_sec_, write_timeout_usec_));
  20325. return true;
  20326. }
  20327. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20328. #ifdef CPPHTTPLIB_SSL_ENABLED
  20329. auto is_ssl = is_ssl_;
  20330. #else
  20331. auto is_ssl = false;
  20332. #endif
  20333. if (!req.has_header("Host")) {
  20334. req.headers.emplace("Host", detail::make_default_host_header_value(
  20335. host_, port_, is_ssl, address_family_));
  20336. }
  20337. detail::add_default_user_agent_header(req);
  20338. }
  20339. inline Result WebSocketClient::connect() {
  20340. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20341. shutdown_and_close();
  20342. auto error = Error::Success;
  20343. if (!create_and_connect_socket(error)) {
  20344. return Result{error, -1, Headers{}};
  20345. }
  20346. if (is_proxy_enabled()) {
  20347. Response proxy_res;
  20348. if (!connect_with_proxy(proxy_res, error)) {
  20349. shutdown_and_close();
  20350. return Result{error, proxy_res.status, std::move(proxy_res.headers)};
  20351. }
  20352. }
  20353. std::unique_ptr<Stream> strm;
  20354. auto stream_error = Error::SSLConnection;
  20355. int ssl_error = 0;
  20356. uint64_t ssl_backend_error = 0;
  20357. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20358. shutdown_and_close();
  20359. #ifdef CPPHTTPLIB_SSL_ENABLED
  20360. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20361. #else
  20362. return Result{stream_error, -1, Headers{}};
  20363. #endif
  20364. }
  20365. Request req;
  20366. req.method = "GET";
  20367. req.path = path_;
  20368. req.headers = headers_;
  20369. prepare_default_headers(req);
  20370. detail::WebSocketUpgradeResponse upgrade;
  20371. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20372. shutdown_and_close();
  20373. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20374. }
  20375. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20376. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20377. websocket_ping_interval_sec_,
  20378. websocket_max_missed_pongs_));
  20379. // The stream was created with the timeout already; tell the WebSocket
  20380. // whether it came from the caller, so read() knows to report it as Timeout.
  20381. ws_->read_timeout_set_ = read_timeout_set_;
  20382. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20383. }
  20384. inline ReadResult WebSocketClient::read(std::string &msg) {
  20385. if (!ws_) { return Fail; }
  20386. return ws_->read(msg);
  20387. }
  20388. inline bool WebSocketClient::send(const std::string &data) {
  20389. if (!ws_) { return false; }
  20390. return ws_->send(data);
  20391. }
  20392. inline bool WebSocketClient::send(const char *data, size_t len) {
  20393. if (!ws_) { return false; }
  20394. return ws_->send(data, len);
  20395. }
  20396. inline void WebSocketClient::close(CloseStatus status,
  20397. const std::string &reason) {
  20398. if (ws_) { ws_->close(status, reason); }
  20399. }
  20400. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20401. inline const std::string &WebSocketClient::subprotocol() const {
  20402. return subprotocol_;
  20403. }
  20404. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20405. read_timeout_sec_ = sec;
  20406. read_timeout_usec_ = usec;
  20407. read_timeout_set_ = true;
  20408. // The members above only seed the next connect(); read() consults the
  20409. // stream, so an already-open connection has to be told directly.
  20410. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20411. }
  20412. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20413. write_timeout_sec_ = sec;
  20414. write_timeout_usec_ = usec;
  20415. }
  20416. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20417. websocket_ping_interval_sec_ = sec;
  20418. }
  20419. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20420. websocket_max_missed_pongs_ = count;
  20421. }
  20422. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20423. inline void WebSocketClient::set_address_family(int family) {
  20424. address_family_ = family;
  20425. }
  20426. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20427. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20428. socket_options_ = std::move(socket_options);
  20429. }
  20430. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20431. connection_timeout_sec_ = sec;
  20432. connection_timeout_usec_ = usec;
  20433. }
  20434. inline void WebSocketClient::set_interface(const std::string &intf) {
  20435. interface_ = intf;
  20436. }
  20437. inline void WebSocketClient::set_hostname_addr_map(
  20438. std::map<std::string, std::string> addr_map) {
  20439. addr_map_ = std::move(addr_map);
  20440. }
  20441. inline bool WebSocketClient::is_proxy_enabled() const {
  20442. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  20443. if (no_proxy_entries_.empty()) { return true; }
  20444. return !detail::host_matches_no_proxy(detail::normalize_target(host_),
  20445. no_proxy_entries_);
  20446. }
  20447. inline bool WebSocketClient::create_and_connect_socket(Error &error) {
  20448. std::string connect_host;
  20449. std::string ip;
  20450. auto port = port_;
  20451. if (is_proxy_enabled()) {
  20452. connect_host = proxy_host_;
  20453. port = proxy_port_;
  20454. } else {
  20455. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20456. }
  20457. sock_ = detail::create_client_socket(
  20458. connect_host, ip, port, address_family_, tcp_nodelay_, ipv6_v6only_,
  20459. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20460. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20461. write_timeout_usec_, interface_, error);
  20462. if (sock_ != INVALID_SOCKET) { return true; }
  20463. if (error == Error::Success) { error = Error::Connection; }
  20464. return false;
  20465. }
  20466. inline bool WebSocketClient::send_proxy_connect(Request &req,
  20467. Response &proxy_res,
  20468. Error &error) {
  20469. auto timeout = handshake_timeout();
  20470. detail::SocketStream strm(sock_, timeout.first, timeout.second,
  20471. write_timeout_sec_, write_timeout_usec_);
  20472. if (!detail::write_request_head(strm, req, error)) { return false; }
  20473. if (!detail::read_response_head(strm, proxy_res.status, proxy_res.headers)) {
  20474. error = Error::Read;
  20475. return false;
  20476. }
  20477. return true;
  20478. }
  20479. // RFC 6455 4.1: ws:// is tunnelled with CONNECT as well, since a proxy need not
  20480. // forward an Upgrade request.
  20481. inline bool WebSocketClient::connect_with_proxy(Response &proxy_res,
  20482. Error &error) {
  20483. Request req;
  20484. req.method = "CONNECT";
  20485. req.path = detail::make_host_and_port_string_always_port(host_, port_);
  20486. req.headers.emplace("Host", req.path);
  20487. detail::add_default_user_agent_header(req);
  20488. detail::add_authorization_header(req, proxy_basic_auth_username_,
  20489. proxy_basic_auth_password_,
  20490. proxy_bearer_token_auth_token_, true);
  20491. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20492. #ifdef CPPHTTPLIB_SSL_ENABLED
  20493. // A Digest challenge gets one retry on a fresh connection, like SSLClient.
  20494. std::map<std::string, std::string> auth;
  20495. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407 &&
  20496. !proxy_digest_auth_username_.empty() &&
  20497. !proxy_digest_auth_password_.empty() &&
  20498. detail::parse_www_authenticate(proxy_res, auth, true)) {
  20499. proxy_res = Response();
  20500. shutdown_and_close();
  20501. if (!create_and_connect_socket(error)) { return false; }
  20502. req.headers.erase("Proxy-Authorization");
  20503. req.headers.insert(detail::make_digest_authentication_header(
  20504. req, req.path, auth, 1, detail::random_string(10),
  20505. proxy_digest_auth_username_, proxy_digest_auth_password_, true));
  20506. if (!send_proxy_connect(req, proxy_res, error)) { return false; }
  20507. }
  20508. #endif
  20509. if (proxy_res.status != StatusCode::OK_200) {
  20510. error = Error::ProxyConnection;
  20511. return false;
  20512. }
  20513. return true;
  20514. }
  20515. inline void WebSocketClient::set_proxy(const std::string &host, int port) {
  20516. proxy_host_ = host;
  20517. proxy_port_ = port;
  20518. }
  20519. inline void WebSocketClient::set_proxy_basic_auth(const std::string &username,
  20520. const std::string &password) {
  20521. proxy_basic_auth_username_ = username;
  20522. proxy_basic_auth_password_ = password;
  20523. }
  20524. inline void
  20525. WebSocketClient::set_proxy_bearer_token_auth(const std::string &token) {
  20526. proxy_bearer_token_auth_token_ = token;
  20527. }
  20528. inline void
  20529. WebSocketClient::set_no_proxy(const std::vector<std::string> &patterns) {
  20530. no_proxy_entries_ = detail::parse_no_proxy_entries(patterns);
  20531. }
  20532. #ifdef CPPHTTPLIB_SSL_ENABLED
  20533. inline void
  20534. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20535. const std::string &ca_cert_dir_path) {
  20536. ca_cert_file_path_ = ca_cert_file_path;
  20537. ca_cert_dir_path_ = ca_cert_dir_path;
  20538. }
  20539. inline void
  20540. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20541. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20542. }
  20543. inline void WebSocketClient::set_session_verifier(
  20544. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20545. session_verifier_ = std::move(verifier);
  20546. }
  20547. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20548. if (store && tls_ctx_) {
  20549. // set_ca_store takes ownership of store
  20550. tls::set_ca_store(tls_ctx_, store);
  20551. } else if (store) {
  20552. tls::free_ca_store(store);
  20553. }
  20554. custom_ca_loaded_ = true;
  20555. }
  20556. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20557. std::size_t size) {
  20558. if (tls_ctx_ && ca_cert && size > 0) {
  20559. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20560. }
  20561. custom_ca_loaded_ = true;
  20562. }
  20563. inline void
  20564. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20565. server_certificate_verification_ = enabled;
  20566. }
  20567. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20568. server_hostname_verification_ = enabled;
  20569. }
  20570. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20571. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20572. }
  20573. inline void
  20574. WebSocketClient::set_proxy_digest_auth(const std::string &username,
  20575. const std::string &password) {
  20576. proxy_digest_auth_username_ = username;
  20577. proxy_digest_auth_password_ = password;
  20578. }
  20579. #endif // CPPHTTPLIB_SSL_ENABLED
  20580. } // namespace ws
  20581. // ----------------------------------------------------------------------------
  20582. } // namespace httplib
  20583. #endif // CPPHTTPLIB_HTTPLIB_H